| #include "chat.h" |
| #include "chat-parser.h" |
| #include "chat-peg-parser.h" |
| #include "common.h" |
| #include "json-partial.h" |
| #include "json-schema-to-grammar.h" |
| #include "log.h" |
| #include "regex-partial.h" |
|
|
| #include "jinja/parser.h" |
| #include "jinja/value.h" |
| #include "jinja/runtime.h" |
| #include "jinja/caps.h" |
|
|
| #include <algorithm> |
| #include <cstdio> |
| #include <cctype> |
| #include <exception> |
| #include <functional> |
| #include <iostream> |
| #include <optional> |
| #include <stdexcept> |
| #include <string> |
| #include <vector> |
|
|
| using json = nlohmann::ordered_json; |
|
|
| static std::string format_time(const std::chrono::system_clock::time_point & now, const std::string & format) { |
| auto time = std::chrono::system_clock::to_time_t(now); |
| auto local_time = *std::localtime(&time); |
| std::ostringstream ss; |
| ss << std::put_time(&local_time, format.c_str()); |
| auto res = ss.str(); |
| return res; |
| } |
|
|
| static std::string string_diff(const std::string & last, const std::string & current) { |
| if (last.empty()) { |
| return current; |
| } |
| if (!string_starts_with(current, last)) { |
| if (string_starts_with(last, current)) { |
| |
| |
| return ""; |
| } |
| throw std::runtime_error("Invalid diff: '" + last + "' not found at start of '" + current + "'"); |
| } |
| return current.substr(last.size()); |
| } |
|
|
| static bool has_content_or_tool_calls(const common_chat_msg & msg) { |
| return !msg.content.empty() || !msg.tool_calls.empty(); |
| } |
|
|
| json common_chat_msg::to_json_oaicompat(bool concat_typed_text) const { |
| if (!content.empty() && !content_parts.empty()) { |
| throw std::runtime_error("Cannot specify both content and content_parts"); |
| } |
| json jmsg { |
| {"role", role}, |
| }; |
| if (!content.empty()) { |
| jmsg["content"] = content; |
| } else if (!content_parts.empty()) { |
| if (concat_typed_text) { |
| std::string text; |
| bool last_was_media_marker = false; |
| |
| for (const auto & part : content_parts) { |
| bool add_new_line = true; |
| if (part.type == "text") { |
| add_new_line = !last_was_media_marker && !text.empty(); |
| last_was_media_marker = false; |
| } else if (part.type == "media_marker") { |
| add_new_line = false; |
| last_was_media_marker = true; |
| } else { |
| LOG_WRN("Ignoring content part type: %s\n", part.type.c_str()); |
| continue; |
| } |
|
|
| if (add_new_line) { |
| text += '\n'; |
| } |
|
|
| text += part.text; |
| } |
| jmsg["content"] = text; |
| } else { |
| auto & parts = jmsg["content"] = json::array(); |
| for (const auto & part : content_parts) { |
| parts.push_back({ |
| {"type", part.type}, |
| {"text", part.text}, |
| }); |
| } |
| } |
| } else { |
| jmsg["content"] = ""; |
| } |
| if (!reasoning_content.empty()) { |
| jmsg["reasoning_content"] = reasoning_content; |
| } |
| if (!tool_name.empty()) { |
| jmsg["name"] = tool_name; |
| } |
| if (!tool_call_id.empty()) { |
| jmsg["tool_call_id"] = tool_call_id; |
| } |
| if (!tool_calls.empty()) { |
| jmsg["tool_calls"] = json::array(); |
| auto & jtool_calls = jmsg["tool_calls"]; |
| for (const auto & tool_call : tool_calls) { |
| json tc { |
| {"type", "function"}, |
| {"function", { |
| {"name", tool_call.name}, |
| {"arguments", tool_call.arguments}, |
| }}, |
| }; |
| if (!tool_call.id.empty()) { |
| tc["id"] = tool_call.id; |
| } |
| |
| |
| |
| |
| jtool_calls.push_back(tc); |
| } |
| } |
|
|
| return jmsg; |
| } |
|
|
| std::vector<common_chat_msg_diff> common_chat_msg_diff::compute_diffs(const common_chat_msg & msg_prv, const common_chat_msg & msg_new) { |
| std::vector<common_chat_msg_diff> diffs; |
| if (msg_new.tool_calls.size() > msg_prv.tool_calls.size()) { |
| diffs.reserve(msg_new.tool_calls.size() - msg_prv.tool_calls.size() + 3); |
| } else { |
| diffs.reserve(3); |
| } |
|
|
| |
| if (msg_prv.reasoning_content != msg_new.reasoning_content) { |
| auto & diff = diffs.emplace_back(); |
| diff.reasoning_content_delta = string_diff(msg_prv.reasoning_content, msg_new.reasoning_content); |
| } |
| if (msg_prv.content != msg_new.content) { |
| auto & diff = diffs.emplace_back(); |
| diff.content_delta = string_diff(msg_prv.content, msg_new.content); |
| } |
|
|
| if (msg_new.tool_calls.size() < msg_prv.tool_calls.size()) { |
| throw std::runtime_error("Invalid diff: now finding less tool calls!"); |
| } |
|
|
| if (!msg_prv.tool_calls.empty()) { |
| const auto idx = msg_prv.tool_calls.size() - 1; |
| const auto & pref = msg_prv.tool_calls[idx]; |
| const auto & newf = msg_new.tool_calls[idx]; |
| if (pref.name != newf.name) { |
| throw std::runtime_error("Invalid diff: tool call mismatch!"); |
| } |
| const auto args_diff = string_diff(pref.arguments, newf.arguments); |
| if (!args_diff.empty() || pref.id != newf.id) { |
| auto & diff = diffs.emplace_back(); |
| diff.tool_call_index = idx; |
| if (pref.id != newf.id) { |
| diff.tool_call_delta.id = newf.id; |
| diff.tool_call_delta.name = newf.name; |
| } |
| diff.tool_call_delta.arguments = args_diff; |
| } |
| } |
| for (size_t idx = msg_prv.tool_calls.size(); idx < msg_new.tool_calls.size(); ++idx) { |
| auto & diff = diffs.emplace_back(); |
| diff.tool_call_index = idx; |
| diff.tool_call_delta = msg_new.tool_calls[idx]; |
| } |
|
|
| return diffs; |
| } |
|
|
| using chat_template_caps = jinja::caps; |
|
|
| struct common_chat_template { |
| jinja::program prog; |
| std::string bos_tok; |
| std::string eos_tok; |
| std::string src; |
| chat_template_caps caps; |
|
|
| common_chat_template(const std::string & src, const std::string & bos_token, const std::string & eos_token) { |
| jinja::lexer lexer; |
| auto lexer_res = lexer.tokenize(src); |
| this->prog = jinja::parse_from_tokens(lexer_res); |
|
|
| this->src = lexer_res.source; |
| this->bos_tok = bos_token; |
| this->eos_tok = eos_token; |
|
|
| this->caps = jinja::caps_get(prog); |
| |
| } |
|
|
| const std::string & source() const { return src; } |
| const std::string & bos_token() const { return bos_tok; } |
| const std::string & eos_token() const { return eos_tok; } |
|
|
| |
| json add_system(const json & messages, const std::string & system_prompt) const { |
| GGML_ASSERT(messages.is_array()); |
| auto msgs_copy = messages; |
| if (!caps.supports_system_role) { |
| if (msgs_copy.empty()) { |
| msgs_copy.insert(msgs_copy.begin(), json{ |
| {"role", "user"}, |
| {"content", system_prompt} |
| }); |
| } else { |
| auto & first_msg = msgs_copy[0]; |
| if (!first_msg.contains("content")) { |
| first_msg["content"] = ""; |
| } |
| first_msg["content"] = system_prompt + "\n\n" |
| + first_msg["content"].get<std::string>(); |
| } |
| } else { |
| if (msgs_copy.empty() || msgs_copy[0].at("role") != "system") { |
| msgs_copy.insert(msgs_copy.begin(), json{ |
| {"role", "system"}, |
| {"content", system_prompt} |
| }); |
| } else if (msgs_copy[0].at("role") == "system") { |
| msgs_copy[0]["content"] = system_prompt; |
| } |
| } |
| return msgs_copy; |
| } |
|
|
| chat_template_caps original_caps() const { |
| return caps; |
| } |
|
|
| }; |
|
|
| struct common_chat_templates { |
| bool add_bos; |
| bool add_eos; |
| bool has_explicit_template; |
| std::unique_ptr<common_chat_template> template_default; |
| std::unique_ptr<common_chat_template> template_tool_use; |
| }; |
|
|
| struct templates_params { |
| json messages; |
| json tools; |
| common_chat_tool_choice tool_choice; |
| json json_schema; |
| bool parallel_tool_calls; |
| common_reasoning_format reasoning_format; |
| bool stream; |
| std::string grammar; |
| bool add_generation_prompt = true; |
| bool enable_thinking = true; |
| std::chrono::system_clock::time_point now = std::chrono::system_clock::now(); |
| json extra_context; |
| bool add_bos; |
| bool add_eos; |
| bool is_inference = true; |
| bool mark_input = true; |
| }; |
|
|
| common_chat_tool_choice common_chat_tool_choice_parse_oaicompat(const std::string & tool_choice) { |
| if (tool_choice == "auto") { |
| return COMMON_CHAT_TOOL_CHOICE_AUTO; |
| } |
| if (tool_choice == "none") { |
| return COMMON_CHAT_TOOL_CHOICE_NONE; |
| } |
| if (tool_choice == "required") { |
| return COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| } |
| throw std::invalid_argument("Invalid tool_choice: " + tool_choice); |
| } |
|
|
| bool common_chat_templates_support_enable_thinking(const common_chat_templates * chat_templates) { |
| common_chat_templates_inputs dummy_inputs; |
| common_chat_msg msg; |
| msg.role = "user"; |
| msg.content = "test"; |
| dummy_inputs.messages = {msg}; |
| dummy_inputs.enable_thinking = false; |
| const auto rendered_no_thinking = common_chat_templates_apply(chat_templates, dummy_inputs); |
| dummy_inputs.enable_thinking = true; |
| const auto rendered_with_thinking = common_chat_templates_apply(chat_templates, dummy_inputs); |
| return rendered_no_thinking.prompt != rendered_with_thinking.prompt; |
| } |
|
|
| std::vector<common_chat_msg> common_chat_msgs_parse_oaicompat(const json & messages) { |
| std::vector<common_chat_msg> msgs; |
|
|
| try { |
|
|
| if (!messages.is_array()) { |
| throw std::invalid_argument("Expected 'messages' to be an array, got " + messages.dump()); |
| } |
|
|
| for (const auto & message : messages) { |
| if (!message.is_object()) { |
| throw std::invalid_argument("Expected 'message' to be an object, got " + message.dump()); |
| } |
|
|
| common_chat_msg msg; |
| if (!message.contains("role")) { |
| throw std::invalid_argument("Missing 'role' in message: " + message.dump()); |
| } |
| msg.role = message.at("role"); |
|
|
| auto has_content = message.contains("content"); |
| auto has_tool_calls = message.contains("tool_calls"); |
| if (has_content) { |
| const auto & content = message.at("content"); |
| if (content.is_string()) { |
| msg.content = content; |
| } else if (content.is_array()) { |
| for (const auto & part : content) { |
| if (!part.contains("type")) { |
| throw std::invalid_argument("Missing content part type: " + part.dump()); |
| } |
| const auto & type = part.at("type"); |
| if (type != "text" && type != "media_marker") { |
| throw std::invalid_argument("Unsupported content part type: " + type.dump()); |
| } |
| common_chat_msg_content_part msg_part; |
| msg_part.type = type; |
| msg_part.text = part.at("text"); |
| msg.content_parts.push_back(msg_part); |
| } |
| } else if (!content.is_null()) { |
| throw std::invalid_argument("Invalid 'content' type: expected string or array, got " + content.dump() + " (ref: https://github.com/ggml-org/llama.cpp/issues/8367)"); |
| } |
| } |
| if (has_tool_calls) { |
| for (const auto & tool_call : message.at("tool_calls")) { |
| common_chat_tool_call tc; |
| if (!tool_call.contains("type")) { |
| throw std::invalid_argument("Missing tool call type: " + tool_call.dump()); |
| } |
| const auto & type = tool_call.at("type"); |
| if (type != "function") { |
| throw std::invalid_argument("Unsupported tool call type: " + tool_call.dump()); |
| } |
| if (!tool_call.contains("function")) { |
| throw std::invalid_argument("Missing tool call function: " + tool_call.dump()); |
| } |
| const auto & fc = tool_call.at("function"); |
| if (!fc.contains("name")) { |
| throw std::invalid_argument("Missing tool call name: " + tool_call.dump()); |
| } |
| tc.name = fc.at("name"); |
| tc.arguments = fc.at("arguments"); |
| if (tool_call.contains("id")) { |
| tc.id = tool_call.at("id"); |
| } |
| msg.tool_calls.push_back(tc); |
| } |
| } |
| if (!has_content && !has_tool_calls) { |
| throw std::invalid_argument("Expected 'content' or 'tool_calls' (ref: https://github.com/ggml-org/llama.cpp/issues/8367 & https://github.com/ggml-org/llama.cpp/issues/12279)"); |
| } |
| if (message.contains("reasoning_content")) { |
| msg.reasoning_content = message.at("reasoning_content"); |
| } |
| if (message.contains("name")) { |
| msg.tool_name = message.at("name"); |
| } |
| if (message.contains("tool_call_id")) { |
| msg.tool_call_id = message.at("tool_call_id"); |
| } |
|
|
| msgs.push_back(msg); |
| } |
| } catch (const std::exception & e) { |
| |
| |
| throw std::runtime_error("Failed to parse messages: " + std::string(e.what())); |
| } |
|
|
| return msgs; |
| } |
|
|
| static json render_message_to_json(const std::vector<common_chat_msg> & msgs, const jinja::caps & c) { |
| if (!c.supports_string_content && !c.supports_typed_content) { |
| LOG_WRN("%s: Neither string content nor typed content is supported by the template. This is unexpected and may lead to issues.\n", __func__); |
| } |
|
|
| bool only_string_accepted = c.supports_string_content && !c.supports_typed_content; |
| bool only_typed_accepted = !c.supports_string_content && c.supports_typed_content; |
|
|
| json messages = json::array(); |
| for (const auto & msg : msgs) { |
| if (only_string_accepted) { |
| json jmsg = msg.to_json_oaicompat( true); |
| messages.push_back(jmsg); |
| } else if (only_typed_accepted) { |
| json jmsg = msg.to_json_oaicompat( false); |
| if (jmsg.at("content").is_string()) { |
| jmsg["content"] = json::array({ |
| json{ |
| {"type", "text"}, |
| {"text", jmsg.at("content").get<std::string>()}, |
| } |
| }); |
| } |
| messages.push_back(jmsg); |
| } else { |
| json jmsg = msg.to_json_oaicompat( false); |
| messages.push_back(jmsg); |
| } |
| } |
| return messages; |
| } |
|
|
| |
| json common_chat_msgs_to_json_oaicompat(const std::vector<common_chat_msg> & msgs, bool concat_typed_text) { |
| jinja::caps c; |
| c.supports_string_content = true; |
| c.supports_typed_content = !concat_typed_text; |
| return render_message_to_json(msgs, c); |
| } |
|
|
| std::vector<common_chat_tool> common_chat_tools_parse_oaicompat(const json & tools) { |
| std::vector<common_chat_tool> result; |
|
|
| try { |
| if (!tools.is_null()) { |
| if (!tools.is_array()) { |
| throw std::invalid_argument("Expected 'tools' to be an array, got " + tools.dump()); |
| } |
| for (const auto & tool : tools) { |
| if (!tool.contains("type")) { |
| throw std::invalid_argument("Missing tool type: " + tool.dump()); |
| } |
| const auto & type = tool.at("type"); |
| if (!type.is_string() || type != "function") { |
| throw std::invalid_argument("Unsupported tool type: " + tool.dump()); |
| } |
| if (!tool.contains("function")) { |
| throw std::invalid_argument("Missing tool function: " + tool.dump()); |
| } |
|
|
| const auto & function = tool.at("function"); |
| result.push_back({ |
| function.at("name"), |
| function.value("description", ""), |
| function.value("parameters", json::object()).dump(), |
| }); |
| } |
| } |
| } catch (const std::exception & e) { |
| throw std::runtime_error("Failed to parse tools: " + std::string(e.what()) + "; tools = " + tools.dump(2)); |
| } |
|
|
| return result; |
| } |
|
|
| json common_chat_tools_to_json_oaicompat(const std::vector<common_chat_tool> & tools) { |
| if (tools.empty()) { |
| return json(); |
| } |
|
|
| auto result = json::array(); |
| for (const auto & tool : tools) { |
| result.push_back({ |
| {"type", "function"}, |
| {"function", { |
| {"name", tool.name}, |
| {"description", tool.description}, |
| {"parameters", json::parse(tool.parameters)}, |
| }}, |
| }); |
| } |
| return result; |
| } |
|
|
| json common_chat_msg_diff_to_json_oaicompat(const common_chat_msg_diff & diff) { |
| json delta = json::object(); |
| if (!diff.reasoning_content_delta.empty()) { |
| delta["reasoning_content"] = diff.reasoning_content_delta; |
| } |
| if (!diff.content_delta.empty()) { |
| delta["content"] = diff.content_delta; |
| } |
| if (diff.tool_call_index != std::string::npos) { |
| json tool_call; |
| tool_call["index"] = diff.tool_call_index; |
| if (!diff.tool_call_delta.id.empty()) { |
| tool_call["id"] = diff.tool_call_delta.id; |
| tool_call["type"] = "function"; |
| } |
| json function = json::object(); |
| if (!diff.tool_call_delta.name.empty()) { |
| function["name"] = diff.tool_call_delta.name; |
| } |
| function["arguments"] = diff.tool_call_delta.arguments; |
| tool_call["function"] = function; |
| delta["tool_calls"] = json::array({tool_call}); |
| } |
| return delta; |
| } |
|
|
| bool common_chat_verify_template(const std::string & tmpl, bool use_jinja) { |
| if (use_jinja) { |
| try { |
| common_chat_msg msg; |
| msg.role = "user"; |
| msg.content = "test"; |
|
|
| auto tmpls = common_chat_templates_init( nullptr, tmpl); |
|
|
| common_chat_templates_inputs inputs; |
| inputs.messages = {msg}; |
|
|
| common_chat_templates_apply(tmpls.get(), inputs); |
| return true; |
| } catch (const std::exception & e) { |
| LOG_ERR("%s: failed to apply template: %s\n", __func__, e.what()); |
| return false; |
| } |
| } |
| llama_chat_message chat[] = {{"user", "test"}}; |
| const int res = llama_chat_apply_template(tmpl.c_str(), chat, 1, true, nullptr, 0); |
| return res >= 0; |
| } |
|
|
| std::string common_chat_format_single( |
| const struct common_chat_templates * tmpls, |
| const std::vector<common_chat_msg> & past_msg, |
| const common_chat_msg & new_msg, |
| bool add_ass, |
| bool use_jinja) { |
|
|
| common_chat_templates_inputs inputs; |
| inputs.use_jinja = use_jinja; |
| inputs.add_bos = tmpls->add_bos; |
| inputs.add_eos = tmpls->add_eos; |
|
|
| std::string fmt_past_msg; |
| if (!past_msg.empty()) { |
| inputs.messages = past_msg; |
| inputs.add_generation_prompt = false; |
| fmt_past_msg = common_chat_templates_apply(tmpls, inputs).prompt; |
| } |
| std::ostringstream ss; |
| |
| if (add_ass && !fmt_past_msg.empty() && fmt_past_msg.back() == '\n') { |
| ss << "\n"; |
| }; |
| |
| inputs.messages.push_back(new_msg); |
| inputs.add_generation_prompt = add_ass; |
| auto fmt_new_msg = common_chat_templates_apply(tmpls, inputs).prompt; |
| |
| ss << fmt_new_msg.substr(fmt_past_msg.size(), fmt_new_msg.size() - fmt_past_msg.size()); |
| return ss.str(); |
| } |
|
|
| std::string common_chat_format_example(const struct common_chat_templates * tmpls, bool use_jinja, const std::map<std::string, std::string> & chat_template_kwargs) { |
| common_chat_templates_inputs inputs; |
| inputs.use_jinja = use_jinja; |
| inputs.add_bos = tmpls->add_bos; |
| inputs.add_eos = tmpls->add_eos; |
| inputs.chat_template_kwargs = chat_template_kwargs; |
| auto add_simple_msg = [&](auto role, auto content) { |
| common_chat_msg msg; |
| msg.role = role; |
| msg.content = content; |
| inputs.messages.push_back(msg); |
| }; |
| add_simple_msg("system", "You are a helpful assistant"); |
| add_simple_msg("user", "Hello"); |
| add_simple_msg("assistant", "Hi there"); |
| add_simple_msg("user", "How are you?"); |
| return common_chat_templates_apply(tmpls, inputs).prompt; |
| } |
|
|
| #define CHATML_TEMPLATE_SRC \ |
| "{%- for message in messages -%}\n" \ |
| " {{- '<|im_start|>' + message.role + '\n' + message.content + '<|im_end|>\n' -}}\n" \ |
| "{%- endfor -%}\n" \ |
| "{%- if add_generation_prompt -%}\n" \ |
| " {{- '<|im_start|>assistant\n' -}}\n" \ |
| "{%- endif -%}" |
|
|
| void common_chat_templates_free(struct common_chat_templates * tmpls) { |
| delete tmpls; |
| } |
|
|
| bool common_chat_templates_was_explicit(const struct common_chat_templates * tmpls) { |
| return tmpls->has_explicit_template; |
| } |
|
|
| std::string common_chat_templates_source(const struct common_chat_templates * tmpls, const std::string & variant) { |
| if (!variant.empty()) { |
| if (variant == "tool_use") { |
| if (tmpls->template_tool_use) { |
| return tmpls->template_tool_use->source(); |
| } |
| return ""; |
| } else { |
| LOG_DBG("%s: unknown template variant: %s\n", __func__, variant.c_str()); |
| } |
| } |
| return tmpls->template_default->source(); |
| } |
|
|
| common_chat_templates_ptr common_chat_templates_init( |
| const struct llama_model * model, |
| const std::string & chat_template_override, |
| const std::string & bos_token_override, |
| const std::string & eos_token_override) |
| { |
| std::string default_template_src; |
| std::string template_tool_use_src; |
|
|
| bool has_explicit_template = !chat_template_override.empty(); |
| if (chat_template_override.empty()) { |
| GGML_ASSERT(model != nullptr); |
| const auto * str = llama_model_chat_template(model, nullptr); |
| if (str) { |
| default_template_src = str; |
| has_explicit_template = true; |
| } |
| str = llama_model_chat_template(model, "tool_use"); |
| if (str) { |
| template_tool_use_src = str; |
| has_explicit_template = true; |
| } |
| } else { |
| default_template_src = chat_template_override; |
| } |
| if (default_template_src.empty() || default_template_src == "chatml") { |
| if (!template_tool_use_src.empty()) { |
| default_template_src = template_tool_use_src; |
| } else { |
| default_template_src = CHATML_TEMPLATE_SRC; |
| } |
| } |
|
|
| |
| |
| if (default_template_src.find("<|channel|>") != std::string::npos |
| |
| && default_template_src.find("in message.content or") != std::string::npos) { |
| string_replace_all(default_template_src, |
| "{%- if \"<|channel|>analysis<|message|>\" in message.content or \"<|channel|>final<|message|>\" in message.content %}", |
| "{%- if false %}"); |
| } |
|
|
| |
| |
| if (default_template_src.find("[TOOL_CALLS]") != std::string::npos |
| |
| && default_template_src.find("if (message['content'] is none or") != std::string::npos) { |
| string_replace_all(default_template_src, |
| "{%- if (message['content'] is none or message['content'] == '' or message['content']|length == 0) and (message['tool_calls'] is not defined or message['tool_calls'] is none or message['tool_calls']|length == 0) %}", |
| "{%- if false %}"); |
| } |
|
|
| std::string token_bos = bos_token_override; |
| std::string token_eos = eos_token_override; |
| bool add_bos = false; |
| bool add_eos = false; |
| if (model) { |
| const auto * vocab = llama_model_get_vocab(model); |
| const auto get_token = [&](llama_token token, const char * name, const char * jinja_variable_name) { |
| if (token == LLAMA_TOKEN_NULL) { |
| if (default_template_src.find(jinja_variable_name) != std::string::npos |
| || template_tool_use_src.find(jinja_variable_name) != std::string::npos) { |
| LOG_WRN("common_chat_templates_init: warning: vocab does not have a %s token, jinja template won't work as intended.\n", name); |
| } |
| return std::string(); |
| } |
| return common_token_to_piece(vocab, token, true); |
| }; |
| token_bos = get_token(llama_vocab_bos(vocab), "BOS", "bos_token"); |
| token_eos = get_token(llama_vocab_eos(vocab), "EOS", "eos_token"); |
| add_bos = llama_vocab_get_add_bos(vocab); |
| add_eos = llama_vocab_get_add_eos(vocab); |
| } |
| common_chat_templates_ptr tmpls(new common_chat_templates()); |
| tmpls->has_explicit_template = has_explicit_template; |
| tmpls->add_bos = add_bos; |
| tmpls->add_eos = add_eos; |
| try { |
| tmpls->template_default = std::make_unique<common_chat_template>(default_template_src, token_bos, token_eos); |
| } catch (const std::exception & e) { |
| LOG_ERR("%s: error: %s\n", __func__, e.what()); |
| LOG_ERR("%s: failed to initialize chat template\n", __func__); |
| LOG_ERR("%s: please consider disabling jinja via --no-jinja, or using another chat template\n", __func__); |
| throw e; |
| } |
| if (!template_tool_use_src.empty()) { |
| try { |
| tmpls->template_tool_use = std::make_unique<common_chat_template>(template_tool_use_src, token_bos, token_eos); |
| } catch (const std::exception & e) { |
| LOG_ERR("%s: failed to parse tool use chat template (ignoring it): %s\n", __func__, e.what()); |
| } |
| } |
| return tmpls; |
| } |
|
|
| const char * common_chat_format_name(common_chat_format format) { |
| switch (format) { |
| case COMMON_CHAT_FORMAT_CONTENT_ONLY: return "Content-only"; |
| case COMMON_CHAT_FORMAT_GENERIC: return "Generic"; |
| case COMMON_CHAT_FORMAT_MISTRAL_NEMO: return "Mistral Nemo"; |
| case COMMON_CHAT_FORMAT_MAGISTRAL: return "Magistral"; |
| case COMMON_CHAT_FORMAT_LLAMA_3_X: return "Llama 3.x"; |
| case COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS: return "Llama 3.x with builtin tools"; |
| case COMMON_CHAT_FORMAT_DEEPSEEK_R1: return "DeepSeek R1"; |
| case COMMON_CHAT_FORMAT_FIREFUNCTION_V2: return "FireFunction v2"; |
| case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2: return "Functionary v3.2"; |
| case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1: return "Functionary v3.1 Llama 3.1"; |
| case COMMON_CHAT_FORMAT_DEEPSEEK_V3_1: return "DeepSeek V3.1"; |
| case COMMON_CHAT_FORMAT_HERMES_2_PRO: return "Hermes 2 Pro"; |
| case COMMON_CHAT_FORMAT_COMMAND_R7B: return "Command R7B"; |
| case COMMON_CHAT_FORMAT_GRANITE: return "Granite"; |
| case COMMON_CHAT_FORMAT_GPT_OSS: return "GPT-OSS"; |
| case COMMON_CHAT_FORMAT_SEED_OSS: return "Seed-OSS"; |
| case COMMON_CHAT_FORMAT_NEMOTRON_V2: return "Nemotron V2"; |
| case COMMON_CHAT_FORMAT_APERTUS: return "Apertus"; |
| case COMMON_CHAT_FORMAT_LFM2_WITH_JSON_TOOLS: return "LFM2 with JSON tools"; |
| case COMMON_CHAT_FORMAT_MINIMAX_M2: return "MiniMax-M2"; |
| case COMMON_CHAT_FORMAT_GLM_4_5: return "GLM 4.5"; |
| case COMMON_CHAT_FORMAT_KIMI_K2: return "Kimi K2"; |
| case COMMON_CHAT_FORMAT_APRIEL_1_5: return "Apriel 1.5"; |
| case COMMON_CHAT_FORMAT_XIAOMI_MIMO: return "Xiaomi MiMo"; |
| case COMMON_CHAT_FORMAT_SOLAR_OPEN: return "Solar Open"; |
| case COMMON_CHAT_FORMAT_EXAONE_MOE: return "EXAONE MoE"; |
| case COMMON_CHAT_FORMAT_PEG_SIMPLE: return "peg-simple"; |
| case COMMON_CHAT_FORMAT_PEG_NATIVE: return "peg-native"; |
| case COMMON_CHAT_FORMAT_PEG_CONSTRUCTED: return "peg-constructed"; |
| default: |
| throw std::runtime_error("Unknown chat format"); |
| } |
| } |
|
|
| const char * common_reasoning_format_name(common_reasoning_format format) { |
| switch (format) { |
| case COMMON_REASONING_FORMAT_NONE: return "none"; |
| case COMMON_REASONING_FORMAT_AUTO: return "auto"; |
| case COMMON_REASONING_FORMAT_DEEPSEEK: return "deepseek"; |
| case COMMON_REASONING_FORMAT_DEEPSEEK_LEGACY: return "deepseek-legacy"; |
| default: |
| throw std::runtime_error("Unknown reasoning format"); |
| } |
| } |
|
|
| common_reasoning_format common_reasoning_format_from_name(const std::string & format) { |
| if (format == "none") { |
| return COMMON_REASONING_FORMAT_NONE; |
| } else if (format == "auto") { |
| return COMMON_REASONING_FORMAT_AUTO; |
| } else if (format == "deepseek") { |
| return COMMON_REASONING_FORMAT_DEEPSEEK; |
| } else if (format == "deepseek-legacy") { |
| return COMMON_REASONING_FORMAT_DEEPSEEK_LEGACY; |
| } |
| throw std::runtime_error("Unknown reasoning format: " + format); |
| } |
|
|
| static void foreach_function(const json & tools, const std::function<void(const json &)> & fn) { |
| for (const auto & tool : tools) { |
| if (!tool.contains("type") || tool.at("type") != "function" || !tool.contains("function")) { |
| LOG_INF("Skipping tool without function: %s", tool.dump(2).c_str()); |
| continue; |
| } |
| fn(tool); |
| } |
| } |
|
|
| static void foreach_parameter(const json & function, const std::function<void(const std::string &, const json &, bool)> & fn) { |
| if (!function.contains("parameters") || !function.at("parameters").is_object()) { |
| return; |
| } |
| const auto & params = function.at("parameters"); |
| if (!params.contains("properties") || !params.at("properties").is_object()) { |
| return; |
| } |
| const auto & props = params.at("properties"); |
| std::set<std::string> required; |
| if (params.contains("required") && params.at("required").is_array()) { |
| params.at("required").get_to(required); |
| } |
| for (const auto & [name, prop] : props.items()) { |
| bool is_required = (required.find(name) != required.end()); |
| fn(name, prop, is_required); |
| } |
| } |
|
|
| static std::string apply( |
| const common_chat_template & tmpl, |
| const struct templates_params & inputs, |
| const std::optional<json> & messages_override = std::nullopt, |
| const std::optional<json> & tools_override = std::nullopt, |
| const std::optional<json> & additional_context = std::nullopt) |
| { |
| jinja::context ctx(tmpl.source()); |
|
|
| nlohmann::ordered_json inp = nlohmann::ordered_json{ |
| {"messages", messages_override.has_value() ? *messages_override : inputs.messages}, |
| {"bos_token", tmpl.bos_token()}, |
| {"eos_token", tmpl.eos_token()}, |
| }; |
| if (tools_override.has_value() || !inputs.tools.empty()) { |
| inp["tools"] = tools_override.has_value() ? *tools_override : inputs.tools; |
| } |
| if (inputs.extra_context.is_object()) { |
| |
| for (const auto & [k, v] : inputs.extra_context.items()) { |
| inp[k] = v; |
| } |
| } |
| if (additional_context.has_value()) { |
| |
| for (const auto & [k, v] : additional_context->items()) { |
| inp[k] = v; |
| } |
| } |
| if (inputs.add_generation_prompt) { |
| inp["add_generation_prompt"] = true; |
| } |
|
|
| jinja::global_from_json(ctx, inp, inputs.mark_input); |
|
|
| |
| jinja::runtime runtime(ctx); |
| const jinja::value results = runtime.execute(tmpl.prog); |
| auto parts = runtime.gather_string_parts(results); |
|
|
| std::string result = parts->as_string().str(); |
|
|
| |
| if (inputs.add_bos && string_starts_with(result, tmpl.bos_token())) { |
| result = result.substr(tmpl.bos_token().size()); |
| } |
| if (inputs.add_eos && string_ends_with(result, tmpl.eos_token())) { |
| result = result.substr(0, result.size() - tmpl.eos_token().size()); |
| } |
| return result; |
| } |
|
|
| static common_chat_params common_chat_params_init_generic(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| auto tool_call_schemas = json::array(); |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| auto tool_schema = json { |
| {"type", "object"}, |
| {"properties", { |
| {"name", { |
| {"type", "string"}, |
| {"const", function.at("name")}, |
| }}, |
| {"arguments", function.at("parameters")}, |
| }}, |
| {"required", json::array({"name", "arguments"})}, |
| }; |
| if (function.contains("description")) { |
| tool_schema["description"] = function.at("description"); |
| } |
| if (inputs.parallel_tool_calls) { |
| tool_schema.at("properties")["id"] = { |
| {"type", "string"}, |
| {"minLength", 4}, |
| }; |
| tool_schema.at("required").push_back("id"); |
| } |
| tool_call_schemas.emplace_back(tool_schema); |
| }); |
| const auto tool_call = |
| inputs.parallel_tool_calls |
| ? json { |
| {"type", "object"}, |
| {"properties", { |
| {"tool_calls", { |
| {"type", "array"}, |
| {"items", tool_call_schemas.size() == 1 ? tool_call_schemas[0] : json { |
| {"anyOf", tool_call_schemas}, |
| }}, |
| {"minItems", 1}, |
| }}, |
| }}, |
| {"required", json::array({"tool_calls"})}, |
| } |
| : json { |
| {"type", "object"}, |
| {"properties", { |
| {"tool_call", tool_call_schemas.size() == 1 ? tool_call_schemas[0] : json { |
| {"anyOf", tool_call_schemas}, |
| }}, |
| }}, |
| {"required", json::array({"tool_call"})}, |
| }; |
| const auto schema = |
| inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED |
| ? json { |
| {"anyOf", json::array({ |
| tool_call, |
| { |
| {"type", "object"}, |
| {"properties", { |
| {"response", inputs.json_schema.is_null() |
| ? json {{"type", "string"}} |
| : inputs.json_schema |
| }, |
| }}, |
| {"required", json::array({"response"})}, |
| }, |
| })} |
| } |
| : tool_call; |
|
|
| data.grammar_lazy = false; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| builder.add_schema("root", schema); |
| }); |
|
|
| auto tweaked_messages = tmpl.add_system( |
| inputs.messages, |
| "Respond in JSON format, either with `tool_call` (a request to call tools) or with `response` reply to the user's request"); |
|
|
| |
| for (auto & message : tweaked_messages) { |
| if (!message.contains("content") || message["content"].is_null()) { |
| message["content"] = ""; |
| } |
| } |
|
|
| data.prompt = apply(tmpl, inputs, tweaked_messages); |
| data.format = COMMON_CHAT_FORMAT_GENERIC; |
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_mistral_nemo(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| auto schemas = json::array(); |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| schemas.push_back({ |
| {"type", "object"}, |
| {"properties", { |
| |
| |
| {"name", { |
| {"type", "string"}, |
| {"const", function.at("name")}, |
| }}, |
| {"arguments", function.at("parameters")}, |
| {"id", { |
| {"type", "string"}, |
| |
| {"pattern", "^[a-zA-Z0-9]{9}$"}, |
| }}, |
| }}, |
| {"required", json::array({"name", "arguments", "id"})}, |
| }); |
| }); |
| auto schema = json { |
| {"type", "array"}, |
| {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}}, |
| {"minItems", 1}, |
| }; |
| if (!inputs.parallel_tool_calls) { |
| schema["maxItems"] = 1; |
| } |
| builder.add_rule("root", "\"[TOOL_CALLS]\" " + builder.add_schema("tool_calls", schema)); |
| }); |
| data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "[TOOL_CALLS]"}); |
| data.preserved_tokens = { |
| "[TOOL_CALLS]", |
| }; |
| data.prompt = apply(tmpl, inputs); |
| data.format = COMMON_CHAT_FORMAT_MISTRAL_NEMO; |
| return data; |
| } |
|
|
|
|
| |
| static size_t ifind_string(const std::string & haystack, const std::string & needle, size_t pos = 0) { |
| auto it = std::search( |
| haystack.begin() + pos, haystack.end(), |
| needle.begin(), needle.end(), |
| [](char a, char b) { return std::tolower(a) == std::tolower(b); } |
| ); |
| return (it == haystack.end()) ? std::string::npos : std::distance(haystack.begin(), it); |
| } |
|
|
| static common_chat_params common_chat_params_init_lfm2(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
| const auto is_json_schema_provided = !inputs.json_schema.is_null(); |
| const auto is_grammar_provided = !inputs.grammar.empty(); |
| const auto are_tools_provided = inputs.tools.is_array() && !inputs.tools.empty(); |
|
|
| |
| auto tweaked_messages = inputs.messages; |
|
|
| auto replace_json_schema_marker = [](json & messages) -> bool { |
| static std::string marker1 = "force json schema.\n"; |
| static std::string marker2 = "force json schema."; |
|
|
| if (messages.empty() || messages.at(0).at("role") != "system") { |
| return false; |
| } |
|
|
| std::string content = messages.at(0).at("content"); |
|
|
| for (const auto & marker : {marker1, marker2}) { |
| const auto pos = ifind_string(content, marker); |
| if (pos != std::string::npos) { |
| content.replace(pos, marker.length(), ""); |
| |
| messages.at(0).at("content") = content; |
| return true; |
| } |
| } |
|
|
| return false; |
| }; |
|
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| if (are_tools_provided && (is_json_schema_provided || is_grammar_provided)) { |
| |
| throw std::runtime_error("Tools call must not use \"json_schema\" or \"grammar\", use non-tool invocation if you want to use custom grammar"); |
| } else if (are_tools_provided && replace_json_schema_marker(tweaked_messages)) { |
| LOG_INF("%s: Using tools to build a grammar\n", __func__); |
|
|
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| auto schemas = json::array(); |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| schemas.push_back({ |
| {"type", "object"}, |
| {"properties", { |
| {"name", { |
| {"type", "string"}, |
| {"const", function.at("name")}, |
| }}, |
| {"arguments", function.at("parameters")}, |
| }}, |
| {"required", json::array({"name", "arguments", "id"})}, |
| }); |
| }); |
| auto schema = json { |
| {"type", "array"}, |
| {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}}, |
| {"minItems", 1}, |
| }; |
| if (!inputs.parallel_tool_calls) { |
| schema["maxItems"] = 1; |
| } |
|
|
| builder.add_rule("root", "\"<|tool_call_start|>\"" + builder.add_schema("tool_calls", schema) + "\"<|tool_call_end|>\""); |
| }); |
| |
| |
| |
| data.grammar_lazy = true; |
| data.grammar_triggers = {{COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL, "\\s*<\\|tool_call_start\\|>\\s*\\["}}; |
| data.preserved_tokens = {"<|tool_call_start|>", "<|tool_call_end|>"}; |
| data.format = COMMON_CHAT_FORMAT_LFM2_WITH_JSON_TOOLS; |
| } else if (are_tools_provided && (!is_json_schema_provided && !is_grammar_provided)) { |
| LOG_INF("%s: Using tools without json schema or grammar\n", __func__); |
| |
| data.preserved_tokens = {"<|tool_call_start|>", "<|tool_call_end|>"}; |
| } else if (is_json_schema_provided) { |
| LOG_INF("%s: Using provided json schema to build a grammar\n", __func__); |
| data.grammar = json_schema_to_grammar(inputs.json_schema); |
| } else if (is_grammar_provided) { |
| LOG_INF("%s: Using provided grammar\n", __func__); |
| data.grammar = inputs.grammar; |
| } else { |
| LOG_INF("%s: Using content relying on the template\n", __func__); |
| } |
|
|
| data.prompt = apply(tmpl, inputs, tweaked_messages); |
| LOG_DBG("%s: Prompt: %s\n", __func__, data.prompt.c_str()); |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_ministral_3(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| |
| auto adjusted_messages = json::array(); |
| for (const auto & msg : inputs.messages) { |
| auto role = msg.value("role", ""); |
| if (role != "system" && role != "assistant") { |
| |
| adjusted_messages.push_back(msg); |
| continue; |
| } |
|
|
| auto content = json::array(); |
|
|
| |
| if (msg.contains("reasoning_content") && msg.at("reasoning_content").is_string()) { |
| content.push_back({ |
| {"type", "thinking"}, |
| {"thinking", msg.at("reasoning_content").get<std::string>()}, |
| }); |
| } |
|
|
| |
| if (msg.contains("content")) { |
| if (msg.at("content").is_string()) { |
| content.push_back({ |
| {"type", "text"}, |
| {"text", msg.at("content").get<std::string>()}, |
| }); |
| } else if (msg.at("content").is_array()) { |
| auto blocks = msg.at("content"); |
| content.insert(content.end(), blocks.begin(), blocks.end()); |
| } |
| } |
|
|
| auto adjusted = msg; |
| adjusted["content"] = content; |
| adjusted.erase("reasoning_content"); |
| adjusted_messages.push_back(adjusted); |
| } |
|
|
| auto has_tools = inputs.tools.is_array() && !inputs.tools.empty(); |
| auto extract_reasoning = inputs.reasoning_format != COMMON_REASONING_FORMAT_NONE; |
| auto include_grammar = true; |
|
|
| data.prompt = apply(tmpl, inputs, adjusted_messages); |
| data.format = COMMON_CHAT_FORMAT_PEG_NATIVE; |
| data.preserved_tokens = { |
| "[THINK]", |
| "[/THINK]", |
| "[TOOL_CALLS]", |
| "[ARGS]", |
| }; |
|
|
| auto parser = build_chat_peg_native_parser([&](common_chat_peg_native_builder & p) { |
| auto reasoning = extract_reasoning ? p.optional("[THINK]" + p.reasoning(p.until("[/THINK]")) + "[/THINK]") : p.eps(); |
|
|
| |
| if (inputs.json_schema.is_object() && !inputs.json_schema.empty()) { |
| |
| return reasoning << "```json" << p.content(p.schema(p.json(), "response-format", inputs.json_schema)) << "```"; |
| } |
|
|
| |
| if (has_tools && inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_NONE) { |
| auto tool_choice = p.choice(); |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| const auto & schema = function.at("parameters"); |
|
|
| tool_choice |= p.rule("tool-" + name, |
| p.tool_open(p.tool_name(p.literal(name)) + "[ARGS]") |
| + p.tool_args(p.schema(p.json(), "tool-" + name + "-schema", schema)) |
| ); |
| }); |
|
|
| auto min_calls = inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_REQUIRED ? 1 : 0; |
| auto max_calls = inputs.parallel_tool_calls ? -1 : 1; |
| auto tool_calls = p.trigger_rule("tool-call", p.repeat("[TOOL_CALLS]" + tool_choice, min_calls, max_calls)); |
|
|
| return reasoning << p.content(p.until("[TOOL_CALLS]")) << tool_calls; |
| } |
|
|
| |
| include_grammar = false; |
| return reasoning << p.content(p.rest()); |
| }); |
|
|
| data.parser = parser.save(); |
|
|
| if (include_grammar) { |
| data.grammar_lazy = has_tools && inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_AUTO; |
|
|
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| auto schema = function.at("parameters"); |
| builder.resolve_refs(schema); |
| }); |
| parser.build_grammar(builder, data.grammar_lazy); |
| }); |
|
|
| data.grammar_triggers = { |
| {COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "[TOOL_CALLS]"} |
| }; |
| } |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_magistral(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
| data.prompt = apply(tmpl, inputs); |
| data.format = COMMON_CHAT_FORMAT_MAGISTRAL; |
| data.preserved_tokens = { |
| "[THINK]", |
| "[/THINK]", |
| }; |
|
|
| if (inputs.tools.is_array() && !inputs.tools.empty()) { |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| auto schemas = json::array(); |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| schemas.push_back({ |
| {"type", "object"}, |
| {"properties", { |
| {"name", { |
| {"type", "string"}, |
| {"const", function.at("name")}, |
| }}, |
| {"arguments", function.at("parameters")}, |
| {"id", { |
| {"type", "string"}, |
| {"pattern", "^[a-zA-Z0-9]{9}$"}, |
| }}, |
| }}, |
| {"required", json::array({"name", "arguments", "id"})}, |
| }); |
| }); |
| auto schema = json { |
| {"type", "array"}, |
| {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}}, |
| {"minItems", 1}, |
| }; |
| if (!inputs.parallel_tool_calls) { |
| schema["maxItems"] = 1; |
| } |
| builder.add_rule("root", "\"[TOOL_CALLS]\" " + builder.add_schema("tool_calls", schema)); |
| }); |
| data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "[TOOL_CALLS]"}); |
| data.preserved_tokens.push_back("[TOOL_CALLS]"); |
| } else { |
| data.grammar_lazy = false; |
| if (!inputs.json_schema.is_null()) { |
| if (!inputs.grammar.empty()) { |
| throw std::runtime_error("Either \"json_schema\" or \"grammar\" can be specified, but not both"); |
| } |
| data.grammar = json_schema_to_grammar(inputs.json_schema); |
| } else { |
| data.grammar = inputs.grammar; |
| } |
| } |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_command_r7b(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| auto adjusted_messages = json::array(); |
| for (const auto & msg : inputs.messages) { |
| auto has_reasoning_content = msg.contains("reasoning_content") && msg.at("reasoning_content").is_string(); |
| auto has_tool_calls = msg.contains("tool_calls") && msg.at("tool_calls").is_array(); |
| if (has_reasoning_content && has_tool_calls) { |
| auto adjusted_message = msg; |
| adjusted_message["tool_plan"] = msg.at("reasoning_content"); |
| adjusted_message.erase("reasoning_content"); |
| adjusted_messages.push_back(adjusted_message); |
| } else { |
| adjusted_messages.push_back(msg); |
| } |
| } |
| data.prompt = apply(tmpl, inputs, adjusted_messages); |
| data.format = COMMON_CHAT_FORMAT_COMMAND_R7B; |
| if (string_ends_with(data.prompt, "<|START_THINKING|>")) { |
| if (!inputs.enable_thinking) { |
| data.prompt += "<|END_THINKING|>"; |
| } else { |
| data.thinking_forced_open = true; |
| } |
| } else if (!inputs.enable_thinking && string_ends_with(data.prompt, "<|CHATBOT_TOKEN|>")) { |
| data.prompt += "<|START_THINKING|><|END_THINKING|>"; |
| } |
|
|
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| auto schemas = json::array(); |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| schemas.push_back({ |
| {"type", "object"}, |
| {"properties", { |
| {"tool_call_id", { |
| {"type", "string"}, |
| |
| {"pattern", "^[0-9]{1,10}$"}, |
| }}, |
| {"tool_name", { |
| {"type", "string"}, |
| {"const", function.at("name")}, |
| }}, |
| {"parameters", function.at("parameters")}, |
| }}, |
| {"required", json::array({"tool_call_id", "tool_name", "parameters"})}, |
| }); |
| }); |
| auto schema = json { |
| {"type", "array"}, |
| {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}}, |
| {"minItems", 1}, |
| }; |
| if (!inputs.parallel_tool_calls) { |
| schema["maxItems"] = 1; |
| } |
| builder.add_rule("root", |
| std::string(data.thinking_forced_open ? "( \"<|END_THINKING|>\" space )? " : "") + |
| "\"<|START_ACTION|>\" " + builder.add_schema("tool_calls", schema) + " \"<|END_ACTION|>\""); |
| }); |
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL, |
| |
| |
| std::string(data.thinking_forced_open ? "[\\s\\S]*?(<\\|END_THINKING\\|>\\s*)" : "(?:<\\|START_THINKING\\|>[\\s\\S]*?<\\|END_THINKING\\|>\\s*)?") + |
| "(<\\|START_ACTION\\|>)[\\s\\S]*" |
| }); |
| data.preserved_tokens = { |
| "<|START_ACTION|>", |
| "<|END_ACTION|>", |
| "<|START_RESPONSE|>", |
| "<|END_RESPONSE|>", |
| "<|START_THINKING|>", |
| "<|END_THINKING|>", |
| }; |
| return data; |
| } |
|
|
| static void expect_tool_parameters(const std::string & name, const json & parameters, const std::vector<std::string> & expected_properties) { |
| if (!parameters.is_object() || !parameters.contains("type") || parameters.at("type") != "object" || !parameters.contains("properties") || !parameters.contains("required")) { |
| throw std::runtime_error("Parameters of tool " + name + " must be an object w/ required properties"); |
| } |
| const auto & parameters_properties = parameters.at("properties"); |
| const auto & parameters_required = parameters.at("required"); |
| for (const auto & prop : expected_properties) { |
| if (!parameters_properties.contains(prop)) { |
| throw std::runtime_error("Parameters of tool " + name + " is missing property: " + prop); |
| } |
| if (std::find(parameters_required.begin(), parameters_required.end(), json(prop)) == parameters_required.end()) { |
| throw std::runtime_error("Parameters of tool " + name + " must have property marked as required: " + prop); |
| } |
| } |
| if (parameters_properties.size() != expected_properties.size()) { |
| throw std::runtime_error("Parameters of tool " + name + " must only have these properties:" + string_join(expected_properties, ", ")); |
| } |
| } |
|
|
| static common_chat_params common_chat_params_init_llama_3_x(const common_chat_template & tmpl, const struct templates_params & inputs, bool allow_python_tag_builtin_tools) { |
| auto builtin_tools = json::array(); |
| common_chat_params data; |
| if (!inputs.tools.is_null()) { |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| std::vector<std::string> tool_rules; |
|
|
| auto handle_builtin_tool = [&](const std::string & name, const json & parameters) { |
| if (name == "wolfram_alpha" || name == "web_search" || name == "brave_search") { |
| |
| |
| expect_tool_parameters(name, parameters, {"query"}); |
| } else if (name == "python" || name == "code_interpreter") { |
| |
| expect_tool_parameters(name, parameters, {"code"}); |
| } else { |
| return false; |
| } |
|
|
| std::vector<std::string> kvs; |
| for (const auto & [key, value] : parameters.at("properties").items()) { |
| kvs.push_back("\"" + key + "=\" " + builder.add_schema(name + "-args-" + key, value)); |
| } |
|
|
| tool_rules.push_back( |
| builder.add_rule( |
| name + "-call", |
| "\"<|python_tag|>" + name + ".call(\" " + string_join(kvs, " \", \" ") + " \")\"")); |
| builtin_tools.push_back(name); |
|
|
| return true; |
| }; |
|
|
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| auto parameters = function.at("parameters"); |
| builder.resolve_refs(parameters); |
|
|
| |
| if (allow_python_tag_builtin_tools) { |
| handle_builtin_tool(name, parameters); |
| } |
| tool_rules.push_back( |
| builder.add_rule( |
| name + "-call", |
| "\"{\" space " |
| "( \"\\\"type\\\"\" space \":\" space \"\\\"function\\\"\" space \",\" space )? " |
| " \"\\\"name\\\"\" space \":\" space \"\\\"" + name + "\\\"\" space \",\" space " |
| " \"\\\"parameters\\\"\" space \":\" space " + builder.add_schema(name + "-args", parameters) + " " |
| "\"}\" space")); |
| }); |
| |
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL, |
| "(\\{\\s*(?:\"type\"\\s*:\\s*\"function\"\\s*,\\s*)?\"name\"\\s*:\\s*\")[\\s\\S]*", |
| }); |
| if (!builtin_tools.empty()) { |
| data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<|python_tag|>"}); |
| data.preserved_tokens.push_back("<|python_tag|>"); |
| } |
| |
| builder.add_rule("root", string_join(tool_rules, " | ")); |
| data.additional_stops.push_back("<|eom_id|>"); |
| }); |
| data.format = allow_python_tag_builtin_tools && !builtin_tools.empty() |
| ? COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS |
| : COMMON_CHAT_FORMAT_LLAMA_3_X; |
| } else { |
| data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY; |
| } |
| data.prompt = apply(tmpl, inputs, std::nullopt, std::nullopt, json { |
| {"date_string", format_time(inputs.now, "%d %b %Y")}, |
| {"tools_in_user_message", false}, |
| {"builtin_tools", builtin_tools}, |
| }); |
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_nemotron_v2(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| |
| data.prompt = apply(tmpl, inputs); |
| data.format = COMMON_CHAT_FORMAT_NEMOTRON_V2; |
|
|
| |
| if (string_ends_with(data.prompt, "<think>\n")) { |
| if (!inputs.enable_thinking) { |
| data.prompt += "</think>"; |
| } else { |
| data.thinking_forced_open = true; |
| } |
| } |
|
|
| |
| if (!inputs.tools.is_null() && inputs.tools.is_array() && !inputs.tools.empty()) { |
| data.grammar_lazy = true; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| auto schemas = json::array(); |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| schemas.push_back({ |
| { "type", "object" }, |
| { "properties", |
| { |
| { "name", |
| { |
| { "type", "string" }, |
| { "const", function.at("name") }, |
| } }, |
| { "arguments", function.at("parameters") }, |
| } }, |
| { "required", json::array({ "name", "arguments" }) }, |
| }); |
| }); |
| auto schema = json{ |
| { "type", "array" }, |
| { "items", schemas.size() == 1 ? schemas[0] : json{ { "anyOf", schemas } } }, |
| { "minItems", 1 }, |
| }; |
| if (!inputs.parallel_tool_calls) { |
| schema["maxItems"] = 1; |
| } |
| builder.add_rule("root", |
| std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") + |
| "\"<TOOLCALL>\" " + builder.add_schema("tool_calls", schema) + |
| " \"</TOOLCALL>\""); |
| }); |
| data.grammar_triggers.push_back({ COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL, |
| |
| |
| std::string(data.thinking_forced_open ? |
| "[\\s\\S]*?(</think>\\s*)" : |
| "(?:<think>[\\s\\S]*?</think>\\s*)?") + |
| "(<TOOLCALL>)[\\s\\S]*" }); |
| } |
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_qwen3_coder(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| data.prompt = apply(tmpl, inputs); |
| data.format = COMMON_CHAT_FORMAT_PEG_CONSTRUCTED; |
|
|
| |
| bool supports_reasoning = (tmpl.source().find("<think>") != std::string::npos); |
|
|
| |
| if (supports_reasoning && string_ends_with(data.prompt, "<think>\n")) { |
| if (!inputs.enable_thinking) { |
| data.prompt += "</think>"; |
| } else { |
| data.thinking_forced_open = true; |
| } |
| } |
|
|
| data.preserved_tokens = { |
| "<tool_call>", |
| "</tool_call>", |
| }; |
|
|
| if (supports_reasoning) { |
| data.preserved_tokens.insert(data.preserved_tokens.end(), {"<think>", "</think>"}); |
| } |
|
|
| auto has_tools = inputs.tools.is_array() && !inputs.tools.empty(); |
| auto extract_reasoning = inputs.reasoning_format != COMMON_REASONING_FORMAT_NONE; |
| auto include_grammar = true; |
|
|
| auto parser = build_chat_peg_constructed_parser([&](auto & p) { |
| auto reasoning = p.eps(); |
| if (supports_reasoning && inputs.enable_thinking && extract_reasoning) { |
| auto reasoning_content = p.reasoning(p.until("</think>")) + ("</think>" | p.end()); |
| if (data.thinking_forced_open) { |
| reasoning = reasoning_content; |
| } |
| } |
|
|
| |
| if (inputs.json_schema.is_object() && !inputs.json_schema.empty()) { |
| return reasoning << p.content(p.schema(p.json(), "response-format", inputs.json_schema)); |
| } |
|
|
| |
| if (has_tools && inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_NONE) { |
| auto tool_choice = p.choice(); |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| auto parameters = function.at("parameters"); |
|
|
| auto schema_info = common_schema_info(); |
| schema_info.resolve_refs(parameters); |
|
|
| auto tool_open = "<function=" + p.tool_name(p.literal(name)) + ">\n"; |
| auto tool_close = p.literal("</function>\n"); |
| auto args = p.sequence(); |
| auto arg_string = p.rule("xml-arg-string", p.until_one_of({ |
| "\n</parameter>", |
| "\n<parameter=", |
| "\n</function>" |
| })); |
|
|
| foreach_parameter(function, [&](const auto & param_name, const json & param_schema, bool is_required) { |
| auto rule_name = "tool-" + name + "-arg-" + param_name; |
|
|
| auto arg_open = "<parameter=" + p.tool_arg_name(p.literal(param_name)) + ">\n"; |
| auto arg_close = p.literal("</parameter>\n"); |
| auto arg_value = p.eps(); |
|
|
| if (schema_info.resolves_to_string(param_schema)) { |
| arg_value = p.tool_arg_string_value(arg_string) + "\n"; |
| } else { |
| arg_value = p.tool_arg_json_value(p.schema(p.json(), rule_name + "-schema", param_schema)); |
| } |
|
|
| |
| auto arg_rule = p.rule(rule_name, p.tool_arg_open(arg_open) + arg_value + p.optional(p.tool_arg_close(arg_close))); |
| args += p.repeat(arg_rule, is_required ? 1 : 0, 1); |
| }); |
|
|
| tool_choice |= p.rule("tool-" + name, p.tool_open(tool_open) + args + p.tool_close(tool_close)); |
| }); |
|
|
| auto min_calls = inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_REQUIRED ? 1 : 0; |
| auto max_calls = inputs.parallel_tool_calls ? -1 : 1; |
| auto tool_call = p.rule("tool-call", "<tool_call>\n" + tool_choice + "</tool_call>" + p.space()); |
| auto tool_calls = p.trigger_rule("tool-call-root", p.repeat(tool_call, min_calls, max_calls)); |
|
|
| return reasoning << p.content(p.until("<tool_call>")) << tool_calls; |
| } |
|
|
| |
| include_grammar = false; |
| return reasoning << p.content(p.rest()); |
| }); |
|
|
| data.parser = parser.save(); |
|
|
| if (include_grammar) { |
| data.grammar_lazy = has_tools && inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_AUTO; |
|
|
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| auto schema = function.at("parameters"); |
| builder.resolve_refs(schema); |
| }); |
| parser.build_grammar(builder, data.grammar_lazy); |
| }); |
|
|
| data.grammar_triggers = { |
| {COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<tool_call>"} |
| }; |
| } |
|
|
| return data; |
| } |
|
|
|
|
| static common_chat_params common_chat_params_init_apertus(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| |
| data.prompt = apply(tmpl, inputs); |
| data.format = COMMON_CHAT_FORMAT_APERTUS; |
|
|
| |
| if (string_ends_with(data.prompt, "<|inner_prefix|>")) { |
| if (!inputs.enable_thinking) { |
| data.prompt += "<|inner_suffix|>"; |
| } else { |
| data.thinking_forced_open = true; |
| } |
| } |
|
|
| |
| if (!inputs.tools.is_null() && inputs.tools.is_array() && !inputs.tools.empty()) { |
| data.grammar_lazy = true; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| auto schemas = json::array(); |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| schemas.push_back({ |
| { "type", "object" }, |
| { "properties", |
| { |
| { function.at("name"), function.at("parameters") } |
| } }, |
| { "required", json::array({ function.at("name") }) }, |
| }); |
| }); |
| auto schema = json{ |
| { "type", "array" }, |
| { "items", schemas.size() == 1 ? schemas[0] : json{ { "anyOf", schemas } } }, |
| { "minItems", 1 }, |
| }; |
| if (!inputs.parallel_tool_calls) { |
| schema["maxItems"] = 1; |
| } |
| builder.add_rule("root", |
| std::string(data.thinking_forced_open ? "( \"<|inner_suffix|>\" space )? " : "") + |
| "\"<|tools_prefix|>\"" + builder.add_schema("tool_calls", schema) + "\"<|tools_suffix|>\""); |
| }); |
| data.grammar_triggers.push_back({ COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL, |
| |
| |
| std::string(data.thinking_forced_open ? |
| "[\\s\\S]*?(<\\|inner_suffix\\|>\\s*)" : |
| "(?:<\\|inner_prefix\\|>[\\s\\S]*?<\\|inner_suffix\\|>\\s*)?") + |
| "(<\\|tools_prefix\\|>)[\\s\\S]*" }); |
| data.preserved_tokens = { |
| "<|system_start|>", |
| "<|system_end|>", |
| "<|developer_start|>", |
| "<|developer_end|>", |
| "<|user_start|>", |
| "<|user_end|>", |
| "<|assistant_start|>", |
| "<|assistant_end|>", |
| "<|inner_prefix|>", |
| "<|inner_suffix|>", |
| "<|tools_prefix|>", |
| "<|tools_suffix|>", |
| }; |
| } |
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_deepseek_r1(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
| auto prompt = apply(tmpl, inputs); |
|
|
| |
| |
| |
| if (tmpl.source().find("{% if ns.is_tool %}{{'<|tool▁outputs▁end|>'}}") != std::string::npos) { |
| |
| if (string_ends_with(prompt, "<|tool▁outputs▁end|>")) { |
| prompt += "<|end▁of▁sentence|>"; |
| if (inputs.add_generation_prompt) { |
| prompt += "<|Assistant|>"; |
| } |
| } |
| |
| prompt = std::regex_replace( |
| prompt, |
| std::regex("(<|tool▁call▁end|>)[\\s\\r\\n]*(<|tool▁outputs▁begin|>|<|User|>)"), |
| "$1<|tool▁calls▁end|><|end▁of▁sentence|>$2"); |
| } |
| data.prompt = prompt; |
| data.format = COMMON_CHAT_FORMAT_DEEPSEEK_R1; |
| if (string_ends_with(data.prompt, "<think>\n")) { |
| if (!inputs.enable_thinking) { |
| data.prompt += "</think>"; |
| } else { |
| data.thinking_forced_open = true; |
| } |
| } |
|
|
| if (inputs.tools.is_array() && !inputs.tools.empty()) { |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED && inputs.json_schema.is_null(); |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| std::vector<std::string> tool_rules; |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| auto parameters = function.at("parameters"); |
| builder.resolve_refs(parameters); |
| tool_rules.push_back(builder.add_rule(name + "-call", |
| "( \"<|tool▁call▁begin|>\" )? \"function<|tool▁sep|>" + name + "\\n" |
| "```json\\n\" " + builder.add_schema(name + "-args", parameters) + " " |
| "\"```<|tool▁call▁end|>\"")); |
| }); |
| |
| |
| builder.add_rule("root", |
| std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") + |
| "( \"<|tool▁calls▁begin|>\" | \"<|tool_calls_begin|>\" | \"<|tool calls begin|>\" | \"<|tool\\\\_calls\\\\_begin|>\" | \"<|tool▁calls|>\" ) " |
| "(" + string_join(tool_rules, " | ") + ")" + (inputs.parallel_tool_calls ? "*" : "") + " " |
| "\"<|tool▁calls▁end|>\"" |
| " space"); |
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL, |
| |
| |
| std::string(data.thinking_forced_open ? "[\\s\\S]*?(</think>\\s*)" : "(?:<think>[\\s\\S]*?</think>\\s*)?") + |
| "(<|tool▁calls▁begin|>|<|tool_calls_begin|>|<|tool calls begin|>|<|tool\\\\_calls\\\\_begin|>|<|tool▁calls|>)[\\s\\S]*" |
| }); |
| data.preserved_tokens = { |
| "<think>", |
| "</think>", |
| "<|tool▁calls▁begin|>", |
| "<|tool▁call▁begin|>", |
| "<|tool▁sep|>", |
| "<|tool▁call▁end|>", |
| "<|tool▁calls▁end|", |
| }; |
| }); |
| } |
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_deepseek_v3_1(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| |
| json additional_context = { |
| {"thinking", inputs.enable_thinking}, |
| }; |
|
|
| auto prompt = apply(tmpl, inputs, |
| inputs.messages, |
| std::nullopt, |
| additional_context); |
| data.prompt = prompt; |
| data.format = COMMON_CHAT_FORMAT_DEEPSEEK_V3_1; |
| if (string_ends_with(data.prompt, "<think>")) { |
| if (!inputs.enable_thinking) { |
| data.prompt += "</think>"; |
| } else { |
| data.thinking_forced_open = true; |
| } |
| } |
| if (inputs.tools.is_array() && !inputs.tools.empty()) { |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED && inputs.json_schema.is_null(); |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| std::vector<std::string> tool_rules; |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| auto parameters = function.at("parameters"); |
| builder.resolve_refs(parameters); |
| tool_rules.push_back(builder.add_rule(name + "-call", |
| "( \"<|tool▁call▁begin|>\" )? \"" + name + "<|tool▁sep|>" |
| "\" " + builder.add_schema(name + "-args", parameters) + " " |
| "\"<|tool▁call▁end|>\"")); |
| }); |
| |
| |
| builder.add_rule("root", |
| std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") + |
| "( \"<|tool▁calls▁begin|>\" | \"<|tool_calls_begin|>\" | \"<|tool calls begin|>\" | \"<|tool\\\\_calls\\\\_begin|>\" | \"<|tool▁calls|>\" ) " |
| "(" + string_join(tool_rules, " | ") + ")" + (inputs.parallel_tool_calls ? "*" : "") + " " |
| "\"<|tool▁calls▁end|>\"" |
| " space"); |
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL, |
| |
| |
| std::string(data.thinking_forced_open ? "[\\s\\S]*?(</think>\\s*)" : "(?:<think>[\\s\\S]*?</think>\\s*)?") + |
| "(<|tool▁calls▁begin|>|<|tool_calls_begin|>|<|tool calls begin|>|<|tool\\\\_calls\\\\_begin|>|<|tool▁calls|>)[\\s\\S]*" |
| }); |
| data.preserved_tokens = { |
| "<think>", |
| "</think>", |
| "<|tool▁calls▁begin|>", |
| "<|tool▁call▁begin|>", |
| "<|tool▁sep|>", |
| "<|tool▁call▁end|>", |
| "<|tool▁calls▁end|>", |
| }; |
| }); |
| } |
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_minimax_m2(const common_chat_template & tmpl, const struct templates_params & params) { |
| common_chat_params data; |
| data.grammar_lazy = params.tools.is_array() && !params.tools.empty() && params.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
|
|
| data.prompt = apply(tmpl, params); |
| data.format = COMMON_CHAT_FORMAT_MINIMAX_M2; |
|
|
| |
| if (string_ends_with(data.prompt, "<think>\n")) { |
| if (!params.enable_thinking) { |
| |
| data.prompt += "</think>\n\n"; |
| } else { |
| |
| data.thinking_forced_open = true; |
| } |
| } |
|
|
| |
| data.preserved_tokens = { |
| "<think>", |
| "</think>", |
| "<minimax:tool_call>", |
| "</minimax:tool_call>", |
| }; |
|
|
| |
| static const xml_tool_call_format form { |
| "<minimax:tool_call>\n", |
| "<invoke name=\"", |
| "\">\n", |
| "<parameter name=\"", |
| "\">", |
| "</parameter>\n", |
| "</invoke>\n", |
| "</minimax:tool_call>", |
| }; |
| build_grammar_xml_tool_call(data, params.tools, form); |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_kimi_k2(const common_chat_template & tmpl, const struct templates_params & params) { |
| common_chat_params data; |
| data.grammar_lazy = params.tools.is_array() && !params.tools.empty() && params.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
|
|
| data.prompt = apply(tmpl, params); |
| data.format = COMMON_CHAT_FORMAT_KIMI_K2; |
|
|
| data.preserved_tokens = { |
| "<think>", |
| "</think>", |
| "<|tool_calls_section_begin|>", |
| "<|tool_call_begin|>", |
| "<|tool_call_argument_begin|>", |
| "<|tool_call_end|>", |
| "<|tool_calls_section_end|>", |
| "<|im_end|>", |
| "<|im_system|>", |
| "<|im_middle|>", |
| }; |
|
|
| data.additional_stops.insert(data.additional_stops.end(), { |
| "<|im_end|>", |
| "<|im_middle|>" |
| }); |
| |
| static const xml_tool_call_format form = ([]() { |
| xml_tool_call_format form {}; |
| form.scope_start = "<|tool_calls_section_begin|>"; |
| form.tool_start = "<|tool_call_begin|>"; |
| form.tool_sep = "<|tool_call_argument_begin|>{"; |
| form.key_start = "\""; |
| form.key_val_sep = "\": "; |
| form.val_end = ", "; |
| form.tool_end = "}<|tool_call_end|>"; |
| form.scope_end = "<|tool_calls_section_end|>"; |
| form.raw_argval = false; |
| form.last_val_end = ""; |
| return form; |
| })(); |
| build_grammar_xml_tool_call(data, params.tools, form); |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_apriel_1_5(const common_chat_template & tmpl, const struct templates_params & params) { |
| common_chat_params data; |
| data.grammar_lazy = params.tools.is_array() && !params.tools.empty() && params.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
|
|
| data.prompt = apply(tmpl, params); |
| data.format = COMMON_CHAT_FORMAT_APRIEL_1_5; |
|
|
| data.preserved_tokens = { |
| "<thinking>", |
| "</thinking>", |
| "<tool_calls>", |
| "</tool_calls>", |
| }; |
|
|
| |
| static const xml_tool_call_format form = ([]() { |
| xml_tool_call_format form {}; |
| form.scope_start = "<tool_calls>["; |
| form.tool_start = "{\"name\": \""; |
| form.tool_sep = "\", \"arguments\": {"; |
| form.key_start = "\""; |
| form.key_val_sep = "\": "; |
| form.val_end = ", "; |
| form.tool_end = "}, "; |
| form.scope_end = "]</tool_calls>"; |
| form.raw_argval = false; |
| form.last_val_end = ""; |
| form.last_tool_end = "}"; |
| return form; |
| })(); |
| build_grammar_xml_tool_call(data, params.tools, form); |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_xiaomi_mimo(const common_chat_template & tmpl, const struct templates_params & params) { |
| common_chat_params data; |
| data.grammar_lazy = params.tools.is_array() && !params.tools.empty() && params.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
|
|
| data.prompt = apply(tmpl, params); |
| data.format = COMMON_CHAT_FORMAT_XIAOMI_MIMO; |
|
|
| data.preserved_tokens = { |
| "<tool_call>", |
| "</tool_call>", |
| }; |
|
|
| |
| static const xml_tool_call_format form = ([]() { |
| xml_tool_call_format form {}; |
| form.scope_start = "\n"; |
| form.tool_start = "<tool_call>\n{\"name\": \""; |
| form.tool_sep = "\", \"arguments\": {"; |
| form.key_start = "\""; |
| form.key_val_sep = "\": "; |
| form.val_end = ", "; |
| form.tool_end = "}\n</tool_call>"; |
| form.scope_end = ""; |
| form.raw_argval = false; |
| form.last_val_end = ""; |
| return form; |
| })(); |
| build_grammar_xml_tool_call(data, params.tools, form); |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_gpt_oss(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| |
| auto adjusted_messages = json::array(); |
| for (const auto & msg : inputs.messages) { |
| auto has_reasoning_content = msg.contains("reasoning_content") && msg.at("reasoning_content").is_string(); |
| auto has_tool_calls = msg.contains("tool_calls") && msg.at("tool_calls").is_array(); |
|
|
| if (has_reasoning_content && has_tool_calls) { |
| auto adjusted_message = msg; |
| adjusted_message["thinking"] = msg.at("reasoning_content"); |
| adjusted_message.erase("content"); |
| adjusted_messages.push_back(adjusted_message); |
| } else { |
| adjusted_messages.push_back(msg); |
| } |
| } |
|
|
| auto prompt = apply(tmpl, inputs, adjusted_messages); |
|
|
| |
| |
| |
| if (inputs.is_inference && !inputs.add_generation_prompt) { |
| static constexpr std::string_view return_token = "<|return|>"; |
| static constexpr std::string_view end_token = "<|end|>"; |
| if (size_t pos = prompt.rfind(return_token); pos != std::string::npos) { |
| prompt.replace(pos, return_token.length(), end_token); |
| } |
| } |
|
|
| data.prompt = prompt; |
| data.format = COMMON_CHAT_FORMAT_GPT_OSS; |
|
|
| |
| |
| data.preserved_tokens = { |
| "<|channel|>", |
| "<|constrain|>", |
| "<|message|>", |
| "<|start|>", |
| "<|end|>", |
| }; |
|
|
| if (!inputs.json_schema.is_null()) { |
| data.grammar_lazy = false; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| auto schema = inputs.json_schema; |
| builder.resolve_refs(schema); |
|
|
| auto not_end = builder.add_rule("not-end", |
| "[^<] | \"<\" [^|] | \"<|\" [^e] | \"<|e\" [^n] | \"<|en\" [^d] | \"<|end\" [^|] | \"<|end|\" [^>]"); |
| auto analysis = builder.add_rule("analysis", |
| "\"<|channel|>analysis<|message|>\" ( " + not_end + " )* \"<|end|>\""); |
| auto constraint = builder.add_rule("constraint", "\"<|constrain|>\"? [a-zA-Z0-9_-]+"); |
| auto final = builder.add_rule("final", |
| "\"<|channel|>final\" ( \" \" " + constraint + " )? \"<|message|>\" " + |
| builder.add_schema("response", schema) |
| ); |
|
|
| builder.add_rule("root", "( " + analysis + " \"<|start|>assistant\" )? " + final); |
| }); |
| } |
|
|
| if (inputs.tools.is_array() && !inputs.tools.empty()) { |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| |
| auto channel = builder.add_rule("channel", "\"<|channel|>\" ( \"commentary\" | \"analysis\" )"); |
|
|
| std::vector<std::string> tool_rules_recipient_in_role; |
| std::vector<std::string> tool_rules_recipient_in_channel; |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| auto parameters = function.at("parameters"); |
| builder.resolve_refs(parameters); |
|
|
| tool_rules_recipient_in_role.push_back( |
| builder.add_rule(name + "-call", |
| "\"" + name + "\"" + channel + " \" <|constrain|>json\"? \"<|message|>\" " + |
| builder.add_schema(name + "-args", parameters) |
| ) |
| ); |
|
|
| tool_rules_recipient_in_channel.push_back( |
| builder.add_rule(name + "-call", |
| "\"" + name + "\"" + " \" <|constrain|>json\"? \"<|message|>\" " + |
| builder.add_schema(name + "-args", parameters) |
| ) |
| ); |
| }); |
|
|
| auto recipient_in_channel = builder.add_rule("recipient_in_channel", |
| channel + " \" to=functions.\" ( " + |
| string_join(tool_rules_recipient_in_channel, " | ") + " )" |
| ); |
|
|
| if (data.grammar_lazy) { |
| auto recipient_in_role = builder.add_rule("recipient_in_role", |
| "\"<|start|>assistant\"? \" to=functions.\" ( " + |
| string_join(tool_rules_recipient_in_role, " | ") + " )" |
| ); |
|
|
| builder.add_rule("root", recipient_in_role + " | " + recipient_in_channel); |
| } else { |
| auto not_end = builder.add_rule("not-end", |
| "[^<] | \"<\" [^|] | \"<|\" [^e] | \"<|e\" [^n] | \"<|en\" [^d] | \"<|end\" [^|] | \"<|end|\" [^>]"); |
| auto analysis = builder.add_rule("analysis", |
| "\"<|channel|>analysis<|message|>\" ( " + not_end + " )* \"<|end|>\""); |
| auto commentary = builder.add_rule("commentary", |
| "\"<|channel|>commentary<|message|>\" ( " + not_end + " )* \"<|end|>\""); |
|
|
| auto recipient_in_role = builder.add_rule("recipient_in_role", |
| "\" to=functions.\" ( " + string_join(tool_rules_recipient_in_role, " | ") + " )" |
| ); |
|
|
| builder.add_rule("root", |
| "( " + analysis + " \"<|start|>assistant\" )? " + |
| "( " + commentary + " \"<|start|>assistant\" )? " + |
| "( " + recipient_in_role + " | " + recipient_in_channel + " )" |
| ); |
| } |
|
|
| |
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN, |
| "<\\|channel\\|>(?:commentary|analysis) to" |
| }); |
|
|
| |
| |
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL, |
| "^ to" |
| }); |
|
|
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN, |
| "<\\|start\\|>assistant to" |
| }); |
| }); |
| } |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_glm_4_5(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
| data.grammar_lazy = inputs.tools.is_array() && !inputs.tools.empty() && inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
|
|
| std::string prompt = apply(tmpl, inputs); |
|
|
| |
| if (inputs.add_bos && string_starts_with(prompt, tmpl.bos_token())) { |
| prompt.erase(0, tmpl.bos_token().size()); |
| } |
| if (inputs.add_eos && string_ends_with(prompt, tmpl.eos_token())) { |
| prompt.erase(prompt.size() - tmpl.eos_token().size()); |
| } |
| if (string_ends_with(prompt, "<think>")) { |
| if (!inputs.enable_thinking) { |
| prompt += "</think>"; |
| } else { |
| data.thinking_forced_open = true; |
| } |
| } |
|
|
| |
| data.preserved_tokens = { |
| "<|endoftext|>", |
| "[MASK]", |
| "[gMASK]", |
| "[sMASK]", |
| "<sop>", |
| "<eop>", |
| "<|system|>", |
| "<|user|>", |
| "<|assistant|>", |
| "<|observation|>", |
| "<|begin_of_image|>", |
| "<|end_of_image|>", |
| "<|begin_of_video|>", |
| "<|end_of_video|>", |
| "<|begin_of_audio|>", |
| "<|end_of_audio|>", |
| "<|begin_of_transcription|>", |
| "<|end_of_transcription|>", |
| "<|code_prefix|>", |
| "<|code_middle|>", |
| "<|code_suffix|>", |
| "/nothink", |
| "<think>", |
| "</think>", |
| "<tool_call>", |
| "</tool_call>", |
| "<arg_key>", |
| "</arg_key>", |
| "<arg_value>", |
| "</arg_value>" |
| }; |
|
|
| |
| data.additional_stops.insert(data.additional_stops.end(), { |
| "<|user|>", |
| "<|observation|>" |
| }); |
|
|
| |
| static const xml_tool_call_format form { |
| "", |
| "\n<tool_call>", |
| "\n", |
| "<arg_key>", |
| "</arg_key>\n<arg_value>", |
| "</arg_value>\n", |
| "</tool_call>\n", |
| "", |
| }; |
| build_grammar_xml_tool_call(data, inputs.tools, form); |
|
|
| data.prompt = prompt; |
| data.format = COMMON_CHAT_FORMAT_GLM_4_5; |
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_firefunction_v2(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| LOG_DBG("%s\n", __func__); |
| common_chat_params data; |
| const std::optional<json> additional_context = json { |
| {"datetime", format_time(inputs.now, "%b %d %Y %H:%M:%S GMT")}, |
| {"functions", json(inputs.tools.empty() ? "" : inputs.tools.dump(2))}, |
| }; |
| data.prompt = apply(tmpl, inputs, std::nullopt, std::nullopt, additional_context); |
| if (inputs.tools.is_array() && !inputs.tools.empty()) { |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| auto schemas = json::array(); |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| schemas.push_back({ |
| {"type", "object"}, |
| {"properties", { |
| {"name", { |
| {"type", "string"}, |
| {"const", function.at("name")}, |
| }}, |
| {"arguments", function.at("parameters")}, |
| }}, |
| {"required", json::array({"name", "arguments", "id"})}, |
| }); |
| }); |
| auto schema = json { |
| {"type", "array"}, |
| {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}}, |
| {"minItems", 1}, |
| }; |
| if (!inputs.parallel_tool_calls) { |
| schema["maxItems"] = 1; |
| } |
| builder.add_rule("root", "\" functools\"? " + builder.add_schema("tool_calls", schema)); |
| }); |
| data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, " functools["}); |
| data.preserved_tokens = { |
| " functools[", |
| }; |
| data.format = COMMON_CHAT_FORMAT_FIREFUNCTION_V2; |
| } else { |
| data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY; |
| } |
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_functionary_v3_2(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| |
| |
| |
| common_chat_params data; |
| data.prompt = apply(tmpl, inputs); |
| data.format = COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2; |
| if (inputs.tools.is_array() && !inputs.tools.empty()) { |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| std::vector<std::string> first_tool_rules; |
| std::vector<std::string> subsequent_tool_rules; |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| auto parameters = function.at("parameters"); |
| builder.resolve_refs(parameters); |
| std::string args_pattern = "[\\s\\S]*"; |
| auto args_rule = builder.add_schema(name + "-args", parameters); |
| if (name == "python") { |
| args_rule = builder.add_rule(name + "-maybe-raw-args", args_rule + " | [^{] .*"); |
| } else { |
| args_pattern = "\\{" + args_pattern; |
| } |
| auto call_rule = builder.add_rule(name + "-call", "\"" + name + "\\n\" " + args_rule); |
| first_tool_rules.push_back(call_rule); |
| if (inputs.parallel_tool_calls) { |
| subsequent_tool_rules.push_back(builder.add_rule(name + "-call2", "\">>>\" " + call_rule)); |
| } |
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL, |
| "((?:[\\s\\S]+?>>>)?" + regex_escape(name) + "\n)" + args_pattern, |
| }); |
| }); |
| data.preserved_tokens = { |
| "<|end_header_id|>", |
| }; |
| auto first_rule = first_tool_rules.empty() ? "" : builder.add_rule("first_tool_call", string_join(first_tool_rules, " | ")) + " space"; |
| if (inputs.parallel_tool_calls) { |
| auto subsequent_rule = builder.add_rule("subsequent_tool_call", string_join(subsequent_tool_rules, " | ")) + " space"; |
| builder.add_rule("root", first_rule + " (" + subsequent_rule + ")*"); |
| } else { |
| builder.add_rule("root", first_rule); |
| } |
|
|
| }); |
| } |
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_functionary_v3_1_llama_3_1(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| |
| common_chat_params data; |
|
|
| if (!inputs.tools.is_null()) { |
| std::string python_code_argument_name; |
| auto has_raw_python = false; |
|
|
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| std::vector<std::string> tool_rules; |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| const auto & parameters = function.at("parameters"); |
| std::string name = function.at("name"); |
| if (name == "python" || name == "ipython") { |
| if (!parameters.contains("type")) { |
| throw std::runtime_error("Missing type in python tool"); |
| } |
| has_raw_python = true; |
| const auto & type = parameters.at("type"); |
| if (type == "object") { |
| auto properties = parameters.at("properties"); |
| for (auto it = properties.begin(); it != properties.end(); ++it) { |
| if (it.value().at("type") == "string") { |
| if (!python_code_argument_name.empty()) { |
| throw std::runtime_error("Multiple string arguments found in python tool"); |
| } |
| python_code_argument_name = it.key(); |
| } |
| } |
| if (python_code_argument_name.empty()) { |
| throw std::runtime_error("No string argument found in python tool"); |
| } |
| } else if (type != "string") { |
| throw std::runtime_error("Invalid type in python tool: " + type.dump()); |
| } |
| } |
| tool_rules.push_back(builder.add_rule(name + "-call", "\"<function=" + name + ">\" " + builder.add_schema(name + "-args", parameters) + " \"</function>\" space")); |
| }); |
| if (has_raw_python) { |
| tool_rules.push_back(builder.add_rule("python-call", "\"<|python_tag|>\" .*")); |
| data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<|python_tag|>"}); |
| data.preserved_tokens.push_back("<|python_tag|>"); |
| } |
| auto tool_call = builder.add_rule("tool_call", string_join(tool_rules, " | ")) + " space"; |
| builder.add_rule("root", inputs.parallel_tool_calls ? "(" + tool_call + ")+" : tool_call); |
| data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<function="}); |
| }); |
| data.format = COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1; |
| } else { |
| data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY; |
| } |
|
|
| data.prompt = apply(tmpl, inputs); |
| |
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_hermes_2_pro(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| json extra_context = json { |
| {"enable_thinking", inputs.enable_thinking}, |
| }; |
| extra_context.update(inputs.extra_context); |
|
|
| data.prompt = apply(tmpl, inputs, std::nullopt, std::nullopt, extra_context); |
| data.format = COMMON_CHAT_FORMAT_HERMES_2_PRO; |
| if (string_ends_with(data.prompt, "<think>\n")) { |
| if (!extra_context["enable_thinking"]) { |
| data.prompt += "</think>"; |
| } else { |
| data.thinking_forced_open = true; |
| } |
| } |
|
|
| if (!inputs.tools.is_null()) { |
| |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| std::vector<std::string> tool_rules; |
| std::vector<std::string> tool_call_alts; |
| std::vector<std::string> escaped_names; |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| auto parameters = function.at("parameters"); |
| builder.resolve_refs(parameters); |
| tool_rules.push_back(builder.add_schema(name + "-call", { |
| {"type", "object"}, |
| {"properties", json { |
| {"name", json {{"const", name}}}, |
| {"arguments", parameters}, |
| }}, |
| {"required", json::array({"name", "arguments"})}, |
| })); |
| tool_call_alts.push_back(builder.add_rule( |
| name + "-function-tag", |
| "\"<function\" ( \"=" + name + "\" | \" name=\\\"" + name + "\\\"\" ) \">\" space " + |
| builder.add_schema(name + "-args", parameters) + " " |
| "\"</function>\" space")); |
|
|
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_WORD, |
| "<function=" + name + ">", |
| }); |
| auto escaped_name = regex_escape(name); |
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN, |
| "<function\\s+name\\s*=\\s*\"" + escaped_name + "\"", |
| }); |
| escaped_names.push_back(escaped_name); |
| }); |
| auto any_tool_call = builder.add_rule("any_tool_call", "( " + string_join(tool_rules, " | ") + " ) space"); |
| std::vector<std::string> alt_tags { |
| any_tool_call, |
| "\"<tool_call>\" space " + any_tool_call + " \"</tool_call>\"", |
| |
| "\"<function_call>\" space " + any_tool_call + " \"</function_call>\"", |
| "\"<response>\" space " + any_tool_call + " \"</response>\"", |
| "\"<tools>\" space " + any_tool_call + " \"</tools>\"", |
| "\"<json>\" space " + any_tool_call + " \"</json>\"", |
| "\"<xml>\" space " + any_tool_call + " \"</xml>\"", |
| "\"<JSON>\" space " + any_tool_call + " \"</JSON>\"", |
| }; |
| auto wrappable_tool_call = builder.add_rule("wrappable_tool_call", "( " + string_join(alt_tags, " | ") + " ) space"); |
| tool_call_alts.push_back(wrappable_tool_call); |
| tool_call_alts.push_back( |
| "( \"```\\n\" | \"```json\\n\" | \"```xml\\n\" ) space " + wrappable_tool_call + " space \"```\" space "); |
| auto tool_call = builder.add_rule("tool_call", string_join(tool_call_alts, " | ")); |
| builder.add_rule("root", |
| std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") + |
| (inputs.parallel_tool_calls ? "(" + tool_call + ")+" : tool_call)); |
| |
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN, |
| |
| |
| std::string(data.thinking_forced_open ? "(</think>\\s*)" : "") + ( |
| "\\s*(" |
| "(?:<tool_call>" |
| "|<function" |
| "|(?:```(?:json|xml)?\n\\s*)?(?:<function_call>|<tools>|<xml><json>|<response>)?" |
| "\\s*\\{\\s*\"name\"\\s*:\\s*\"(?:" + string_join(escaped_names, "|") + ")\"" |
| ")" |
| ")" |
| ), |
| }); |
| data.preserved_tokens = { |
| "<think>", |
| "</think>", |
| "<tool_call>", |
| "</tool_call>", |
| "<function", |
| "<tools>", |
| "</tools>", |
| "<response>", |
| "</response>", |
| "<function_call>", |
| "</function_call>", |
| "<json>", |
| "</json>", |
| "<JSON>", |
| "</JSON>", |
| "```", |
| "```json", |
| "```xml", |
| }; |
| }); |
| } |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_granite(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| |
| json additional_context = { |
| {"thinking", inputs.enable_thinking}, |
| }; |
|
|
| data.prompt = apply(tmpl, inputs, std::nullopt, std::nullopt, additional_context); |
| data.format = COMMON_CHAT_FORMAT_GRANITE; |
|
|
| if (string_ends_with(data.prompt, "<think>\n") || string_ends_with(data.prompt, "<think>")) { |
| if (!inputs.enable_thinking) { |
| data.prompt += "</think>"; |
| } else { |
| data.thinking_forced_open = true; |
| } |
| } |
|
|
| if (!inputs.tools.is_null()) { |
| |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| std::vector<std::string> tool_rules; |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| auto parameters = function.at("parameters"); |
| builder.resolve_refs(parameters); |
| tool_rules.push_back(builder.add_rule(name + "-call", builder.add_schema(name + |
| "-args", { |
| {"type", "object"}, |
| {"properties", { |
| {"name", {{"const", name}}}, |
| {"arguments", parameters}, |
| }}, |
| {"required", json::array({"name", "arguments"})}, |
| }))); |
| }); |
|
|
| auto tool_call = builder.add_rule("tool_call", string_join(tool_rules, " | ")); |
| auto tool_list = builder.add_rule("tool_list", "\"[\" space " + tool_call + " (\",\" space " + tool_call + ")* space \"]\""); |
|
|
| if (data.thinking_forced_open) { |
| builder.add_rule("root", "\"</think>\" space \"<response>\" space [^<]* \"</response>\" space \"<|tool_call|>\" space " + tool_list); |
| } else { |
| builder.add_rule("root", "\"<|tool_call|>\" space " + tool_list); |
| } |
|
|
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_WORD, |
| "<|tool_call|>" |
| }); |
|
|
| data.preserved_tokens = { |
| "<think>", |
| "</think>", |
| "<response>", |
| "</response>", |
| "<|tool_call|>", |
| }; |
| }); |
| } else { |
| |
| if (data.thinking_forced_open && inputs.enable_thinking) { |
| data.grammar_lazy = false; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| builder.add_rule("root", "\"</think>\" space \"<response>\" space .* \"</response>\" space"); |
| }); |
| data.preserved_tokens = { |
| "<think>", |
| "</think>", |
| "<response>", |
| "</response>", |
| }; |
| } |
| } |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_solar_open(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| |
| auto adjusted_messages = json::array(); |
| for (const auto & msg : inputs.messages) { |
| if (msg.contains("reasoning_content") && msg.at("reasoning_content").is_string()) { |
| auto adjusted_message = msg; |
| adjusted_message["reasoning"] = msg.at("reasoning_content"); |
| adjusted_message.erase("reasoning_content"); |
| adjusted_messages.push_back(adjusted_message); |
| } else { |
| adjusted_messages.push_back(msg); |
| } |
| } |
|
|
| auto has_tools = inputs.tools.is_array() && !inputs.tools.empty(); |
| auto include_grammar = true; |
|
|
| auto prompt = apply(tmpl, inputs, adjusted_messages); |
|
|
| |
| if (inputs.is_inference && !inputs.add_generation_prompt) { |
| static constexpr std::string_view return_token = "<|flush|>"; |
| static constexpr std::string_view end_token = "<|end|>"; |
| if (size_t pos = prompt.rfind(return_token); pos != std::string::npos) { |
| prompt.replace(pos, return_token.length(), end_token); |
| } |
| } |
|
|
| data.prompt = prompt; |
| data.format = COMMON_CHAT_FORMAT_PEG_NATIVE; |
| data.preserved_tokens = { |
| "<|think|>", |
| "<|content|>", |
| "<|begin|>", |
| "<|end|>", |
| "<|tool_calls|>", |
| "<|tool_call:begin|>", |
| "<|tool_call:end|>", |
| "<|tool_call:name|>", |
| "<|tool_call:args|>", |
| }; |
|
|
| auto parser = build_chat_peg_native_parser([&](common_chat_peg_native_builder & p) { |
| auto lit_think = p.atomic(p.literal("<|think|>")); |
| auto lit_assistant_begin = p.atomic(p.literal("<|begin|>assistant")); |
| auto lit_content = p.atomic(p.literal("<|content|>")); |
| auto lit_end = p.atomic(p.literal("<|end|>")); |
| auto parser_until_end = p.until("<|end|>"); |
|
|
| |
| auto parser_reasoning = p.rule("reasoning", lit_think + p.reasoning(parser_until_end)); |
|
|
| |
| auto parser_content = p.rule("content", lit_content + p.content(parser_until_end)); |
|
|
| |
| |
| |
| auto wrap_choice = [&](const std::vector<common_peg_parser> & items) { |
| auto choice = p.choice(items); |
| return choice + p.zero_or_more(lit_end + lit_assistant_begin + choice); |
| }; |
|
|
| |
| auto wrap_seq = [&](const std::vector<common_peg_parser> & items) { |
| auto seq = p.sequence(); |
| for (auto i = 0u; i < items.size(); i++) { |
| if (i == 0) { |
| seq += items[i]; |
| continue; |
| } |
| seq += lit_end + lit_assistant_begin + items[i]; |
| } |
| return seq; |
| }; |
|
|
| |
| if (inputs.json_schema.is_object() && !inputs.json_schema.empty()) { |
| auto parser_response_format = lit_content + p.content(p.schema(p.json(), "response-format", inputs.json_schema)); |
| return p.choice({ |
| wrap_seq({parser_reasoning, parser_response_format}), |
| wrap_seq({parser_response_format}) |
| }); |
| } |
|
|
| auto lit_tool_call_begin = p.literal("<|tool_call:begin|>"); |
| auto lit_tool_call_name = p.literal("<|tool_call:name|>"); |
| auto lit_tool_call_args = p.literal("<|tool_call:args|>"); |
| auto lit_tool_call_end = p.literal("<|tool_call:end|>"); |
|
|
| |
| if (has_tools && inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_NONE) { |
| auto parser_tool_call = p.choice(); |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| const auto & schema = function.at("parameters"); |
|
|
| |
| parser_tool_call |= p.rule("tool-" + name, |
| p.atomic(p.tool_name(p.literal(name)) + lit_tool_call_args) |
| + p.tool_args(p.schema(p.json(), "tool-" + name + "-schema", schema))); |
| }); |
|
|
| auto min_calls = inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_REQUIRED ? 1 : 0; |
| auto max_calls = inputs.parallel_tool_calls ? -1 : 1; |
|
|
| |
| |
| |
| |
| auto parser_tool_calls = p.trigger_rule("tool-calls", |
| p.atomic(p.literal("<|tool_calls|>")) |
| + p.repeat( |
| p.tool_open( |
| lit_tool_call_begin |
| + p.tool_id(p.chars("[a-zA-Z0-9_-]", 1, -1)) |
| + lit_tool_call_name |
| + p.peek(p.chars("[^<]", 1, -1) + lit_tool_call_args)) |
| + parser_tool_call |
| + p.tool_close(lit_tool_call_end), |
| 1, |
| max_calls)); |
|
|
| if (min_calls == 1) { |
| |
| return p.choice({ |
| wrap_seq({parser_reasoning, parser_content, parser_tool_calls}), |
| wrap_seq({parser_reasoning, parser_tool_calls}), |
| wrap_seq({parser_content, parser_tool_calls}), |
| wrap_seq({parser_tool_calls}) |
| }); |
| } |
|
|
| return wrap_choice({parser_reasoning, parser_content, parser_tool_calls}); |
| } |
|
|
| |
| include_grammar = false; |
| return wrap_choice({parser_reasoning, parser_content}); |
| }); |
|
|
| data.parser = parser.save(); |
|
|
| if (include_grammar) { |
| data.grammar_lazy = has_tools && inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_AUTO; |
|
|
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| auto schema = function.at("parameters"); |
| builder.resolve_refs(schema); |
| }); |
| parser.build_grammar(builder, data.grammar_lazy); |
| }); |
|
|
| data.grammar_triggers = { |
| {COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<|tool_calls|>"} |
| }; |
| } |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_exaone_moe(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| data.prompt = apply(tmpl, inputs); |
| data.format = COMMON_CHAT_FORMAT_EXAONE_MOE; |
| if (string_ends_with(data.prompt, "<think>\n")) { |
| if (!inputs.enable_thinking) { |
| data.prompt += "</think>\n\n"; |
| } else { |
| data.thinking_forced_open = true; |
| } |
| } |
|
|
| if (inputs.tools.is_array() && !inputs.tools.empty()) { |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED && inputs.json_schema.is_null(); |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| std::vector<std::string> tool_rules; |
| foreach_function(inputs.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| auto parameters = function.at("parameters"); |
| builder.resolve_refs(parameters); |
| |
| tool_rules.push_back(builder.add_rule( |
| name + "-call", |
| "\"<tool_call>\" space " + |
| builder.add_schema(name + "-obj", json{ |
| {"type", "object"}, |
| {"properties", { |
| {"name", json{{"const", name}}}, |
| {"arguments", parameters}, |
| }}, |
| {"required", json::array({"name", "arguments"})}, |
| }) + |
| " space \"</tool_call>\" space")); |
| }); |
|
|
| auto tool_call = builder.add_rule("tool_call", string_join(tool_rules, " | ")); |
| builder.add_rule("root", |
| std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") + |
| (inputs.parallel_tool_calls ? "(" + tool_call + ")+" : tool_call)); |
|
|
| data.grammar_triggers.push_back({ |
| COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL, |
| std::string(data.thinking_forced_open ? "[\\s\\S]*?(</think>\\s*)?" : "") + |
| "(<tool_call>)[\\s\\S]*" |
| }); |
| data.preserved_tokens = { |
| "<think>", |
| "</think>", |
| "<tool_call>", |
| "</tool_call>", |
| }; |
| }); |
| } |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_translate_gemma(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
|
|
| |
| |
|
|
| templates_params inputs_new = inputs; |
| json & messages = inputs_new.messages; |
|
|
| |
| std::string default_src_lang = inputs.extra_context.value("source_lang_code", "en-GB"); |
| std::string default_tgt_lang = inputs.extra_context.value("target_lang_code", "en-GB"); |
|
|
| GGML_ASSERT(messages.is_array()); |
| for (auto & message : messages) { |
| if (message.contains("role") && message["role"].get<std::string>() != "user") { |
| continue; |
| } |
| if (!message.contains("content")) { |
| message["content"] = json::array(); |
| } |
| if (message.contains("content") && !message["content"].is_array()) { |
| auto content_str = message["content"].get<std::string>(); |
| |
| auto src_lang = message.contains("source_lang_code") |
| ? message["source_lang_code"].get<std::string>() : default_src_lang; |
| auto tgt_lang = message.contains("target_lang_code") |
| ? message["target_lang_code"].get<std::string>() : default_tgt_lang; |
| message["content"] = json::array({ |
| json{ |
| {"type", "text"}, |
| {"text", content_str}, |
| {"source_lang_code", src_lang}, |
| {"target_lang_code", tgt_lang}, |
| } |
| }); |
| } |
| } |
|
|
| data.prompt = apply(tmpl, inputs_new, std::nullopt, std::nullopt); |
| data.format = COMMON_CHAT_FORMAT_GENERIC; |
|
|
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_without_tools(const common_chat_template & tmpl, const struct templates_params & inputs) { |
| common_chat_params data; |
| data.prompt = apply(tmpl, inputs); |
| data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY; |
| data.grammar_lazy = false; |
| if (!inputs.json_schema.is_null()) { |
| if (!inputs.grammar.empty()) { |
| throw std::runtime_error("Either \"json_schema\" or \"grammar\" can be specified, but not both"); |
| } |
| data.grammar = json_schema_to_grammar(inputs.json_schema); |
| } else { |
| data.grammar = inputs.grammar; |
| } |
| return data; |
| } |
|
|
| static common_chat_params common_chat_params_init_seed_oss( |
| const common_chat_template & tmpl, |
| templates_params & params, |
| const common_chat_templates_inputs & inputs) |
| { |
| common_chat_params data; |
| data.prompt = apply(tmpl, params); |
| data.format = COMMON_CHAT_FORMAT_SEED_OSS; |
| if (string_ends_with(data.prompt, "<seed:think>")) { |
| if (!inputs.enable_thinking) { |
| data.prompt += "</seed:think>"; |
| } else { |
| data.thinking_forced_open = true; |
| } |
| } |
|
|
| if (params.tools.is_array() && !params.tools.empty()) { |
| data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED; |
| data.grammar = build_grammar([&](const common_grammar_builder & builder) { |
| std::vector<std::string> tool_rules; |
| foreach_function(params.tools, [&](const json & tool) { |
| const auto & function = tool.at("function"); |
| std::string name = function.at("name"); |
| auto parameters = function.at("parameters"); |
| builder.resolve_refs(parameters); |
|
|
| |
| std::string param_rules; |
| if (parameters.contains("properties")) { |
| for (const auto & [key, value] : parameters.at("properties").items()) { |
| param_rules += "\"<parameter=" + key + ">\"" + builder.add_schema(name + "-arg-" + key, value) + |
| "\"</parameter>\""; |
| } |
| } |
|
|
| tool_rules.push_back(builder.add_rule(name + "-call", |
| "\"<seed:tool_call>\" space \"<function=" + name + ">\" space " + |
| param_rules + |
| " \"</function>\" space \"</seed:tool_call>\"")); |
| }); |
|
|
| data.grammar_triggers.push_back({ COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<seed:tool_call>" }); |
|
|
| data.preserved_tokens = { |
| "<seed:think>", "</seed:think>", "<seed:tool_call>", "</seed:tool_call>", |
| "<function=", "</function>", "<parameter=", "</parameter>", |
| }; |
|
|
| builder.add_rule("root", string_join(tool_rules, " | ")); |
| }); |
| } |
| return data; |
| } |
|
|
| |
| |
| namespace workaround { |
|
|
| |
| static void system_message_not_supported(json & messages) { |
| if (!messages.empty() && messages.front().at("role") == "system") { |
| if (messages.size() > 1) { |
| LOG_DBG("Merging system prompt into next message\n"); |
| auto & first_msg = messages.front(); |
| auto & second_msg = messages[1]; |
| second_msg["content"] = first_msg.at("content").get<std::string>() |
| + "\n" + second_msg.at("content").get<std::string>(); |
| messages.erase(messages.begin()); |
| } else { |
| LOG_WRN("Removing system prompt due to template not supporting system role\n"); |
| messages.erase(messages.begin()); |
| } |
| } |
| } |
|
|
| static void func_args_not_string(json & messages) { |
| GGML_ASSERT(messages.is_array()); |
| for (auto & message : messages) { |
| if (message.contains("tool_calls")) { |
| for (auto & tool_call : message["tool_calls"]) { |
| if (tool_call.contains("function") && tool_call["function"].contains("arguments")) { |
| auto & args = tool_call["function"]["arguments"]; |
| if (args.is_string()) { |
| try { |
| args = json::parse(args.get<std::string>()); |
| } catch (const std::exception & e) { |
| throw std::runtime_error("Failed to parse tool call arguments as JSON: " + std::string(e.what())); |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
|
|
| static void move_tool_calls_to_content(json & messages, int indent_spaces = 2) { |
| GGML_ASSERT(messages.is_array()); |
| for (auto & message : messages) { |
| if (message.contains("tool_calls")) { |
| auto tool_calls_new = json{ |
| {"tool_calls", message.at("tool_calls")} |
| }; |
| message.erase("tool_calls"); |
| auto content = message.at("content"); |
| std::string content_new = content.is_null() ? "" : content.get<std::string>(); |
| message["content"] = content_new + tool_calls_new.dump(indent_spaces, ' ', false, json::error_handler_t::replace); |
| } |
| } |
| } |
|
|
| |
| static void use_generic_schema(json & messages) { |
| GGML_ASSERT(messages.is_array()); |
| for (auto & message : messages) { |
| if (message.contains("tool_calls") && message.at("tool_calls").is_array()) { |
| auto & tool_calls = message.at("tool_calls"); |
| for (auto & tool_call : tool_calls) { |
| if (tool_call.contains("type") && tool_call.at("type") == "function" && |
| tool_call.contains("function") && tool_call.at("function").is_object()) { |
| |
| json name_value; |
| json arguments_value; |
| json id_value; |
| const auto & function = tool_call.at("function"); |
| if (function.contains("name")) { |
| name_value = function.at("name"); |
| } |
| if (function.contains("arguments")) { |
| arguments_value = function.at("arguments"); |
| } |
| if (tool_call.contains("id")) { |
| id_value = tool_call.at("id"); |
| } |
| |
| tool_call.erase("type"); |
| tool_call.erase("function"); |
| tool_call.erase("id"); |
| |
| if (!name_value.is_null()) { |
| tool_call["name"] = name_value; |
| } |
| if (!arguments_value.is_null()) { |
| tool_call["arguments"] = arguments_value; |
| } |
| if (!id_value.is_null()) { |
| tool_call["id"] = id_value; |
| } |
| } |
| } |
| } |
| } |
| } |
|
|
| } |
|
|
| static common_chat_params common_chat_templates_apply_jinja( |
| const struct common_chat_templates * tmpls, |
| const struct common_chat_templates_inputs & inputs) |
| { |
| templates_params params; |
| params.tools = common_chat_tools_to_json_oaicompat(inputs.tools); |
| const auto & tmpl = params.tools.is_array() && tmpls->template_tool_use |
| ? *tmpls->template_tool_use |
| : *tmpls->template_default; |
| const auto & src = tmpl.source(); |
| const auto & caps = tmpl.original_caps(); |
| params.messages = render_message_to_json(inputs.messages, tmpl.original_caps()); |
| params.add_generation_prompt = inputs.add_generation_prompt; |
| params.tool_choice = inputs.tool_choice; |
| params.reasoning_format = inputs.reasoning_format; |
| params.enable_thinking = inputs.enable_thinking; |
| params.grammar = inputs.grammar; |
| params.now = inputs.now; |
| params.add_bos = tmpls->add_bos; |
| params.add_eos = tmpls->add_eos; |
|
|
| if (!tmpl.original_caps().supports_system_role) { |
| workaround::system_message_not_supported(params.messages); |
| } |
|
|
| params.extra_context = json::object(); |
| for (auto el : inputs.chat_template_kwargs) { |
| params.extra_context[el.first] = json::parse(el.second); |
| } |
|
|
| if (!inputs.json_schema.empty()) { |
| params.json_schema = json::parse(inputs.json_schema); |
| } |
|
|
| if (inputs.parallel_tool_calls && !tmpl.original_caps().supports_parallel_tool_calls) { |
| LOG_DBG("Disabling parallel_tool_calls because the template does not support it\n"); |
| params.parallel_tool_calls = false; |
| } else { |
| params.parallel_tool_calls = inputs.parallel_tool_calls; |
| } |
|
|
| if (params.tools.is_array()) { |
| if (params.tool_choice != COMMON_CHAT_TOOL_CHOICE_NONE && !params.grammar.empty()) { |
| throw std::runtime_error("Cannot specify grammar with tools"); |
| } |
| if (caps.supports_tool_calls && !caps.supports_tools) { |
| LOG_WRN("Template supports tool calls but does not natively describe tools. The fallback behaviour used may produce bad results, inspect prompt w/ --verbose & consider overriding the template.\n"); |
| } |
| } |
|
|
| |
| if (src.find("message['prefix'] is defined and message['prefix'] and thinking") != std::string::npos && |
| params.json_schema.is_null()) { |
| return common_chat_params_init_deepseek_v3_1(tmpl, params); |
| } |
|
|
| |
| if (src.find("<|tool▁calls▁begin|>") != std::string::npos && params.json_schema.is_null()) { |
| return common_chat_params_init_deepseek_r1(tmpl, params); |
| } |
|
|
| |
| if (src.find("<|END_THINKING|><|START_ACTION|>") != std::string::npos && params.json_schema.is_null()) { |
| workaround::func_args_not_string(params.messages); |
| return common_chat_params_init_command_r7b(tmpl, params); |
| } |
|
|
| |
| if (src.find("elif thinking") != std::string::npos && src.find("<|tool_call|>") != std::string::npos) { |
| workaround::func_args_not_string(params.messages); |
| workaround::use_generic_schema(params.messages); |
| workaround::move_tool_calls_to_content(params.messages); |
| return common_chat_params_init_granite(tmpl, params); |
| } |
|
|
| |
| if (src.find("[gMASK]<sop>") != std::string::npos && |
| src.find("<arg_key>") != std::string::npos && |
| src.find("<arg_value>") != std::string::npos && |
| params.json_schema.is_null()) { |
| workaround::func_args_not_string(params.messages); |
| if (!params.extra_context.contains("clear_thinking")) { |
| |
| params.extra_context["clear_thinking"] = false; |
| } |
| return common_chat_params_init_glm_4_5(tmpl, params); |
| } |
|
|
| |
| |
| |
| if (src.find("<tool_call>") != std::string::npos && |
| src.find("<function=") != std::string::npos && |
| src.find("<parameter=") != std::string::npos) { |
| workaround::func_args_not_string(params.messages); |
| return common_chat_params_init_qwen3_coder(tmpl, params); |
| } |
|
|
| |
| if (src.find("<tools>") != std::string::npos && |
| src.find("# Tools") != std::string::npos && |
| src.find("</tools>") != std::string::npos && |
| src.find("<tool_calls>") != std::string::npos && |
| src.find("</tool_calls>") != std::string::npos && |
| src.find("<tool_response>") != std::string::npos) { |
| return common_chat_params_init_xiaomi_mimo(tmpl, params); |
| } |
|
|
| |
| if (src.find("<tool_call>") != std::string::npos && |
| src.find("<tool_result>") != std::string::npos && |
| src.find("<|tool_declare|>") != std::string::npos) { |
| return common_chat_params_init_exaone_moe(tmpl, params); |
| } |
|
|
| |
| if (src.find("<tool_call>") != std::string::npos && params.json_schema.is_null()) { |
| return common_chat_params_init_hermes_2_pro(tmpl, params); |
| } |
|
|
| |
| if (src.find("<|channel|>") != std::string::npos) { |
| return common_chat_params_init_gpt_oss(tmpl, params); |
| } |
|
|
| |
| if (src.find("<seed:think>") != std::string::npos) { |
| workaround::func_args_not_string(params.messages); |
| return common_chat_params_init_seed_oss(tmpl, params, inputs); |
| } |
|
|
| |
| if (src.find("<SPECIAL_10>") != std::string::npos) { |
| return common_chat_params_init_nemotron_v2(tmpl, params); |
| } |
|
|
| |
| if (src.find("<|system_start|>") != std::string::npos && src.find("<|tools_prefix|>") != std::string::npos) { |
| return common_chat_params_init_apertus(tmpl, params); |
| } |
|
|
| |
| if (src.find("List of tools: <|tool_list_start|>[") != std::string::npos && |
| src.find("]<|tool_list_end|>") != std::string::npos) { |
| return common_chat_params_init_lfm2(tmpl, params); |
| } |
|
|
| |
| if (src.find("]~!b[") != std::string::npos && src.find("]~b]") != std::string::npos) { |
| workaround::func_args_not_string(params.messages); |
| return common_chat_params_init_minimax_m2(tmpl, params); |
| } |
|
|
| |
| if (src.find("<|im_system|>tool_declare<|im_middle|>") != std::string::npos && |
| src.find("<|tool_calls_section_begin|>") != std::string::npos && |
| src.find("## Return of") != std::string::npos) { |
| return common_chat_params_init_kimi_k2(tmpl, params); |
| } |
|
|
| |
| if (src.find("<thinking>") != std::string::npos && |
| src.find("</thinking>") != std::string::npos && |
| src.find("<available_tools>") != std::string::npos && |
| src.find("<|assistant|>") != std::string::npos && |
| src.find("<|tool_result|>") != std::string::npos && |
| src.find("<tool_calls>[") != std::string::npos && |
| src.find("]</tool_calls>") != std::string::npos) { |
| return common_chat_params_init_apriel_1_5(tmpl, params); |
| } |
|
|
| |
| if (src.find("<|tool_response:begin|>") != std::string::npos && |
| src.find("<|tool_response:name|>") != std::string::npos && |
| src.find("<|tool_response:result|>") != std::string::npos) { |
| return common_chat_params_init_solar_open(tmpl, params); |
| } |
|
|
| |
| |
| if ((params.tools.is_array() && params.json_schema.is_object())) { |
| return common_chat_params_init_generic(tmpl, params); |
| } |
|
|
| |
| if (src.find(">>>all") != std::string::npos) { |
| return common_chat_params_init_functionary_v3_2(tmpl, params); |
| } |
|
|
| |
| if (src.find(" functools[") != std::string::npos) { |
| return common_chat_params_init_firefunction_v2(tmpl, params); |
| } |
|
|
| |
| if (src.find("<|start_header_id|>") != std::string::npos |
| && src.find("<function=") != std::string::npos) { |
| return common_chat_params_init_functionary_v3_1_llama_3_1(tmpl, params); |
| } |
|
|
| |
| if (src.find("<|start_header_id|>ipython<|end_header_id|>") != std::string::npos) { |
| auto allow_python_tag_builtin_tools = src.find("<|python_tag|>") != std::string::npos; |
| workaround::func_args_not_string(params.messages); |
| return common_chat_params_init_llama_3_x(tmpl, params, allow_python_tag_builtin_tools); |
| } |
|
|
| |
| if (src.find("[SYSTEM_PROMPT]") != std::string::npos && |
| src.find("[TOOL_CALLS]") != std::string::npos && |
| src.find("[ARGS]") != std::string::npos) { |
| return common_chat_params_init_ministral_3(tmpl, params); |
| } |
|
|
| if (src.find("[THINK]") != std::string::npos && src.find("[/THINK]") != std::string::npos) { |
| return common_chat_params_init_magistral(tmpl, params); |
| } |
|
|
| |
| if (src.find("<|tool_response:begin|>") != std::string::npos && |
| src.find("<|tool_response:name|>") != std::string::npos && |
| src.find("<|tool_response:result|>") != std::string::npos) { |
| return common_chat_params_init_solar_open(tmpl, params); |
| } |
|
|
| |
| if (src.find("[source_lang_code]") != std::string::npos && |
| src.find("[target_lang_code]") != std::string::npos) { |
| return common_chat_params_init_translate_gemma(tmpl, params); |
| } |
|
|
| |
| if (params.tools.is_null() || inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_NONE) { |
| return common_chat_params_init_without_tools(tmpl, params); |
| } |
|
|
| |
| if (src.find("[TOOL_CALLS]") != std::string::npos) { |
| workaround::func_args_not_string(params.messages); |
| return common_chat_params_init_mistral_nemo(tmpl, params); |
| } |
|
|
| |
| workaround::func_args_not_string(params.messages); |
| workaround::use_generic_schema(params.messages); |
| workaround::move_tool_calls_to_content(params.messages); |
| return common_chat_params_init_generic(tmpl, params); |
| } |
|
|
| |
| static common_chat_params common_chat_templates_apply_legacy( |
| const struct common_chat_templates * tmpls, |
| const struct common_chat_templates_inputs & inputs) |
| { |
| size_t alloc_size = 0; |
| std::vector<llama_chat_message> chat; |
| std::vector<std::string> contents; |
|
|
| for (const auto & msg : inputs.messages) { |
| auto content = msg.content; |
| for (const auto & part : msg.content_parts) { |
| if (part.type != "text" && part.type != "media_marker") { |
| LOG_WRN("Ignoring non-text content part: %s\n", part.type.c_str()); |
| continue; |
| } |
| if (!content.empty()) { |
| content += "\n";; |
| } |
| content += part.text; |
| } |
| contents.emplace_back(std::move(content)); |
| } |
| for (size_t i = 0; i < contents.size(); ++i) { |
| const auto & msg = inputs.messages[i]; |
| const auto & content = contents[i]; |
| chat.push_back({msg.role.c_str(), content.c_str()}); |
| size_t msg_size = msg.role.size() + content.size(); |
| alloc_size += msg_size + (msg_size / 4); |
| } |
|
|
| std::vector<char> buf(alloc_size); |
|
|
| |
| const auto & src = tmpls->template_default->source(); |
| int32_t res = llama_chat_apply_template(src.c_str(), chat.data(), chat.size(), inputs.add_generation_prompt, buf.data(), buf.size()); |
|
|
| |
| if (res < 0) { |
| |
| |
| throw std::runtime_error("this custom template is not supported, try using --jinja"); |
| } |
|
|
| |
| if ((size_t) res > buf.size()) { |
| buf.resize(res); |
| res = llama_chat_apply_template(src.c_str(), chat.data(), chat.size(), inputs.add_generation_prompt, buf.data(), buf.size()); |
| } |
|
|
| |
| if (res < 0 || (size_t) res > buf.size()) { |
| throw std::runtime_error("failed to apply chat template, try using --jinja"); |
| } |
|
|
| common_chat_params params; |
| params.prompt = std::string(buf.data(), res); |
| if (!inputs.json_schema.empty()) { |
| params.grammar = json_schema_to_grammar(json::parse(inputs.json_schema)); |
| } else { |
| params.grammar = inputs.grammar; |
| } |
| return params; |
| } |
|
|
| common_chat_params common_chat_templates_apply( |
| const struct common_chat_templates * tmpls, |
| const struct common_chat_templates_inputs & inputs) |
| { |
| GGML_ASSERT(tmpls != nullptr); |
| return inputs.use_jinja |
| ? common_chat_templates_apply_jinja(tmpls, inputs) |
| : common_chat_templates_apply_legacy(tmpls, inputs); |
| } |
|
|
| std::map<std::string, bool> common_chat_templates_get_caps(const common_chat_templates * chat_templates) { |
| GGML_ASSERT(chat_templates != nullptr); |
| GGML_ASSERT(chat_templates->template_default != nullptr); |
| return chat_templates->template_default->caps.to_map(); |
| } |
|
|