Skip to content

Commit caf5681

Browse files
matteoservaggerganovochafik
authored
server : support jinja extra template kwargs (Qwen3 enable_thinking feature), from command line and from client (#13196)
* initial commit for handling extra template kwargs * enable_thinking and assistant prefill cannot be enabled at the same time * can set chat_template_kwargs in command line * added doc * fixed formatting * add support for extra context in generic template init * coding standard: common/chat.cpp Co-authored-by: Georgi Gerganov <[email protected]> * coding standard: common/chat.cpp Co-authored-by: Georgi Gerganov <[email protected]> * Apply suggestions from code review coding standard: cosmetic changes Co-authored-by: Georgi Gerganov <[email protected]> * fix merge conflict * chat.cpp: simplify calls to apply to ensure systematic propagation of extra_context (+ the odd existing additional_context) * normalize environment variable name * simplify code * prefill cannot be used with thinking models * compatibility with the new reasoning-budget parameter * fix prefill for non thinking models --------- Co-authored-by: Georgi Gerganov <[email protected]> Co-authored-by: Olivier Chafik <[email protected]>
1 parent 83790b0 commit caf5681

File tree

7 files changed

+69
-20
lines changed

7 files changed

+69
-20
lines changed

common/arg.cpp

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2794,6 +2794,16 @@ common_params_context common_params_parser_init(common_params & params, llama_ex
27942794
params.ssl_file_cert = value;
27952795
}
27962796
).set_examples({LLAMA_EXAMPLE_SERVER}).set_env("LLAMA_ARG_SSL_CERT_FILE"));
2797+
add_opt(common_arg(
2798+
{"--chat-template-kwargs"}, "STRING",
2799+
string_format("sets additional params for the json template parser"),
2800+
[](common_params & params, const std::string & value) {
2801+
auto parsed = json::parse(value);
2802+
for (const auto & item : parsed.items()) {
2803+
params.default_template_kwargs[item.key()] = item.value().dump();
2804+
}
2805+
}
2806+
).set_examples({LLAMA_EXAMPLE_SERVER}).set_env("LLAMA_CHAT_TEMPLATE_KWARGS"));
27972807
add_opt(common_arg(
27982808
{"-to", "--timeout"}, "N",
27992809
string_format("server read/write timeout in seconds (default: %d)", params.timeout_read),

common/chat.cpp

Lines changed: 37 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
#include <string>
1818
#include <vector>
1919

20+
using json = nlohmann::ordered_json;
21+
2022
static std::string format_time(const std::chrono::system_clock::time_point & now, const std::string & format) {
2123
auto time = std::chrono::system_clock::to_time_t(now);
2224
auto local_time = *std::localtime(&time);
@@ -140,6 +142,7 @@ struct templates_params {
140142
bool add_generation_prompt = true;
141143
bool enable_thinking = true;
142144
std::chrono::system_clock::time_point now = std::chrono::system_clock::now();
145+
json extra_context;
143146
};
144147

145148
common_chat_tool_choice common_chat_tool_choice_parse_oaicompat(const std::string & tool_choice) {
@@ -720,16 +723,23 @@ static void foreach_function(const json & tools, const std::function<void(const
720723

721724
static std::string apply(
722725
const common_chat_template & tmpl,
723-
const nlohmann::ordered_json & messages,
724-
const nlohmann::ordered_json & tools,
725-
bool add_generation_prompt,
726-
const nlohmann::ordered_json & extra_context = nlohmann::ordered_json())
726+
const struct templates_params & inputs,
727+
const std::optional<json> & messages_override = std::nullopt,
728+
const std::optional<json> & tools_override = std::nullopt,
729+
const std::optional<json> & additional_context = std::nullopt)
727730
{
728731
minja::chat_template_inputs tmpl_inputs;
729-
tmpl_inputs.messages = messages;
730-
tmpl_inputs.tools = tools;
731-
tmpl_inputs.add_generation_prompt = add_generation_prompt;
732-
tmpl_inputs.extra_context = extra_context;
732+
tmpl_inputs.messages = messages_override ? *messages_override : inputs.messages;
733+
if (tools_override) {
734+
tmpl_inputs.tools = *tools_override;
735+
} else {
736+
tmpl_inputs.tools = inputs.tools.empty() ? json() : inputs.tools;
737+
}
738+
tmpl_inputs.add_generation_prompt = inputs.add_generation_prompt;
739+
tmpl_inputs.extra_context = inputs.extra_context;
740+
if (additional_context) {
741+
tmpl_inputs.extra_context.merge_patch(*additional_context);
742+
}
733743
// TODO: add flag to control date/time, if only for testing purposes.
734744
// tmpl_inputs.now = std::chrono::system_clock::now();
735745

@@ -828,7 +838,7 @@ static common_chat_params common_chat_params_init_generic(const common_chat_temp
828838
inputs.messages,
829839
"Respond in JSON format, either with `tool_call` (a request to call tools) or with `response` reply to the user's request");
830840

831-
data.prompt = apply(tmpl, tweaked_messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
841+
data.prompt = apply(tmpl, inputs, /* messages_override= */ tweaked_messages);
832842
data.format = COMMON_CHAT_FORMAT_GENERIC;
833843
return data;
834844
}
@@ -904,7 +914,7 @@ static common_chat_params common_chat_params_init_mistral_nemo(const common_chat
904914
data.preserved_tokens = {
905915
"[TOOL_CALLS]",
906916
};
907-
data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
917+
data.prompt = apply(tmpl, inputs);
908918
data.format = COMMON_CHAT_FORMAT_MISTRAL_NEMO;
909919
return data;
910920
}
@@ -934,7 +944,7 @@ static common_chat_params common_chat_params_init_command_r7b(const common_chat_
934944
adjusted_messages.push_back(msg);
935945
}
936946
}
937-
data.prompt = apply(tmpl, adjusted_messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt, {});
947+
data.prompt = apply(tmpl, inputs, /* messages_override= */ adjusted_messages);
938948
data.format = COMMON_CHAT_FORMAT_COMMAND_R7B;
939949
if (string_ends_with(data.prompt, "<|START_THINKING|>")) {
940950
if (!inputs.enable_thinking) {
@@ -1122,7 +1132,7 @@ static common_chat_params common_chat_params_init_llama_3_x(const common_chat_te
11221132
} else {
11231133
data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
11241134
}
1125-
data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt, {
1135+
data.prompt = apply(tmpl, inputs, /* messages_override =*/ std::nullopt, /* tools_override= */ std::nullopt, json {
11261136
{"date_string", format_time(inputs.now, "%d %b %Y")},
11271137
{"tools_in_user_message", false},
11281138
{"builtin_tools", builtin_tools.empty() ? json() : builtin_tools},
@@ -1187,7 +1197,7 @@ static void common_chat_parse_llama_3_1(common_chat_msg_parser & builder, bool w
11871197

11881198
static common_chat_params common_chat_params_init_deepseek_r1(const common_chat_template & tmpl, const struct templates_params & inputs) {
11891199
common_chat_params data;
1190-
auto prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
1200+
auto prompt = apply(tmpl, inputs);
11911201

11921202
// Hacks to fix the official (broken) prompt.
11931203
// It is advisable to use --chat-template-file models/templates/llama-cpp-deepseek-r1.jinja instead,
@@ -1282,7 +1292,7 @@ static void common_chat_parse_deepseek_r1(common_chat_msg_parser & builder) {
12821292
static common_chat_params common_chat_params_init_firefunction_v2(const common_chat_template & tmpl, const struct templates_params & inputs) {
12831293
LOG_DBG("%s\n", __func__);
12841294
common_chat_params data;
1285-
data.prompt = apply(tmpl, inputs.messages, /* tools= */ nullptr, inputs.add_generation_prompt, {
1295+
data.prompt = apply(tmpl, inputs, /* messages_override =*/ std::nullopt, /* tools_override= */ json(), json {
12861296
{"datetime", format_time(inputs.now, "%b %d %Y %H:%M:%S GMT")},
12871297
{"functions", json(inputs.tools.empty() ? "" : inputs.tools.dump(2))},
12881298
});
@@ -1338,7 +1348,7 @@ static common_chat_params common_chat_params_init_functionary_v3_2(const common_
13381348
// Using ">>>f1\n", ">>>f2\n"... as trigger words for the grammar
13391349
// If the function is python, we also allow raw python code (if the line after `python\n` doesn't start w/ opening `{`), which the model seems to prefer for multiline code.
13401350
common_chat_params data;
1341-
data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
1351+
data.prompt = apply(tmpl, inputs);
13421352
data.format = COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2;
13431353
if (inputs.tools.is_array() && !inputs.tools.empty()) {
13441354
data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
@@ -1465,7 +1475,7 @@ static common_chat_params common_chat_params_init_functionary_v3_1_llama_3_1(con
14651475
data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
14661476
}
14671477

1468-
data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
1478+
data.prompt = apply(tmpl, inputs);
14691479
// TODO: if (has_raw_python)
14701480
return data;
14711481
}
@@ -1498,14 +1508,15 @@ static void common_chat_parse_functionary_v3_1_llama_3_1(common_chat_msg_parser
14981508
static common_chat_params common_chat_params_init_hermes_2_pro(const common_chat_template & tmpl, const struct templates_params & inputs) {
14991509
common_chat_params data;
15001510

1501-
json additional_context = {
1511+
json extra_context = json {
15021512
{"enable_thinking", inputs.enable_thinking},
15031513
};
1514+
extra_context.update(inputs.extra_context);
15041515

1505-
data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt, additional_context);
1516+
data.prompt = apply(tmpl, inputs, /* messages_override =*/ std::nullopt, /* tools_override= */ std::nullopt, extra_context);
15061517
data.format = COMMON_CHAT_FORMAT_HERMES_2_PRO;
15071518
if (string_ends_with(data.prompt, "<think>\n")) {
1508-
if (!inputs.enable_thinking) {
1519+
if (!extra_context["enable_thinking"]) {
15091520
data.prompt += "</think>";
15101521
} else {
15111522
data.thinking_forced_open = true;
@@ -1691,7 +1702,7 @@ static void common_chat_parse_hermes_2_pro(common_chat_msg_parser & builder) {
16911702

16921703
static common_chat_params common_chat_params_init_without_tools(const common_chat_template & tmpl, const struct templates_params & inputs) {
16931704
common_chat_params data;
1694-
data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
1705+
data.prompt = apply(tmpl, inputs);
16951706
data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
16961707
data.grammar_lazy = false;
16971708
if (!inputs.json_schema.is_null()) {
@@ -1722,6 +1733,12 @@ static common_chat_params common_chat_templates_apply_jinja(
17221733
params.enable_thinking = inputs.enable_thinking;
17231734
params.grammar = inputs.grammar;
17241735
params.now = inputs.now;
1736+
1737+
params.extra_context = json::object();
1738+
for (auto el : inputs.chat_template_kwargs) {
1739+
params.extra_context[el.first] = json::parse(el.second);
1740+
}
1741+
17251742
if (!inputs.json_schema.empty()) {
17261743
params.json_schema = json::parse(inputs.json_schema);
17271744
}

common/chat.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
#include <chrono>
88
#include <string>
99
#include <vector>
10+
#include <map>
1011

1112
struct common_chat_templates;
1213

@@ -125,6 +126,7 @@ struct common_chat_templates_inputs {
125126
common_reasoning_format reasoning_format = COMMON_REASONING_FORMAT_NONE;
126127
bool enable_thinking = true;
127128
std::chrono::system_clock::time_point now = std::chrono::system_clock::now();
129+
std::map<std::string, std::string> chat_template_kwargs;
128130
};
129131

130132
struct common_chat_params {

common/common.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
#include <string>
99
#include <string_view>
1010
#include <vector>
11+
#include <map>
1112
#include <sstream>
1213

1314
#ifdef _WIN32
@@ -381,6 +382,8 @@ struct common_params {
381382
std::string ssl_file_key = ""; // NOLINT
382383
std::string ssl_file_cert = ""; // NOLINT
383384

385+
std::map<std::string, std::string> default_template_kwargs;
386+
384387
// "advanced" endpoints are disabled by default for better security
385388
bool webui = true;
386389
bool endpoint_slots = false;

tools/server/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ The project is under active development, and we are [looking for feedback and co
164164
| `--api-key-file FNAME` | path to file containing API keys (default: none) |
165165
| `--ssl-key-file FNAME` | path to file a PEM-encoded SSL private key<br/>(env: LLAMA_ARG_SSL_KEY_FILE) |
166166
| `--ssl-cert-file FNAME` | path to file a PEM-encoded SSL certificate<br/>(env: LLAMA_ARG_SSL_CERT_FILE) |
167+
| `--chat-template-kwargs STRING` | JSON object containing additional params for the json template parser. Example: `--chat_template_kwargs "{\"enable_thinking\":false}`"<br/>(env: LLAMA_CHAT_TEMPLATE_KWARGS) |
167168
| `-to, --timeout N` | server read/write timeout in seconds (default: 600)<br/>(env: LLAMA_ARG_TIMEOUT) |
168169
| `--threads-http N` | number of threads used to process HTTP requests (default: -1)<br/>(env: LLAMA_ARG_THREADS_HTTP) |
169170
| `--cache-reuse N` | min chunk size to attempt reusing from the cache via KV shifting (default: 0)<br/>[(card)](https://ggml.ai/f0.png)<br/>(env: LLAMA_ARG_CACHE_REUSE) |
@@ -1118,6 +1119,8 @@ See [OpenAI Chat Completions API documentation](https://platform.openai.com/docs
11181119

11191120
The `response_format` parameter supports both plain JSON output (e.g. `{"type": "json_object"}`) and schema-constrained JSON (e.g. `{"type": "json_object", "schema": {"type": "string", "minLength": 10, "maxLength": 100}}` or `{"type": "json_schema", "schema": {"properties": { "name": { "title": "Name", "type": "string" }, "date": { "title": "Date", "type": "string" }, "participants": { "items": {"type: "string" }, "title": "Participants", "type": "string" } } } }`), similar to other OpenAI-inspired API providers.
11201121

1122+
`chat_template_kwargs`: Allows sending additional parameters to the json templating system. For example: `{"enable_thinking": false}`
1123+
11211124
*Examples:*
11221125

11231126
You can use either Python `openai` library with appropriate checkpoints:

tools/server/server.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2110,6 +2110,7 @@ struct server_context {
21102110
/* use_jinja */ params_base.use_jinja,
21112111
/* prefill_assistant */ params_base.prefill_assistant,
21122112
/* reasoning_format */ params_base.reasoning_format,
2113+
/* chat_template_kwargs */ params_base.default_template_kwargs,
21132114
/* common_chat_templates */ chat_templates.get(),
21142115
/* allow_image */ mctx ? mtmd_support_vision(mctx) : false,
21152116
/* allow_audio */ mctx ? mtmd_support_audio (mctx) : false,

tools/server/utils.hpp

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -579,6 +579,7 @@ struct oaicompat_parser_options {
579579
bool use_jinja;
580580
bool prefill_assistant;
581581
common_reasoning_format reasoning_format;
582+
std::map<std::string,std::string> chat_template_kwargs;
582583
common_chat_templates * tmpls;
583584
bool allow_image;
584585
bool allow_audio;
@@ -756,6 +757,13 @@ static json oaicompat_chat_params_parse(
756757
llama_params["parse_tool_calls"] = true;
757758
}
758759

760+
// merge the template args provided from command line with the args provided in the user request
761+
auto chat_template_kwargs_object = json_value(body, "chat_template_kwargs", json::object());
762+
inputs.chat_template_kwargs = opt.chat_template_kwargs;
763+
for (const auto & item : chat_template_kwargs_object.items()) {
764+
inputs.chat_template_kwargs[item.key()] = item.value().dump();
765+
}
766+
759767
// if the assistant message appears at the end of list, we do not add end-of-turn token
760768
// for ex. this can be useful to modify the reasoning process in reasoning models
761769
bool prefill_assistant_message = !inputs.messages.empty() && inputs.messages.back().role == "assistant" && opt.prefill_assistant;
@@ -771,6 +779,11 @@ static json oaicompat_chat_params_parse(
771779

772780
/* TODO: test this properly */
773781
inputs.reasoning_format = COMMON_REASONING_FORMAT_NONE;
782+
783+
if ( (!inputs.enable_thinking) || inputs.chat_template_kwargs.find("enable_thinking") != inputs.chat_template_kwargs.end()) {
784+
throw std::runtime_error("Assistant response prefill is incompatible with enable_thinking.");
785+
}
786+
774787
inputs.add_generation_prompt = true;
775788
}
776789

0 commit comments

Comments
 (0)