mirror of
https://github.com/ggerganov/llama.cpp.git
synced 2025-04-14 18:46:08 +00:00
669912d9a5
* sampler: turn lazy grammar trigger words to regexes * add scripts/tool_bench.sh & .py * constrain llama json output regardless of function name if matches at beginning * update relaxed newline space rule in grammar tests * support add_generation_prompt query parameter (useful for /apply_template) * Update src/llama-grammar.cpp Co-authored-by: Georgi Gerganov <ggerganov@gmail.com> --------- Co-authored-by: Georgi Gerganov <ggerganov@gmail.com>
946 lines
40 KiB
C++
946 lines
40 KiB
C++
// Tests chat handling, including grammar generation and parsing for tool calling, for various templates.
|
||
//
|
||
// Also acts as a CLI to generate a Markdown summary of the formats of Jinja templates,
|
||
// e.g. given Minja (http://github.com/google/minja) checked out in parent dir:
|
||
//
|
||
// cmake -B build && cmake --build build --parallel && ./build/bin/test-chat ../minja/build/tests/*.jinja 2>/dev/null
|
||
//
|
||
#include <fstream>
|
||
#include <iostream>
|
||
#include <json.hpp>
|
||
#include <string>
|
||
|
||
#include "chat.h"
|
||
#include "llama-grammar.h"
|
||
#include "unicode.h"
|
||
|
||
using json = nlohmann::ordered_json;
|
||
|
||
|
||
template <class T> static void assert_equals(const T & expected, const T & actual) {
|
||
if (expected != actual) {
|
||
std::cerr << "Expected: " << expected << std::endl;
|
||
std::cerr << "Actual: " << actual << std::endl;
|
||
std::cerr << std::flush;
|
||
throw std::runtime_error("Test failed");
|
||
}
|
||
}
|
||
|
||
static std::string read_file(const std::string & path) {
|
||
std::cerr << "# Reading: " << path << '\n' << std::flush;
|
||
std::ifstream fs(path, std::ios_base::binary);
|
||
if (!fs.is_open()) {
|
||
fs = std::ifstream("../" + path, std::ios_base::binary);
|
||
if (!fs.is_open()) {
|
||
throw std::runtime_error("Failed to open file: " + path);
|
||
}
|
||
}
|
||
fs.seekg(0, std::ios_base::end);
|
||
auto size = fs.tellg();
|
||
fs.seekg(0);
|
||
std::string out;
|
||
out.resize(static_cast<size_t>(size));
|
||
fs.read(out.data(), static_cast<std::streamsize>(size));
|
||
return out;
|
||
}
|
||
|
||
static common_chat_templates_ptr read_templates(const std::string & path) {
|
||
return common_chat_templates_ptr(common_chat_templates_init(/* model= */ nullptr, read_file(path)));
|
||
}
|
||
|
||
static std::unique_ptr<llama_grammar> build_grammar(const std::string & grammar_str) {
|
||
return std::unique_ptr<llama_grammar>(
|
||
llama_grammar_init_impl(nullptr, grammar_str.c_str(), "root", false, nullptr, 0, nullptr, 0));
|
||
}
|
||
|
||
// TODO: extract to common helper (copied from test-grammar-integration.cpp)
|
||
static bool match_string(const std::string & input, llama_grammar * grammar) {
|
||
const auto cpts = unicode_cpts_from_utf8(input);
|
||
|
||
auto & stacks_cur = llama_grammar_get_stacks(grammar);
|
||
|
||
for (const auto & cpt : cpts) {
|
||
llama_grammar_accept(grammar, cpt);
|
||
|
||
if (stacks_cur.empty()) {
|
||
// no stacks means that the grammar failed to match at this point
|
||
return false;
|
||
}
|
||
}
|
||
|
||
if (std::any_of(stacks_cur.begin(), stacks_cur.end(), [](const auto & stack) { return stack.empty(); })) {
|
||
// An empty stack means that the grammar has been completed
|
||
return true;
|
||
}
|
||
|
||
return false;
|
||
}
|
||
|
||
static void assert_msg_equals(const common_chat_msg & expected, const common_chat_msg & actual) {
|
||
assert_equals(expected.role, actual.role);
|
||
assert_equals(expected.content, actual.content);
|
||
assert_equals(expected.content_parts.size(), actual.content_parts.size());
|
||
for (size_t i = 0; i < expected.content_parts.size(); i++) {
|
||
const auto & expected_part = expected.content_parts[i];
|
||
const auto & actual_part = actual.content_parts[i];
|
||
assert_equals(expected_part.type, actual_part.type);
|
||
assert_equals(expected_part.text, actual_part.text);
|
||
}
|
||
assert_equals(expected.reasoning_content, actual.reasoning_content);
|
||
assert_equals(expected.tool_calls.size(), actual.tool_calls.size());
|
||
for (size_t i = 0; i < expected.tool_calls.size(); i++) {
|
||
const auto & expected_tool_call = expected.tool_calls[i];
|
||
const auto & actual_tool_call = actual.tool_calls[i];
|
||
assert_equals(expected_tool_call.name, actual_tool_call.name);
|
||
assert_equals(json::parse(expected_tool_call.arguments).dump(), json::parse(actual_tool_call.arguments).dump());
|
||
assert_equals(expected_tool_call.id, actual_tool_call.id);
|
||
}
|
||
}
|
||
|
||
common_chat_tool special_function_tool {
|
||
/* .name = */ "special_function",
|
||
/* .description = */ "I'm special",
|
||
/* .parameters = */ R"({
|
||
"type": "object",
|
||
"properties": {
|
||
"arg1": {
|
||
"type": "integer",
|
||
"description": "The arg."
|
||
}
|
||
},
|
||
"required": ["arg1"]
|
||
})",
|
||
};
|
||
common_chat_tool python_tool {
|
||
/* .name = */ "python",
|
||
/* .description = */ "an ipython interpreter",
|
||
/* .parameters = */ R"({
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"type": "string",
|
||
"description": "Python code to execute."
|
||
}
|
||
},
|
||
"required": ["code"]
|
||
})",
|
||
};
|
||
common_chat_tool code_interpreter_tool {
|
||
/* .name = */ "code_interpreter",
|
||
/* .description = */ "an ipython interpreter",
|
||
/* .parameters = */ R"({
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"type": "string",
|
||
"description": "Python code to execute."
|
||
}
|
||
},
|
||
"required": ["code"]
|
||
})",
|
||
};
|
||
std::vector<common_chat_tool> tools { special_function_tool, python_tool };
|
||
std::vector<common_chat_tool> llama_3_1_tools { special_function_tool, code_interpreter_tool };
|
||
|
||
struct delta_data {
|
||
std::string delta;
|
||
common_chat_params params;
|
||
};
|
||
|
||
static delta_data init_delta(const struct common_chat_templates * tmpls, const std::vector<std::string> & end_tokens,
|
||
const common_chat_msg & user_message,
|
||
const common_chat_msg & delta_message,
|
||
const std::vector<common_chat_tool> & tools,
|
||
const common_chat_tool_choice & tool_choice,
|
||
bool think = false) {
|
||
common_chat_templates_inputs inputs;
|
||
inputs.parallel_tool_calls = true;
|
||
inputs.messages.push_back(user_message);
|
||
inputs.tools = tools;
|
||
inputs.tool_choice = tool_choice;
|
||
inputs.extract_reasoning = think;
|
||
auto params_prefix = common_chat_templates_apply(tmpls, inputs);
|
||
|
||
inputs.messages.push_back(delta_message);
|
||
inputs.add_generation_prompt = false;
|
||
auto params_full = common_chat_templates_apply(tmpls, inputs);
|
||
|
||
std::string prefix = params_prefix.prompt;
|
||
std::string full = params_full.prompt;
|
||
|
||
if (full == prefix) {
|
||
throw std::runtime_error("Full message is the same as the prefix");
|
||
}
|
||
|
||
size_t common_prefix_length = 0;
|
||
for (size_t i = 0; i < prefix.size() && i < full.size(); ++i) {
|
||
if (prefix[i] != full[i]) {
|
||
break;
|
||
}
|
||
if (prefix[i] == '<') {
|
||
// DeepSeek R1's template (as of 20250209) adds a trailing <think> if add_generation_prompt,
|
||
// but it removes thinking tags for past messages.
|
||
// The prefix and full strings diverge at <think> vs. <｜tool▁calls▁begin｜>, we avoid consuming the leading <.
|
||
continue;
|
||
}
|
||
common_prefix_length = i + 1;
|
||
}
|
||
auto delta = full.substr(common_prefix_length);
|
||
|
||
// Strip end tokens
|
||
for (const auto & end_token : end_tokens) {
|
||
// rfind to find the last occurrence
|
||
auto pos = delta.rfind(end_token);
|
||
if (pos != std::string::npos) {
|
||
delta = delta.substr(0, pos);
|
||
break;
|
||
}
|
||
}
|
||
return { delta, params_full };
|
||
}
|
||
|
||
/*
|
||
Applies the template to 1 user message w/ add_generation_prompt=true, then w/ the test message w/ add_generation_prompt=false,
|
||
gets the diff, removes any end tokens and parses the result w/ the grammar, checking that
|
||
the parsed message is the same as the test_message
|
||
*/
|
||
static void test_templates(const struct common_chat_templates * tmpls, const std::vector<std::string> & end_tokens,
|
||
const common_chat_msg & test_message,
|
||
const std::vector<common_chat_tool> & tools = {},
|
||
const std::string & expected_delta = "",
|
||
bool expect_grammar_triggered = true,
|
||
bool test_grammar_if_triggered = true,
|
||
bool think = false) {
|
||
common_chat_msg user_message;
|
||
user_message.role = "user";
|
||
user_message.content = "Hello, world!";
|
||
|
||
for (const auto & tool_choice : std::vector<common_chat_tool_choice> {COMMON_CHAT_TOOL_CHOICE_AUTO, COMMON_CHAT_TOOL_CHOICE_REQUIRED}) {
|
||
auto data = init_delta(tmpls, end_tokens, user_message, test_message, tools, tool_choice, think);
|
||
if (!expected_delta.empty()) {
|
||
assert_equals(expected_delta, data.delta);
|
||
}
|
||
|
||
if (expect_grammar_triggered) {
|
||
const auto msg = common_chat_parse(data.delta, data.params.format);
|
||
assert_msg_equals(test_message, msg);
|
||
}
|
||
|
||
if (!test_message.tool_calls.empty()) {
|
||
GGML_ASSERT(!data.params.grammar.empty());
|
||
}
|
||
if (!data.params.grammar.empty()) {
|
||
auto grammar = build_grammar(data.params.grammar);
|
||
if (!grammar) {
|
||
throw std::runtime_error("Failed to build grammar");
|
||
}
|
||
auto earliest_trigger_pos = std::string::npos;
|
||
auto constrained = data.delta;
|
||
for (const auto & trigger : data.params.grammar_triggers) {
|
||
size_t pos = std::string::npos;
|
||
std::smatch match;
|
||
switch (trigger.type) {
|
||
case COMMON_GRAMMAR_TRIGGER_TYPE_WORD:
|
||
{
|
||
const auto & word = trigger.value;
|
||
pos = constrained.find(word);
|
||
break;
|
||
}
|
||
case COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN:
|
||
{
|
||
const auto & pattern = trigger.value;
|
||
if (std::regex_search(constrained, match, std::regex(pattern))) {
|
||
pos = match.position();
|
||
}
|
||
break;
|
||
}
|
||
case COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_START:
|
||
{
|
||
const auto & pattern = trigger.value;
|
||
if (std::regex_search(constrained, match, std::regex(pattern)) && match.position() == 0) {
|
||
pos = 0;
|
||
}
|
||
break;
|
||
}
|
||
default:
|
||
throw std::runtime_error("Unknown trigger type");
|
||
}
|
||
if (pos == std::string::npos) {
|
||
continue;
|
||
}
|
||
if (earliest_trigger_pos == std::string::npos || pos < earliest_trigger_pos) {
|
||
earliest_trigger_pos = pos;
|
||
}
|
||
}
|
||
auto grammar_triggered = false;
|
||
if (earliest_trigger_pos != std::string::npos) {
|
||
constrained = constrained.substr(earliest_trigger_pos);
|
||
grammar_triggered = true;
|
||
}
|
||
if (data.params.grammar_lazy) {
|
||
assert_equals(expect_grammar_triggered, grammar_triggered);
|
||
}
|
||
|
||
if (grammar_triggered && test_grammar_if_triggered && !match_string(constrained, grammar.get())) {
|
||
throw std::runtime_error("Failed to match delta against grammar:\n\n" + data.delta +
|
||
"\n\nConstrained: " + constrained +
|
||
"\n\nGrammar: " + data.params.grammar);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
const common_chat_msg message_user {
|
||
"user",
|
||
"Hey there!",
|
||
/* .content_parts = */ {},
|
||
/* .tool_calls = */ {},
|
||
/* .reasoning_content = */ "",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
|
||
const common_chat_msg message_user_parts {
|
||
"user",
|
||
/* .content = */ "",
|
||
/* .content_parts = */ {
|
||
{ "text", "Hey" },
|
||
{ "text", "there" },
|
||
},
|
||
/* .tool_calls = */ {},
|
||
/* .reasoning_content = */ "",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
const common_chat_msg message_assist {
|
||
"assistant",
|
||
"Hello, world!\nWhat's up?",
|
||
/* .content_parts = */ {},
|
||
/* .tool_calls = */ {},
|
||
/* .reasoning_content = */ "",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
const common_chat_msg message_assist_thoughts_unparsed_think {
|
||
"assistant",
|
||
"<think>I'm thinking</think>Hello, world!\nWhat's up?",
|
||
/* .content_parts = */ {},
|
||
/* .tool_calls = */ {},
|
||
/* .reasoning_content = */ "",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
const common_chat_msg message_assist_thoughts_unparsed_r7b {
|
||
"assistant",
|
||
"<|START_THINKING|>I'm thinking<|END_THINKING|>Hello, world!\nWhat's up?",
|
||
/* .content_parts = */ {},
|
||
/* .tool_calls = */ {},
|
||
/* .reasoning_content = */ "",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
const common_chat_msg message_assist_thoughts {
|
||
"assistant",
|
||
"Hello, world!\nWhat's up?",
|
||
/* .content_parts = */ {},
|
||
/* .tool_calls = */ {},
|
||
/* .reasoning_content = */ "I'm thinking",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
const std::vector<common_chat_tool_call> tool_calls {
|
||
{ "special_function", "{\"arg1\": 1}", /* .id = */ "" },
|
||
};
|
||
const std::vector<common_chat_tool_call> tool_calls_idx {
|
||
{ "special_function", "{\"arg1\": 1}", /* .id = */ "0" },
|
||
};
|
||
const std::vector<common_chat_tool_call> tool_calls_id {
|
||
{ "special_function", "{\"arg1\": 1}", /* .id = */ "123456789" },
|
||
};
|
||
|
||
const common_chat_msg message_assist_call {
|
||
"assistant",
|
||
"",
|
||
/* .content_parts = */ {},
|
||
tool_calls,
|
||
/* .reasoning_content = */ "",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
const common_chat_msg message_assist_call_thoughts = {
|
||
"assistant",
|
||
/* .content = */ "",
|
||
/* .content_parts = */ {},
|
||
tool_calls,
|
||
/* .reasoning_content = */ "I'm\nthinking",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
const common_chat_msg message_assist_call_thoughts_unparsed = {
|
||
"assistant",
|
||
/* .content = */ "<think>I'm\nthinking</think>",
|
||
/* .content_parts = */ {},
|
||
tool_calls,
|
||
/* .reasoning_content = */ "",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
const common_chat_msg message_assist_call_id {
|
||
"assistant",
|
||
"",
|
||
/* .content_parts = */ {},
|
||
tool_calls_id,
|
||
/* .reasoning_content = */ "",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
const common_chat_msg message_assist_call_idx {
|
||
"assistant",
|
||
"",
|
||
/* .content_parts = */ {},
|
||
tool_calls_idx,
|
||
/* .reasoning_content = */ "",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
const common_chat_msg message_assist_call_python {
|
||
"assistant",
|
||
"",
|
||
/* .content_parts = */ {},
|
||
{ { "python", "{\"code\": \"print('hey')\"}", /* .id = */ "" } },
|
||
/* .reasoning_content = */ "",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
const common_chat_msg message_assist_call_code_interpreter {
|
||
"assistant",
|
||
"",
|
||
/* .content_parts = */ {},
|
||
{ { "code_interpreter", "{\"code\": \"print('hey')\"}", /* .id = */ "" } },
|
||
/* .reasoning_content = */ "",
|
||
/* .tool_name = */ "",
|
||
/* .tool_call_id = */ "",
|
||
};
|
||
|
||
static void test_msgs_oaicompat_json_conversion() {
|
||
std::vector<common_chat_msg> msgs{
|
||
message_user,
|
||
message_user_parts,
|
||
message_assist_call,
|
||
message_assist_call_thoughts,
|
||
message_assist_call_thoughts_unparsed,
|
||
message_assist_call_id,
|
||
message_assist_call_idx,
|
||
message_assist_call_python,
|
||
message_assist_call_code_interpreter,
|
||
};
|
||
for (const auto & msg : msgs) {
|
||
auto oai_json = common_chat_msgs_to_json_oaicompat<json>({msg});
|
||
auto msgs2 = common_chat_msgs_parse_oaicompat(oai_json);
|
||
assert_equals((size_t) 1, msgs2.size());
|
||
auto msg2 = msgs2[0];
|
||
assert_msg_equals(msg, msg2);
|
||
}
|
||
assert_equals(
|
||
std::string(
|
||
"[\n"
|
||
" {\n"
|
||
" \"role\": \"user\",\n"
|
||
" \"content\": [\n"
|
||
" {\n"
|
||
" \"type\": \"text\",\n"
|
||
" \"text\": \"Hey\"\n"
|
||
" },\n"
|
||
" {\n"
|
||
" \"type\": \"text\",\n"
|
||
" \"text\": \"there\"\n"
|
||
" }\n"
|
||
" ]\n"
|
||
" }\n"
|
||
"]"
|
||
),
|
||
common_chat_msgs_to_json_oaicompat<json>({message_user_parts}).dump(2));
|
||
|
||
assert_equals(
|
||
std::string(
|
||
"[\n"
|
||
" {\n"
|
||
" \"role\": \"assistant\",\n"
|
||
" \"content\": null,\n"
|
||
" \"tool_calls\": [\n"
|
||
" {\n"
|
||
" \"type\": \"function\",\n"
|
||
" \"function\": {\n"
|
||
" \"name\": \"python\",\n"
|
||
" \"arguments\": \"{\\\"code\\\": \\\"print('hey')\\\"}\"\n"
|
||
" }\n"
|
||
" }\n"
|
||
" ]\n"
|
||
" }\n"
|
||
"]"
|
||
),
|
||
common_chat_msgs_to_json_oaicompat<json>({message_assist_call_python}).dump(2));
|
||
}
|
||
|
||
static void test_tools_oaicompat_json_conversion() {
|
||
std::vector<common_chat_tool> tools{
|
||
special_function_tool,
|
||
python_tool,
|
||
code_interpreter_tool,
|
||
};
|
||
|
||
for (const auto & tool : tools) {
|
||
auto oai_json = common_chat_tools_to_json_oaicompat<json>({tool});
|
||
auto tools2 = common_chat_tools_parse_oaicompat(oai_json);
|
||
assert_equals((size_t) 1, tools2.size());
|
||
auto tool2 = tools2[0];
|
||
assert_equals(tool.name, tool2.name);
|
||
assert_equals(tool.description, tool2.description);
|
||
assert_equals(json::parse(tool.parameters).dump(2), json::parse(tool2.parameters).dump(2));
|
||
}
|
||
|
||
assert_equals(
|
||
std::string(
|
||
"[\n"
|
||
" {\n"
|
||
" \"type\": \"function\",\n"
|
||
" \"function\": {\n"
|
||
" \"name\": \"special_function\",\n"
|
||
" \"description\": \"I'm special\",\n"
|
||
" \"parameters\": {\n"
|
||
" \"type\": \"object\",\n"
|
||
" \"properties\": {\n"
|
||
" \"arg1\": {\n"
|
||
" \"type\": \"integer\",\n"
|
||
" \"description\": \"The arg.\"\n"
|
||
" }\n"
|
||
" },\n"
|
||
" \"required\": [\n"
|
||
" \"arg1\"\n"
|
||
" ]\n"
|
||
" }\n"
|
||
" }\n"
|
||
" }\n"
|
||
"]"
|
||
),
|
||
common_chat_tools_to_json_oaicompat<json>({special_function_tool}).dump(2));
|
||
}
|
||
|
||
static void test_template_output_parsers() {
|
||
|
||
common_chat_templates_inputs inputs_no_tools;
|
||
inputs_no_tools.messages = {message_user};
|
||
inputs_no_tools.extract_reasoning = false;
|
||
|
||
common_chat_templates_inputs inputs_no_tools_think;
|
||
inputs_no_tools_think.messages = {message_user};
|
||
inputs_no_tools_think.extract_reasoning = true;
|
||
|
||
common_chat_templates_inputs inputs_tools;
|
||
inputs_tools.messages = {message_user};
|
||
inputs_tools.tools = {special_function_tool};
|
||
inputs_tools.extract_reasoning = false;
|
||
|
||
common_chat_templates_inputs inputs_tools_think;
|
||
inputs_tools_think.messages = {message_user};
|
||
inputs_tools_think.tools = {special_function_tool};
|
||
inputs_tools_think.extract_reasoning = true;
|
||
|
||
common_chat_templates_inputs inputs_tools_builtin;
|
||
inputs_tools_builtin.messages = {message_user};
|
||
inputs_tools_builtin.tools = {python_tool};
|
||
inputs_tools_builtin.extract_reasoning = false;
|
||
|
||
{
|
||
// Not supported yet
|
||
auto tmpls = read_templates("models/templates/CohereForAI-c4ai-command-r-plus-tool_use.jinja");
|
||
assert_equals(COMMON_CHAT_FORMAT_GENERIC, common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
}
|
||
{
|
||
auto tmpls = read_templates("models/templates/CohereForAI-c4ai-command-r7b-12-2024-tool_use.jinja");
|
||
std::vector<std::string> end_tokens{ "<|END_OF_TURN_TOKEN|>" };
|
||
|
||
assert_equals(COMMON_CHAT_FORMAT_COMMAND_R7B, common_chat_templates_apply(tmpls.get(), inputs_no_tools).format);
|
||
assert_equals(COMMON_CHAT_FORMAT_COMMAND_R7B, common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
assert_equals(COMMON_CHAT_FORMAT_COMMAND_R7B_EXTRACT_REASONING, common_chat_templates_apply(tmpls.get(), inputs_tools_think).format);
|
||
|
||
assert_msg_equals(message_assist,
|
||
common_chat_parse(
|
||
"Hello, world!\nWhat's up?",
|
||
COMMON_CHAT_FORMAT_COMMAND_R7B));
|
||
assert_msg_equals(message_assist,
|
||
common_chat_parse(
|
||
"Hello, world!\nWhat's up?<|END_RESPONSE|>",
|
||
COMMON_CHAT_FORMAT_COMMAND_R7B));
|
||
assert_msg_equals(message_assist,
|
||
common_chat_parse(
|
||
"<|START_RESPONSE|>Hello, world!\nWhat's up?<|END_RESPONSE|>",
|
||
COMMON_CHAT_FORMAT_COMMAND_R7B));
|
||
assert_msg_equals(message_assist_thoughts_unparsed_r7b,
|
||
common_chat_parse(
|
||
"<|START_THINKING|>I'm thinking<|END_THINKING|>"
|
||
"<|START_RESPONSE|>Hello, world!\nWhat's up?<|END_RESPONSE|>",
|
||
COMMON_CHAT_FORMAT_COMMAND_R7B));
|
||
assert_msg_equals(message_assist_thoughts_unparsed_r7b,
|
||
common_chat_parse(
|
||
"<|START_THINKING|>I'm thinking<|END_THINKING|>"
|
||
"Hello, world!\nWhat's up?<|END_RESPONSE|>",
|
||
COMMON_CHAT_FORMAT_COMMAND_R7B));
|
||
|
||
assert_msg_equals(message_assist_thoughts,
|
||
common_chat_parse(
|
||
"<|START_THINKING|>I'm thinking<|END_THINKING|>"
|
||
"<|START_RESPONSE|>Hello, world!\nWhat's up?<|END_RESPONSE|>",
|
||
COMMON_CHAT_FORMAT_COMMAND_R7B_EXTRACT_REASONING));
|
||
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call_idx, tools,
|
||
"<|START_THINKING|><|END_THINKING|>"
|
||
"<|START_ACTION|>[\n"
|
||
" {\"tool_call_id\": \"0\", \"tool_name\": \"special_function\", \"parameters\": {\"arg1\": 1}}\n"
|
||
"]<|END_ACTION|>");
|
||
test_templates(tmpls.get(), end_tokens, message_assist, tools,
|
||
"<|START_RESPONSE|>Hello, world!\n"
|
||
"What's up?<|END_RESPONSE|>",
|
||
/* expect_grammar_triggered= */ false);
|
||
}
|
||
{
|
||
auto tmpls = read_templates("models/templates/google-gemma-2-2b-it.jinja");
|
||
std::vector<std::string> end_tokens{ "<end_of_turn>" };
|
||
|
||
assert_equals(COMMON_CHAT_FORMAT_CONTENT_ONLY, common_chat_templates_apply(tmpls.get(), inputs_no_tools).format);
|
||
assert_equals(COMMON_CHAT_FORMAT_GENERIC, common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
assert_equals(COMMON_CHAT_FORMAT_GENERIC,
|
||
common_chat_templates_apply(
|
||
read_templates("models/templates/microsoft-Phi-3.5-mini-instruct.jinja").get(),
|
||
inputs_tools)
|
||
.format);
|
||
|
||
// Generic tool calls doesn't generate / parse content-only messages symmetrically.
|
||
|
||
assert_msg_equals(message_assist,
|
||
common_chat_parse("{\n"
|
||
" \"response\": \"Hello, world!\\nWhat's up?\"\n"
|
||
"}",
|
||
common_chat_templates_apply(tmpls.get(), inputs_tools).format));
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call_id, tools,
|
||
"{\n"
|
||
" \"tool_calls\": [\n"
|
||
" {\n"
|
||
" \"name\": \"special_function\",\n"
|
||
" \"arguments\": {\n"
|
||
" \"arg1\": 1\n"
|
||
" },\n"
|
||
" \"id\": \"123456789\"\n"
|
||
" }\n"
|
||
" ]\n"
|
||
"}");
|
||
}
|
||
{
|
||
auto tmpls = read_templates("models/templates/mistralai-Mistral-Nemo-Instruct-2407.jinja");
|
||
std::vector<std::string> end_tokens{ "</s>" };
|
||
|
||
assert_equals(COMMON_CHAT_FORMAT_MISTRAL_NEMO, common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
|
||
test_templates(tmpls.get(), end_tokens, message_assist, tools, "Hello, world!\nWhat's up?", /* expect_grammar_triggered= */ false);
|
||
test_templates(
|
||
tmpls.get(), end_tokens, message_assist_call_id, tools,
|
||
"[TOOL_CALLS][{\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}, \"id\": \"123456789\"}]");
|
||
}
|
||
{
|
||
auto tmpls = read_templates("models/templates/NousResearch-Hermes-2-Pro-Llama-3-8B-tool_use.jinja");
|
||
std::vector<std::string> end_tokens{ "<|im_end|>" };
|
||
|
||
assert_equals(COMMON_CHAT_FORMAT_HERMES_2_PRO, common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
assert_equals(
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO,
|
||
common_chat_templates_apply(
|
||
read_templates("models/templates/NousResearch-Hermes-3-Llama-3.1-8B-tool_use.jinja").get(),
|
||
inputs_tools)
|
||
.format);
|
||
assert_equals(
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO,
|
||
common_chat_templates_apply(
|
||
read_templates("models/templates/Qwen-Qwen2.5-7B-Instruct.jinja").get(),
|
||
inputs_tools)
|
||
.format);
|
||
|
||
// Test parsing
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"<tool_call>\n"
|
||
"{\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"</tool_call>",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"<function=special_function>{\"arg1\": 1}</function>",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"<function name=\"special_function\">\n"
|
||
"{\"arg1\": 1}\n"
|
||
"</function>",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"<tool>\n"
|
||
" {\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"</tool>",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"<tools>\n"
|
||
" {\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"</tools>",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"<response>\n"
|
||
" {\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"</response>",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"```xml\n"
|
||
"<response>\n"
|
||
" {\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"</response>\n"
|
||
"```",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"```xml\n"
|
||
" {\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"```",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"```\n"
|
||
" {\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"```",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"```\n"
|
||
"{\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"```",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"```json\n"
|
||
" {\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"```",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"```json\n"
|
||
"\n"
|
||
" <function_call> {\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}} \n"
|
||
" </function_call> \n"
|
||
"``` ",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"<json>\n"
|
||
" {\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"</json>",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"<xml>\n"
|
||
" {\n"
|
||
" \"name\": \"special_function\", \"arguments\": {\"arg1\": 1}\n"
|
||
" }\n"
|
||
"</xml>",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"<JSON>\n"
|
||
" {\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"</JSON>",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"{\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
assert_msg_equals(message_assist_call, common_chat_parse(
|
||
"{\n \"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}",
|
||
COMMON_CHAT_FORMAT_HERMES_2_PRO));
|
||
|
||
test_templates(tmpls.get(), end_tokens, message_assist, tools, "Hello, world!\nWhat's up?", /* expect_grammar_triggered= */ false);
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call, tools,
|
||
"<tool_call>\n"
|
||
"{\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}\n"
|
||
"</tool_call>");
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call_python, tools,
|
||
"<tool_call>\n"
|
||
"{\"name\": \"python\", \"arguments\": {\"code\": \"print('hey')\"}}\n"
|
||
"</tool_call>");
|
||
}
|
||
{
|
||
auto tmpls = read_templates("models/templates/meta-llama-Llama-3.1-8B-Instruct.jinja");
|
||
std::vector<std::string> end_tokens{ "<|eom_id|>", "<|eot_id|>" };
|
||
|
||
assert_equals(COMMON_CHAT_FORMAT_LLAMA_3_X, common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
assert_equals(COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS,
|
||
common_chat_templates_apply(tmpls.get(), inputs_tools_builtin).format);
|
||
assert_equals(COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS,
|
||
common_chat_templates_apply(
|
||
read_templates("models/templates/meta-llama-Llama-3.3-70B-Instruct.jinja").get(),
|
||
inputs_tools_builtin)
|
||
.format);
|
||
|
||
// test_templates(tmpls.get(), end_tokens, message_assist, tools, R"(?)", /* expect_grammar_triggered= */ false);
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call_code_interpreter, llama_3_1_tools,
|
||
"<|python_tag|>code_interpreter.call(code=\"print('hey')\")");
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call_python, tools,
|
||
"<|python_tag|>python.call(code=\"print('hey')\")");
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call, tools,
|
||
"{\"name\": \"special_function\", \"parameters\": {\"arg1\": 1}}");
|
||
}
|
||
{
|
||
auto tmpls = read_templates("models/templates/meta-llama-Llama-3.2-3B-Instruct.jinja");
|
||
std::vector<std::string> end_tokens{ "<|eom_id|>", "<|eot_id|>" };
|
||
|
||
assert_equals(COMMON_CHAT_FORMAT_LLAMA_3_X, common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
|
||
test_templates(tmpls.get(), end_tokens, message_assist, tools, "Hello, world!\nWhat's up?", /* expect_grammar_triggered= */ false);
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call, tools,
|
||
"{\"name\": \"special_function\", \"parameters\": {\"arg1\": 1}}");
|
||
}
|
||
{
|
||
auto tmpls = read_templates("models/templates/meetkai-functionary-medium-v3.1.jinja");
|
||
std::vector<std::string> end_tokens{ "<|eom_id|>", "<|eot_id|>" };
|
||
|
||
assert_equals(COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1,
|
||
common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
|
||
test_templates(tmpls.get(), end_tokens, message_assist, tools, "Hello, world!\nWhat's up?", /* expect_grammar_triggered= */ false);
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call, tools,
|
||
"<function=special_function>{\"arg1\": 1}</function>");
|
||
}
|
||
{
|
||
auto tmpls = read_templates("models/templates/meetkai-functionary-medium-v3.2.jinja");
|
||
std::vector<std::string> end_tokens{ "<|eom_id|>", "<|eot_id|>" };
|
||
|
||
assert_equals(COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2, common_chat_templates_apply(tmpls.get(), inputs_no_tools).format);
|
||
assert_equals(COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2, common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
|
||
test_templates(tmpls.get(), end_tokens, message_assist, {},
|
||
"all\n"
|
||
"Hello, world!\n"
|
||
"What's up?",
|
||
/* expect_grammar_triggered= */ false);
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call, tools,
|
||
"special_function\n"
|
||
"{\"arg1\": 1}");
|
||
}
|
||
{
|
||
auto tmpls = read_templates("models/templates/fireworks-ai-llama-3-firefunction-v2.jinja");
|
||
std::vector<std::string> end_tokens{ "<|eot_id|>" };
|
||
|
||
assert_equals(COMMON_CHAT_FORMAT_FIREFUNCTION_V2, common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
|
||
test_templates(tmpls.get(), end_tokens, message_assist, tools, "Hello, world!\nWhat's up?", /* expect_grammar_triggered= */ false);
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call, tools,
|
||
" functools[{\"name\": \"special_function\", \"arguments\": {\"arg1\": 1}}]");
|
||
}
|
||
{
|
||
// Original DeepSeek R1 template. Leaves <｜tool▁calls▁begin｜> and others unclosed. Our logic fixes the prompt.
|
||
auto tmpls = read_templates("models/templates/deepseek-ai-DeepSeek-R1-Distill-Llama-8B.jinja");
|
||
std::vector<std::string> end_tokens{ "<｜end▁of▁sentence｜>" };
|
||
|
||
assert_equals(COMMON_CHAT_FORMAT_DEEPSEEK_R1, common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
assert_equals(COMMON_CHAT_FORMAT_DEEPSEEK_R1_EXTRACT_REASONING, common_chat_templates_apply(tmpls.get(), inputs_tools_think).format);
|
||
|
||
test_templates(tmpls.get(), end_tokens, message_assist, tools, "Hello, world!\nWhat's up?", /* expect_grammar_triggered= */ false);
|
||
test_templates(tmpls.get(), end_tokens, message_assist_thoughts, tools, "Hello, world!\nWhat's up?", /* expect_grammar_triggered= */ false);
|
||
assert_msg_equals(message_assist_thoughts_unparsed_think,
|
||
common_chat_parse("<think>I'm thinking</think>Hello, world!\nWhat's up?",
|
||
COMMON_CHAT_FORMAT_DEEPSEEK_R1));
|
||
assert_msg_equals(message_assist_thoughts,
|
||
common_chat_parse("<think>I'm thinking</think>Hello, world!\nWhat's up?",
|
||
COMMON_CHAT_FORMAT_DEEPSEEK_R1_EXTRACT_REASONING));
|
||
assert_msg_equals(message_assist_thoughts,
|
||
// Latest template update (ast of 20250209) adds a trailing <think>\n if add_generation_prompt is true.
|
||
common_chat_parse("I'm thinking</think>Hello, world!\nWhat's up?",
|
||
COMMON_CHAT_FORMAT_DEEPSEEK_R1_EXTRACT_REASONING));
|
||
// test_templates(tmpls.get(), end_tokens, message_assist_call, tools,
|
||
// "<｜tool▁calls▁begin｜><｜tool▁call▁begin｜>function<｜tool▁sep｜>special_function\n"
|
||
// "```json\n"
|
||
// "{\"arg1\": 1}\n"
|
||
// // Look what's not here: <｜tool▁calls▁end｜> (also missing the <｜end▁of▁sentence｜>, but that is removed lazily by the test's delta logic)
|
||
// "```<｜tool▁call▁end｜>",
|
||
// /* expect_grammar_triggered= */ true,
|
||
// /* test_grammar_if_triggered= */ false);
|
||
}
|
||
{
|
||
// Replacement DeepSeek R1 template. Makes the Distill Qwen 7B/32B models happy to call tools and all.
|
||
auto tmpls = read_templates("models/templates/llama-cpp-deepseek-r1.jinja");
|
||
std::vector<std::string> end_tokens{ "<｜end▁of▁sentence｜>" };
|
||
|
||
assert_equals(COMMON_CHAT_FORMAT_DEEPSEEK_R1, common_chat_templates_apply(tmpls.get(), inputs_tools).format);
|
||
assert_equals(COMMON_CHAT_FORMAT_DEEPSEEK_R1_EXTRACT_REASONING, common_chat_templates_apply(tmpls.get(), inputs_tools_think).format);
|
||
|
||
test_templates(tmpls.get(), end_tokens, message_assist, tools, "Hello, world!\nWhat's up?", /* expect_grammar_triggered= */ false);
|
||
test_templates(tmpls.get(), end_tokens, message_assist_thoughts, tools, "Hello, world!\nWhat's up?", /* expect_grammar_triggered= */ false);
|
||
assert_msg_equals(message_assist_thoughts_unparsed_think,
|
||
common_chat_parse("<think>I'm thinking</think>Hello, world!\nWhat's up?",
|
||
COMMON_CHAT_FORMAT_DEEPSEEK_R1));
|
||
assert_msg_equals(message_assist_thoughts,
|
||
common_chat_parse("<think>I'm thinking</think>Hello, world!\nWhat's up?",
|
||
COMMON_CHAT_FORMAT_DEEPSEEK_R1_EXTRACT_REASONING));
|
||
|
||
assert_msg_equals(message_assist_call_thoughts_unparsed,
|
||
common_chat_parse(
|
||
"<think>I'm\nthinking</think>\n\n"
|
||
"<｜tool▁calls▁begin｜><｜tool▁call▁begin｜>function<｜tool▁sep｜>special_function\n"
|
||
"```json\n"
|
||
"{\"arg1\": 1}\n"
|
||
"```<｜tool▁call▁end｜><｜tool▁calls▁end｜>",
|
||
COMMON_CHAT_FORMAT_DEEPSEEK_R1));
|
||
assert_msg_equals(message_assist_call_thoughts,
|
||
common_chat_parse(
|
||
"<think>I'm\nthinking</think>\n\n"
|
||
"<｜tool▁calls▁begin｜><｜tool▁call▁begin｜>function<｜tool▁sep｜>special_function\n"
|
||
"```json\n"
|
||
"{\"arg1\": 1}\n"
|
||
"```<｜tool▁call▁end｜><｜tool▁calls▁end｜>",
|
||
COMMON_CHAT_FORMAT_DEEPSEEK_R1_EXTRACT_REASONING));
|
||
test_templates(tmpls.get(), end_tokens, message_assist_call, tools,
|
||
"<｜tool▁calls▁begin｜><｜tool▁call▁begin｜>function<｜tool▁sep｜>special_function\n"
|
||
"```json\n"
|
||
"{\"arg1\": 1}\n"
|
||
"```<｜tool▁call▁end｜><｜tool▁calls▁end｜>");
|
||
}
|
||
}
|
||
|
||
int main(int argc, char ** argv) {
|
||
// try {
|
||
#ifndef _WIN32
|
||
if (argc > 1) {
|
||
common_chat_templates_inputs inputs;
|
||
common_chat_msg msg;
|
||
msg.role = "user";
|
||
msg.content = "Hey";
|
||
inputs.messages = {msg};
|
||
inputs.tools = { special_function_tool };
|
||
|
||
std::cout << "| Template | Format |\n";
|
||
std::cout << "|----------|--------|\n";
|
||
|
||
for (int i = 1; i < argc; i++) {
|
||
try {
|
||
std::string path = argv[i];
|
||
if (path.rfind(".jinja") != path.size() - 6) {
|
||
std::cerr << "Skipping non-jinja file: " << path << '\n';
|
||
continue;
|
||
}
|
||
auto tmpls = read_templates(path);
|
||
auto parts = string_split(path, "/");
|
||
auto name = parts[parts.size() - 1];
|
||
auto format = common_chat_format_name(common_chat_templates_apply(tmpls.get(), inputs).format);
|
||
std::cout << "| " << name << " | " << format << " |\n";
|
||
} catch (const std::exception & e) {
|
||
std::cerr << "Failed to process " << argv[i] << ": " << e.what() << '\n';
|
||
}
|
||
}
|
||
} else
|
||
#endif
|
||
{
|
||
test_msgs_oaicompat_json_conversion();
|
||
test_tools_oaicompat_json_conversion();
|
||
test_template_output_parsers();
|
||
std::cout << "\n[chat] All tests passed!" << '\n';
|
||
}
|
||
return 0;
|
||
// } catch (const std::exception & e) {
|
||
// std::cerr << "Error: " << e.what() << '\n';
|
||
// return 1;
|
||
// }
|
||
}
|