Skip to content
Navigation Menu
{{ message }}
forked from ggml-org/llama.cpp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest-chat.cpp
More file actions
5604 lines (5054 loc) · 226 KB
/
Copy pathtest-chat.cpp
File metadata and controls
5604 lines (5054 loc) · 226 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Tests chat handling, including grammar genration 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 "../src/llama-grammar.h"
#include "../src/unicode.h"
#include "../tools/server/server-chat.h"
#include "chat-auto-parser.h"
#include "chat.h"
#include "common.h"
#include "ggml.h"
#include "log.h"
#include <algorithm>
#include <exception>
#include <fstream>
#include <functional>
#include <iostream>
#include <nlohmann/json.hpp>
#include <set>
#include <stdexcept>
#include <string>
using json = nlohmann::ordered_json;
static std::ostream & operator<<(std::ostream & os, const common_chat_msg_diff & diff) {
os << "{ content_delta: " << diff.content_delta << "; ";
os << "reasoning_content_delta: " << diff.reasoning_content_delta << "; ";
if (diff.tool_call_index != std::string::npos) {
os << "tool_call_index: " << diff.tool_call_index << "; ";
os << "tool_call_delta.name: " << diff.tool_call_delta.name << "; ";
os << "tool_call_delta.id: " << diff.tool_call_delta.id << "; ";
os << "tool_call_delta.arguments: " << diff.tool_call_delta.arguments << "; ";
}
os << "}";
return os;
}
// operator<< for vector<common_chat_msg_diff>:
static std::ostream & operator<<(std::ostream & os, const std::vector<common_chat_msg_diff> & diffs) {
os << "[\n";
for (const auto & diff : diffs) {
os << " " << diff << ",\n";
}
os << "]";
return os;
}
static std::ostream & operator<<(std::ostream & os, const common_chat_msg & msg) {
os << "{ role: " << msg.role << "; ";
os << "content: " << msg.content << "; ";
os << "content_parts: [\n";
for (const auto & part : msg.content_parts) {
os << " { type: " << part.type << "; text: " << part.text << " },\n";
}
os << "]; ";
os << "reasoning_content: " << msg.reasoning_content << "; ";
os << "tool_calls: [\n";
for (const auto & tool_call : msg.tool_calls) {
os << " { name: " << tool_call.name << "; arguments: " << tool_call.arguments << "; id: " << tool_call.id
<< " },\n";
}
os << "]";
os << "}";
return os;
}
template <class T> static bool equals(const T & expected, const T & actual) {
return expected == actual;
}
static common_chat_msg normalize(const common_chat_msg & msg) {
common_chat_msg normalized = msg;
for (auto & tool_call : normalized.tool_calls) {
try {
tool_call.arguments = json::parse(tool_call.arguments).dump();
} catch (const std::exception &) {
}
}
return normalized;
}
template <> bool equals(const common_chat_msg & expected, const common_chat_msg & actual) {
return normalize(expected) == normalize(actual);
}
template <class T> static void assert_equals(const T & expected, const T & actual) {
if (!equals(expected, actual)) {
std::ostringstream oss_expected;
oss_expected << expected;
std::ostringstream oss_actual;
oss_actual << actual;
LOG_ERR("Expected: %s\n", oss_expected.str().c_str());
LOG_ERR("Actual: %s\n", oss_actual.str().c_str());
common_log_flush(common_log_main());
throw std::runtime_error("Test failed");
}
}
static void assert_contains(const std::string & haystack, const std::string & needle) {
if (haystack.find(needle) == std::string::npos) {
LOG_ERR("Expected to contain: %s\n", needle.c_str());
LOG_ERR("Actual: %s\n", haystack.c_str());
common_log_flush(common_log_main());
throw std::runtime_error("Test failed");
}
}
static void assert_ends_with(const std::string & str, const std::string & suffix) {
if (str.size() < suffix.size() ||
str.compare(str.size() - suffix.size(), suffix.size(), suffix) != 0) {
LOG_ERR("Expected to end with: %s\n", suffix.c_str());
LOG_ERR("Actual: %s\n", str.c_str());
common_log_flush(common_log_main());
throw std::runtime_error("Test failed");
}
}
static std::string read_file(const std::string & path) {
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));
}
// Helper to format a code point as a readable string
static std::string format_codepoint(uint32_t cp) {
if (cp >= 32 && cp < 127) {
return std::string("'") + static_cast<char>(cp) + "'";
} else if (cp == '\n') {
return "'\\n'";
} else if (cp == '\r') {
return "'\\r'";
} else if (cp == '\t') {
return "'\\t'";
} else {
return "U+" + std::to_string(cp);
}
}
// Helper to format expected element from grammar stack
static std::string format_expected_element(const llama_grammar_rules & /* rules*/, const llama_grammar_element * elem) {
if (!elem) {
return "<end>";
}
switch (elem->type) {
case LLAMA_GRETYPE_END:
return "<end of rule>";
case LLAMA_GRETYPE_ALT:
return "<alternative>";
case LLAMA_GRETYPE_RULE_REF:
{
// Find rule name - just show rule ID for now
return "<rule-" + std::to_string(elem->value) + ">";
}
case LLAMA_GRETYPE_CHAR:
{
std::string result;
const llama_grammar_element * pos = elem;
bool first = true;
do {
if (!first) {
result += " | ";
}
first = false;
if (pos[1].type == LLAMA_GRETYPE_CHAR_RNG_UPPER) {
// Range like [a-z]
result += "[" + format_codepoint(pos->value) + "-" + format_codepoint(pos[1].value) + "]";
pos += 2;
} else {
result += format_codepoint(pos->value);
pos += 1;
}
} while (pos->type == LLAMA_GRETYPE_CHAR_ALT);
return result;
}
case LLAMA_GRETYPE_CHAR_NOT:
{
std::string result = "[^";
const llama_grammar_element * pos = elem;
bool first = true;
do {
if (!first) {
result += " ";
}
first = false;
if (pos[1].type == LLAMA_GRETYPE_CHAR_RNG_UPPER) {
result += format_codepoint(pos->value) + "-" + format_codepoint(pos[1].value);
pos += 2;
} else {
result += format_codepoint(pos->value);
pos += 1;
}
} while (pos->type == LLAMA_GRETYPE_CHAR_ALT);
return result + "]";
}
case LLAMA_GRETYPE_CHAR_ANY:
return "<any char>";
case LLAMA_GRETYPE_TOKEN:
return "<token-" + std::to_string(elem->value) + ">";
case LLAMA_GRETYPE_TOKEN_NOT:
return "<not-token-" + std::to_string(elem->value) + ">";
default:
return "<unknown>";
}
}
// Get description of what the grammar expects at current position
static std::string get_expected_description(const llama_grammar_rules & rules, const llama_grammar_stacks & stacks) {
if (stacks.empty()) {
return "<no valid continuations>";
}
std::string result;
std::set<std::string> seen;
for (const auto & stack : stacks) {
if (stack.empty()) {
if (seen.insert("<end>").second) {
if (!result.empty()) {
result += " OR ";
}
result += "<end>";
}
continue;
}
const llama_grammar_element * elem = stack.back();
std::string desc = format_expected_element(rules, elem);
if (seen.insert(desc).second) {
if (!result.empty()) {
result += " OR ";
}
result += desc;
}
}
return result;
}
// Result of a detailed grammar match attempt
struct grammar_match_result {
bool success = false; // Did the string fully match the grammar?
size_t matched_bytes = 0; // Bytes successfully matched before failure
size_t matched_codepoints = 0; // Codepoints successfully matched before failure
size_t total_bytes = 0; // Total bytes in input
size_t total_codepoints = 0; // Total codepoints in input
std::string matched_prefix; // The portion that was successfully matched
std::string failing_char; // The character that caused failure (if any)
std::string expected_description; // What the grammar expected at failure point
bool incomplete = false; // True if matched all input but grammar expects more
};
// Detailed version of match_string that returns failure information
static grammar_match_result match_string_detailed(const std::string & input, llama_grammar * grammar) {
grammar_match_result result;
result.total_bytes = input.size();
const auto cpts = unicode_cpts_from_utf8(input);
result.total_codepoints = cpts.size();
auto & stacks_cur = llama_grammar_get_stacks(grammar);
const auto & rules = llama_grammar_get_rules(grammar);
size_t byte_pos = 0;
for (size_t i = 0; i < cpts.size(); i++) {
const auto & cpt = cpts[i];
// Get expected before accepting (for error reporting)
std::string expected_before = get_expected_description(rules, stacks_cur);
llama_grammar_accept(grammar, cpt);
// Calculate byte position for this codepoint
size_t cpt_bytes = 0;
if (cpt < 0x80) {
cpt_bytes = 1;
} else if (cpt < 0x800) {
cpt_bytes = 2;
} else if (cpt < 0x10000) {
cpt_bytes = 3;
} else {
cpt_bytes = 4;
}
if (stacks_cur.empty()) {
// Grammar failed to match at this point
result.matched_bytes = byte_pos;
result.matched_codepoints = i;
result.matched_prefix = input.substr(0, byte_pos);
result.failing_char = format_codepoint(cpt);
result.expected_description = expected_before;
result.incomplete = false;
return result;
}
byte_pos += cpt_bytes;
}
// All input matched - check if grammar is complete
result.matched_bytes = input.size();
result.matched_codepoints = cpts.size();
result.matched_prefix = input;
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
result.success = true;
result.incomplete = false;
} else {
// Grammar expects more input
result.success = false;
result.incomplete = true;
result.expected_description = get_expected_description(rules, stacks_cur);
}
return result;
}
// 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 std::string renormalize_json(const std::string & json_str) {
try {
auto json_obj = json::parse(json_str);
return json_obj.dump();
} catch (const std::exception & e) {
return ""; // ignore parial JSON contents for comparison purposes
}
}
static void assert_msg_equals(const common_chat_msg & expected,
const common_chat_msg & actual,
bool ignore_whitespace_differences = false) {
assert_equals(expected.role, actual.role);
if (ignore_whitespace_differences) {
assert_equals(string_strip(expected.content), string_strip(actual.content));
} else {
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);
if (ignore_whitespace_differences) {
assert_equals(string_strip(expected_part.text), string_strip(actual_part.text));
} else {
assert_equals(expected_part.text, actual_part.text);
}
}
if (ignore_whitespace_differences) {
assert_equals(string_strip(expected.reasoning_content), string_strip(actual.reasoning_content));
} else {
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(renormalize_json(expected_tool_call.arguments), renormalize_json(actual_tool_call.arguments));
assert_equals(expected_tool_call.id, actual_tool_call.id);
}
}
static 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"]
})",
};
static common_chat_tool special_function_tool_with_optional_param{
/* .name = */ "special_function_with_opt",
/* .description = */ "I'm special but have optional stuff",
/* .parameters = */ R"({
"type": "object",
"properties": {
"arg1": {
"type": "integer",
"description": "The arg."
},
"arg2": {
"type": "integer",
"description": "The optional arg."
}
},
"required": ["arg1"]
})",
};
static common_chat_tool empty_args_tool{
/* .name = */ "empty_args",
/* .description = */ "A tool that takes no arguments",
/* .parameters = */ R"({
"type": "object",
"properties": {}
})",
};
static common_chat_tool empty_args_tool_no_properties{
/* .name = */ "empty_args_no_props",
/* .description = */ "A tool that takes no arguments and has no properties",
/* .parameters = */ R"({
"type": "object"
})",
};
static 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"]
})",
};
static common_chat_tool html_tool{
/* .name = */ "html",
/* .description = */ "an html validator",
/* .parameters = */ R"({
"type": "object",
"properties": {
"markup": {
"type": "string",
"description": "HTML markup to validate."
}
},
"required": ["markup"]
})",
};
static common_chat_tool get_time_tool{
/* .name = */ "get_time",
/* .description = */ "Get the current time in a city",
/* .parameters = */ R"({
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City name"
}
},
"required": ["city"]
})",
};
static common_chat_tool get_weather_tool{
/* .name = */ "get_weather",
/* .description = */ "Get the current weather in a city",
/* .parameters = */ R"({
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City name"
}
},
"required": ["city"]
})",
};
static common_chat_tool todo_list{
/* .name = */ "todo_list",
/* .description = */ "Create or update the todo list",
/* .parameters = */ R"({
"type": "object",
"properties": {
"todos": {
"type": "array",
"description": "List of TODO list items"
}
},
"required": ["todos"]
})",
};
static common_chat_tool edit_tool{
/* .name = */ "edit",
/* .description = */ "Edit file",
/* .parameters = */ R"({
"type": "object",
"properties": {
"filename": {
"type": "string",
"description": "Path of file to edit"
},
"oldString": {
"type": "string",
"description": "String to replace"
},
"newString": {
"type": "string",
"description": "New (replacement) value"
}
},
"required": ["filename", "oldString", "newString"]
})",
};
static common_chat_tool manage_todo_list_tool{
/* .name = */ "manage_todo_list",
/* .description = */ "Create or update the todo list",
/* .parameters = */ R"({
"type": "object",
"properties": {
"todos": {
"type": "array",
"description": "List of TODO list items"
}
},
"required": ["todos"]
})",
};
static common_chat_tool run_in_terminal_tool{
/* .name = */ "run_in_terminal",
/* .description = */ "Run a shell command.",
/* .parameters = */ R"({
"type": "object",
"properties": {
"command": {
"type": "string",
"description": "Shell command to run"
}
},
"required": ["command"]
})",
};
static common_chat_tool magic_tool{
/* .name = */ "magic",
/* .description = */ "Magic tool that takes a hash",
/* .parameters = */ R"({
"type": "object",
"properties": {
"name": {
"type": "string"
},
"ref": {
"type": "string"
}
},
"required": ["name", "ref"]
})",
};
static common_chat_tool magic_int_tool{
/* .name = */ "magic_int",
/* .description = */ "Magic tool that takes a hash",
/* .parameters = */ R"({
"type": "object",
"properties": {
"ref": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": ["ref"]
})",
};
static common_chat_tool amount_tool{
/* .name = */ "amount",
/* .description = */ "Amount converter",
/* .parameters = */ R"({
"type": "object",
"properties": {
"orig": {
"type": "number"
}
},
"required": ["orig"]
})",
};
static common_chat_tool toggle_tool{
/* .name = */ "toggle",
/* .description = */ "Toggle a feature",
/* .parameters = */ R"({
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether to enable the feature"
}
},
"required": ["enabled"]
})",
};
static common_chat_tool nullable_tool{
/* .name = */ "set_nullable",
/* .description = */ "Set a nullable value",
/* .parameters = */ R"({
"type": "object",
"properties": {
"value": {
"type": "null",
"description": "A null value"
}
},
"required": ["value"]
})",
};
static common_chat_tool config_tool{
/* .name = */ "set_config",
/* .description = */ "Set configuration",
/* .parameters = */ R"({
"type": "object",
"properties": {
"config": {
"type": "object",
"description": "Configuration dict"
}
},
"required": ["config"]
})",
};
static common_chat_tool imaginary_number_tool{
/* .name = */ "imaginary_number",
/* .description = */ "Imaginary number converter",
/* .parameters = */ R"({
"type": "object",
"properties": {
"number": {
"type": "object",
"properties": {
"real": {
"type": "number"
},
"imaginary": {
"type": "number"
}
},
"required": ["real", "imaginary"]
}
},
"required": ["number"]
})",
};
static common_chat_tool nullable_string_tool{
/* .name = */ "set_nullable_str",
/* .description = */ "Set a nullable string value",
/* .parameters = */ R"({
"type": "object",
"properties": {
"name": {
"type": ["string", "null"],
"description": "A nullable string"
}
},
"required": ["name"]
})",
};
static common_chat_tool nullable_string_null_first_tool{
/* .name = */ "set_nullable_str_nf",
/* .description = */ "Set a nullable string value with null first in type array",
/* .parameters = */ R"({
"type": "object",
"properties": {
"name": {
"type": ["null", "string"],
"description": "A nullable string with null first"
}
},
"required": ["name"]
})",
};
static common_chat_tool nullable_int_tool{
/* .name = */ "set_nullable_int",
/* .description = */ "Set a nullable integer value",
/* .parameters = */ R"({
"type": "object",
"properties": {
"count": {
"type": ["integer", "null"],
"description": "A nullable integer"
}
},
"required": ["count"]
})",
};
static common_chat_tool enum_no_type_tool{
/* .name = */ "set_unit",
/* .description = */ "Set a temperature unit",
/* .parameters = */ R"({
"type": "object",
"properties": {
"unit": {
"enum": ["celsius", "fahrenheit"],
"description": "Temperature unit"
}
},
"required": ["unit"]
})",
};
static common_chat_tool string_param_tool{
/* .name = */ "string_param",
/* .description = */ "Tool with string parameter for testing",
/* .parameters = */ R"({
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "A text parameter"
}
},
"required": []
})",
};
static common_chat_tool quoted_unquoted_tool{
/* .name = */ "quoted_unquoted",
/* .description = */ "Tool with two string parameters, one for quoted string, one for unquoted",
/* .parameters = */ R"({
"type": "object",
"properties": {
"quoted": {
"type": "string",
"description": "Quoted value"
},
"unquoted": {
"type": "string",
"description": "Unquoted value"
}
},
"required": ["quoted", "unquoted"]
})",
};
static common_chat_tool tool_2req_4opt{
/* .name = */ "tool_2req_4opt",
/* .description = */ "Tool with 2 required and 4 optional params",
/* .parameters = */ R"({
"type": "object",
"properties": {
"req1": { "type": "string", "description": "Required string" },
"req2": { "type": "integer", "description": "Required int" },
"opt1": { "type": "string", "description": "Optional string 1" },
"opt2": { "type": "integer", "description": "Optional int 1" },
"opt3": { "type": "string", "description": "Optional string 2" },
"opt4": { "type": "integer", "description": "Optional int 2" }
},
"required": ["req1", "req2"]
})",
};
static common_chat_tool tool_2req_5opt{
/* .name = */ "tool_2req_5opt",
/* .description = */ "Tool with 2 required and 5 optional params",
/* .parameters = */ R"({
"type": "object",
"properties": {
"req1": { "type": "string", "description": "Required string" },
"req2": { "type": "integer", "description": "Required int" },
"opt1": { "type": "string", "description": "Optional string 1" },
"opt2": { "type": "integer", "description": "Optional int 1" },
"opt3": { "type": "string", "description": "Optional string 2" },
"opt4": { "type": "integer", "description": "Optional int 2" },
"opt5": { "type": "string", "description": "Optional string 3" }
},
"required": ["req1", "req2"]
})",
};
static std::vector<common_chat_tool> tools{ special_function_tool, special_function_tool_with_optional_param,
python_tool, html_tool, todo_list };
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 = */ "",
};
static common_chat_msg simple_assist_msg(const std::string & content,
const std::string & reasoning_content = "",
const std::string & tool_name = "",
const std::string & arguments = "",
const std::string & id = "") {
common_chat_msg msg;
msg.role = "assistant";
msg.content = content;
msg.reasoning_content = reasoning_content;
if (!tool_name.empty() || !id.empty()) {
msg.tool_calls.push_back({ tool_name, arguments, id });
}
return msg;
}
static common_chat_msg message_with_tool_calls(const std::string & tool_name, const std::string & arguments) {
return simple_assist_msg("", "", tool_name, arguments);
}
static common_chat_msg message_with_tool_calls_and_reasoning(const std::string & tool_name,
const std::string & arguments,
const std::string & reasoning) {
return simple_assist_msg("", reasoning, tool_name, arguments);
}
static common_chat_msg message_with_reasoning_content_and_multiple_tool_calls(
const std::string & reasoning,
const std::string & content,
const std::vector<std::pair<std::string, std::string>> & tool_calls) {
common_chat_msg msg;
msg.role = "assistant";
msg.content = content;
msg.reasoning_content = reasoning;
for (const auto & [name, args] : tool_calls) {
msg.tool_calls.push_back({ name, args, "" });
}
return msg;
}
static common_chat_msg message_with_content_and_tool_call(const std::string & content,
const std::string & tool_name,
const std::string & arguments) {
return simple_assist_msg(content, "", tool_name, arguments);
}
static common_chat_msg message_with_reasoning_and_tool_call(const std::string & reasoning,
const std::string & tool_name,
const std::string & arguments) {
return simple_assist_msg("", reasoning, tool_name, arguments);
}
const common_chat_msg message_assist = simple_assist_msg("Hello, world!\nWhat's up?");
const common_chat_msg message_assist_empty = simple_assist_msg("");
const common_chat_msg message_assist_thoughts_unparsed_deepseek =
simple_assist_msg("<think>I'm\nthinking</think>Hello, world!\nWhat's up?");
const common_chat_msg message_assist_thoughts_unparsed_md =
simple_assist_msg("<think>I'm\nthinking</think>Hello, world!\nWhat's up?\n```json\n{}```");
const common_chat_msg message_assist_thoughts_unparsed_md_partial =
simple_assist_msg("<think>I'm\nthinking</think>Hello, world!\nWhat's up?\n```json\n{}");
const common_chat_msg message_assist_thoughts_unparsed_r7b =
simple_assist_msg("<|START_THINKING|>I'm\nthinking<|END_THINKING|>Hello, world!\nWhat's up?");
const common_chat_msg message_assist_thoughts_unparsed_magistral =
simple_assist_msg("[THINK]raisonnement[/THINK]Réponse");
const common_chat_msg message_assist_thoughts = simple_assist_msg("Hello, world!\nWhat's up?", "I'm\nthinking");
const common_chat_msg message_assist_thoughts_unopened_unparsed =
simple_assist_msg("I'm\nthinking</think>Hello, world!\nWhat's up?");
const common_chat_msg message_assist_thoughts_no_content = simple_assist_msg("", "I'm\nthinking");
const common_chat_msg message_assist_call = simple_assist_msg("", "", "special_function", "{\"arg1\": 1}");
const common_chat_msg message_assist_call_noopt =
simple_assist_msg("", "", "special_function_with_opt", "{\"arg1\": 1}");
const common_chat_msg message_assist_call_withopt =
simple_assist_msg("", "", "special_function_with_opt", "{\"arg1\": 1, \"arg2\": 2}");
const common_chat_msg message_assist_call_content =
simple_assist_msg("Hello, world!\nWhat's up?", "", "special_function", "{\"arg1\":1}");
const common_chat_msg message_assist_call_empty_args = simple_assist_msg("", "", "special_function");
const common_chat_msg message_assist_call_cutoff_args = simple_assist_msg("", "", "special_function", "{\"arg");
const common_chat_msg message_assist_call_thoughts =
simple_assist_msg("", "I'm\nthinking", "special_function", "{\"arg1\":1}");
const common_chat_msg message_assist_call_thoughts_unparsed =
simple_assist_msg("<think>I'm\nthinking</think>\n\n", "", "special_function", "{\"arg1\": 1}");
const common_chat_msg message_assist_call_thoughts_content =
simple_assist_msg("Hello, world!\nWhat's up?", "I'm\nthinking", "special_function", "{\"arg1\": 1}");
const common_chat_msg message_assist_call_id =
simple_assist_msg("", "", "special_function", "{\"arg1\":1}", /* .id = */ "123456789");
const common_chat_msg message_assist_call_idx =
simple_assist_msg("", "", "special_function", "{\"arg1\":1}", /* .id = */ "0");
const common_chat_msg message_assist_thoughts_call_idx =
simple_assist_msg("", "I'm\nthinking", "special_function", "{\"arg1\": 1}", /* id = */ "0");
const common_chat_msg message_assist_thoughts_partial_call =
simple_assist_msg("", "I'm\nthinking", "special_function", "", /* id = */ "0");
const common_chat_msg message_assist_call_python = simple_assist_msg("", "", "python", "{\"code\":\"print('hey')\"}");
const common_chat_msg message_assist_call_python_lines =
simple_assist_msg("", "", "python", "{\"code\":\"# This is a program:\\nprint('hey')\"}");
const common_chat_msg message_assist_call_python_lines_unclosed =
simple_assist_msg("", "", "python", "{\"code\":\"# This is a program:\\nprint('hey')");
const common_chat_msg message_assist_json_content =
simple_assist_msg("{\n \"response\": \"Hello, world!\\nWhat's up?\"\n}");
const common_chat_msg message_assist_prefill_content = simple_assist_msg("Hello, ", "I'm thinking");
const common_chat_msg message_assist_prefill_reasoning = simple_assist_msg("", "I'm");
// Use for PEG parser implementations
struct peg_test_case {
common_chat_templates_inputs params;
std::string input;
common_chat_msg expect;
bool is_partial = false;
bool expect_reconstruction = false;
};
struct make_peg_parser {
common_chat_params params_;
common_peg_arena arena_;
bool detailed_debug_;
make_peg_parser(common_chat_templates * tmpls,
const common_chat_templates_inputs & inputs,
bool detailed_debug = false) {
detailed_debug_ = detailed_debug;
params_ = common_chat_templates_apply(tmpls, inputs);
arena_.load(params_.parser);
}
common_chat_msg parse(const std::string & msg, bool is_partial) const {
common_chat_parser_params parser_params(params_);
parser_params.debug = detailed_debug_;
return common_chat_peg_parse(arena_, msg, is_partial, parser_params);
}
};
// Global template filter for --template flag
static std::string g_template_filter;
You can’t perform that action at this time.