chat.cpp 81 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879
  1. #include "chat.h"
  2. #include "chat-parser.h"
  3. #include "common.h"
  4. #include "json-schema-to-grammar.h"
  5. #include "log.h"
  6. #include "json-partial.h"
  7. #include "minja/chat-template.hpp"
  8. #include "minja/minja.hpp"
  9. #include "regex-partial.h"
  10. #include <cstdio>
  11. #include <exception>
  12. #include <iostream>
  13. #include <optional>
  14. #include <stdexcept>
  15. #include <string>
  16. #include <vector>
  17. static std::string format_time(const std::chrono::system_clock::time_point & now, const std::string & format) {
  18. auto time = std::chrono::system_clock::to_time_t(now);
  19. auto local_time = *std::localtime(&time);
  20. std::ostringstream ss;
  21. ss << std::put_time(&local_time, format.c_str());
  22. auto res = ss.str();
  23. return res;
  24. }
  25. static std::string string_diff(const std::string & last, const std::string & current) {
  26. if (last.empty()) {
  27. return current;
  28. }
  29. if (!string_starts_with(current, last)) {
  30. throw std::runtime_error("Invalid diff: '" + last + "' not found at start of '" + current + "'");
  31. }
  32. return current.substr(last.size());
  33. }
  34. static bool has_content_or_tool_calls(const common_chat_msg & msg) {
  35. return !msg.content.empty() || !msg.tool_calls.empty();
  36. }
  37. template <>
  38. json common_chat_msg::to_json_oaicompat() const
  39. {
  40. json message {
  41. {"role", "assistant"},
  42. };
  43. if (!reasoning_content.empty()) {
  44. message["reasoning_content"] = reasoning_content;
  45. }
  46. if (content.empty() && !tool_calls.empty()) {
  47. message["content"] = json();
  48. } else {
  49. message["content"] = content;
  50. }
  51. if (!tool_calls.empty()) {
  52. auto arr = json::array();
  53. for (const auto & tc : tool_calls) {
  54. arr.push_back({
  55. {"type", "function"},
  56. {"function", {
  57. {"name", tc.name},
  58. {"arguments", tc.arguments},
  59. }},
  60. {"id", tc.id},
  61. // // Some templates generate and require an id (sometimes in a very specific format, e.g. Mistral Nemo).
  62. // // We only generate a random id for the ones that don't generate one by themselves
  63. // // (they also won't get to see it as their template likely doesn't use it, so it's all for the client)
  64. // {"id", tc.id.empty() ? gen_tool_call_id() : tc.id},
  65. });
  66. }
  67. message["tool_calls"] = arr;
  68. }
  69. return message;
  70. }
  71. std::vector<common_chat_msg_diff> common_chat_msg_diff::compute_diffs(const common_chat_msg & previous_msg, const common_chat_msg & new_msg) {
  72. std::vector<common_chat_msg_diff> diffs;
  73. // if (previous_msg.reasoning_content != current.reasoning_content) {
  74. // auto & diff = diffs.emplace_back();
  75. // diff.reasoning_content_delta = string_diff(previous_msg.reasoning_content, current.reasoning_content);
  76. // }
  77. if (previous_msg.content != new_msg.content) {
  78. auto & diff = diffs.emplace_back();
  79. diff.content_delta = string_diff(previous_msg.content, new_msg.content);
  80. }
  81. if (new_msg.tool_calls.size() < previous_msg.tool_calls.size()) {
  82. throw std::runtime_error("Invalid diff: now finding less tool calls!");
  83. }
  84. if (!previous_msg.tool_calls.empty()) {
  85. auto idx = previous_msg.tool_calls.size() - 1;
  86. const auto & pref = previous_msg.tool_calls[idx];
  87. const auto & newf = new_msg.tool_calls[idx];
  88. if (pref.name != newf.name) {
  89. throw std::runtime_error("Invalid diff: tool call mismatch!");
  90. }
  91. auto args_diff = string_diff(pref.arguments, newf.arguments);
  92. if (!args_diff.empty() || pref.id != newf.id) {
  93. auto & diff = diffs.emplace_back();
  94. diff.tool_call_index = idx;
  95. diff.tool_call_delta.name = newf.name;
  96. if (pref.id != newf.id) {
  97. diff.tool_call_delta.id = newf.id;
  98. }
  99. diff.tool_call_delta.arguments = args_diff;
  100. }
  101. }
  102. for (size_t idx = previous_msg.tool_calls.size(); idx < new_msg.tool_calls.size(); ++idx) {
  103. auto & diff = diffs.emplace_back();
  104. diff.tool_call_index = idx;
  105. diff.tool_call_delta = new_msg.tool_calls[idx];
  106. }
  107. return diffs;
  108. }
  109. typedef minja::chat_template common_chat_template;
  110. struct common_chat_templates {
  111. bool has_explicit_template; // Model had builtin template or template overridde was specified.
  112. std::unique_ptr<common_chat_template> template_default; // always set (defaults to chatml)
  113. std::unique_ptr<common_chat_template> template_tool_use;
  114. };
  115. struct templates_params {
  116. json messages;
  117. json tools;
  118. common_chat_tool_choice tool_choice;
  119. json json_schema;
  120. bool parallel_tool_calls;
  121. bool stream;
  122. std::string grammar;
  123. bool add_generation_prompt = true;
  124. std::chrono::system_clock::time_point now = std::chrono::system_clock::now();
  125. };
  126. common_chat_tool_choice common_chat_tool_choice_parse_oaicompat(const std::string & tool_choice) {
  127. if (tool_choice == "auto") {
  128. return COMMON_CHAT_TOOL_CHOICE_AUTO;
  129. }
  130. if (tool_choice == "none") {
  131. return COMMON_CHAT_TOOL_CHOICE_NONE;
  132. }
  133. if (tool_choice == "required") {
  134. return COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  135. }
  136. throw std::runtime_error("Invalid tool_choice: " + tool_choice);
  137. }
  138. template <>
  139. std::vector<common_chat_msg> common_chat_msgs_parse_oaicompat(const json & messages) {
  140. std::vector<common_chat_msg> msgs;
  141. try {
  142. if (!messages.is_array()) {
  143. throw std::runtime_error("Expected 'messages' to be an array, got " + messages.dump());
  144. }
  145. for (const auto & message : messages) {
  146. if (!message.is_object()) {
  147. throw std::runtime_error("Expected 'message' to be an object, got " + message.dump());
  148. }
  149. common_chat_msg msg;
  150. if (!message.contains("role")) {
  151. throw std::runtime_error("Missing 'role' in message: " + message.dump());
  152. }
  153. msg.role = message.at("role");
  154. auto has_content = message.contains("content");
  155. auto has_tool_calls = message.contains("tool_calls");
  156. if (has_content) {
  157. const auto & content = message.at("content");
  158. if (content.is_string()) {
  159. msg.content = content;
  160. } else if (content.is_array()) {
  161. for (const auto & part : content) {
  162. if (!part.contains("type")) {
  163. throw std::runtime_error("Missing content part type: " + part.dump());
  164. }
  165. const auto & type = part.at("type");
  166. if (type != "text") {
  167. throw std::runtime_error("Unsupported content part type: " + type.dump());
  168. }
  169. common_chat_msg_content_part msg_part;
  170. msg_part.type = type;
  171. msg_part.text = part.at("text");
  172. msg.content_parts.push_back(msg_part);
  173. }
  174. } else if (!content.is_null()) {
  175. throw std::runtime_error("Invalid 'content' type: expected string or array, got " + content.dump() + " (ref: https://github.com/ggml-org/llama.cpp/issues/8367)");
  176. }
  177. }
  178. if (has_tool_calls) {
  179. for (const auto & tool_call : message.at("tool_calls")) {
  180. common_chat_tool_call tc;
  181. if (!tool_call.contains("type")) {
  182. throw std::runtime_error("Missing tool call type: " + tool_call.dump());
  183. }
  184. const auto & type = tool_call.at("type");
  185. if (type != "function") {
  186. throw std::runtime_error("Unsupported tool call type: " + tool_call.dump());
  187. }
  188. if (!tool_call.contains("function")) {
  189. throw std::runtime_error("Missing tool call function: " + tool_call.dump());
  190. }
  191. const auto & fc = tool_call.at("function");
  192. if (!fc.contains("name")) {
  193. throw std::runtime_error("Missing tool call name: " + tool_call.dump());
  194. }
  195. tc.name = fc.at("name");
  196. tc.arguments = fc.at("arguments");
  197. if (tool_call.contains("id")) {
  198. tc.id = tool_call.at("id");
  199. }
  200. msg.tool_calls.push_back(tc);
  201. }
  202. }
  203. if (!has_content && !has_tool_calls) {
  204. throw std::runtime_error("Expected 'content' or 'tool_calls' (ref: https://github.com/ggml-org/llama.cpp/issues/8367 & https://github.com/ggml-org/llama.cpp/issues/12279)");
  205. }
  206. if (message.contains("reasoning_content")) {
  207. msg.reasoning_content = message.at("reasoning_content");
  208. }
  209. if (message.contains("name")) {
  210. msg.tool_name = message.at("name");
  211. }
  212. if (message.contains("tool_call_id")) {
  213. msg.tool_call_id = message.at("tool_call_id");
  214. }
  215. msgs.push_back(msg);
  216. }
  217. } catch (const std::exception & e) {
  218. // @ngxson : disable otherwise it's bloating the API response
  219. // printf("%s\n", std::string("; messages = ") + messages.dump(2));
  220. throw std::runtime_error("Failed to parse messages: " + std::string(e.what()));
  221. }
  222. return msgs;
  223. }
  224. template <>
  225. json common_chat_msgs_to_json_oaicompat(const std::vector<common_chat_msg> & msgs, bool concat_typed_text) {
  226. json messages = json::array();
  227. for (const auto & msg : msgs) {
  228. if (!msg.content.empty() && !msg.content_parts.empty()) {
  229. throw std::runtime_error("Cannot specify both content and content_parts");
  230. }
  231. json jmsg {
  232. {"role", msg.role},
  233. };
  234. if (!msg.content.empty()) {
  235. jmsg["content"] = msg.content;
  236. } else if (!msg.content_parts.empty()) {
  237. if (concat_typed_text) {
  238. std::string text;
  239. for (const auto & part : msg.content_parts) {
  240. if (part.type != "text") {
  241. LOG_WRN("Ignoring content part type: %s\n", part.type.c_str());
  242. continue;
  243. }
  244. if (!text.empty()) {
  245. text += '\n';
  246. }
  247. text += part.text;
  248. }
  249. jmsg["content"] = text;
  250. } else {
  251. auto & parts = jmsg["content"] = json::array();
  252. for (const auto & part : msg.content_parts) {
  253. parts.push_back({
  254. {"type", part.type},
  255. {"text", part.text},
  256. });
  257. }
  258. }
  259. } else {
  260. jmsg["content"] = json(); // null
  261. }
  262. if (!msg.reasoning_content.empty()) {
  263. jmsg["reasoning_content"] = msg.reasoning_content;
  264. }
  265. if (!msg.tool_name.empty()) {
  266. jmsg["name"] = msg.tool_name;
  267. }
  268. if (!msg.tool_call_id.empty()) {
  269. jmsg["tool_call_id"] = msg.tool_call_id;
  270. }
  271. if (!msg.tool_calls.empty()) {
  272. auto & tool_calls = jmsg["tool_calls"] = json::array();
  273. for (const auto & tool_call : msg.tool_calls) {
  274. json tc {
  275. {"type", "function"},
  276. {"function", {
  277. {"name", tool_call.name},
  278. {"arguments", tool_call.arguments},
  279. }},
  280. };
  281. if (!tool_call.id.empty()) {
  282. tc["id"] = tool_call.id;
  283. }
  284. tool_calls.push_back(tc);
  285. }
  286. }
  287. messages.push_back(jmsg);
  288. }
  289. return messages;
  290. }
  291. template <>
  292. std::vector<common_chat_msg> common_chat_msgs_parse_oaicompat(const std::string & messages) {
  293. return common_chat_msgs_parse_oaicompat(json::parse(messages));
  294. }
  295. template <>
  296. std::vector<common_chat_tool> common_chat_tools_parse_oaicompat(const json & tools) {
  297. std::vector<common_chat_tool> result;
  298. try {
  299. if (!tools.is_null()) {
  300. if (!tools.is_array()) {
  301. throw std::runtime_error("Expected 'tools' to be an array, got " + tools.dump());
  302. }
  303. for (const auto & tool : tools) {
  304. if (!tool.contains("type")) {
  305. throw std::runtime_error("Missing tool type: " + tool.dump());
  306. }
  307. const auto & type = tool.at("type");
  308. if (!type.is_string() || type != "function") {
  309. throw std::runtime_error("Unsupported tool type: " + tool.dump());
  310. }
  311. if (!tool.contains("function")) {
  312. throw std::runtime_error("Missing tool function: " + tool.dump());
  313. }
  314. const auto & function = tool.at("function");
  315. result.push_back({
  316. /* .name = */ function.at("name"),
  317. /* .description = */ function.at("description"),
  318. /* .parameters = */ function.at("parameters").dump(),
  319. });
  320. }
  321. }
  322. } catch (const std::exception & e) {
  323. throw std::runtime_error("Failed to parse tools: " + std::string(e.what()) + "; tools = " + tools.dump(2));
  324. }
  325. return result;
  326. }
  327. template <>
  328. std::vector<common_chat_tool> common_chat_tools_parse_oaicompat(const std::string & tools) {
  329. return common_chat_tools_parse_oaicompat(json::parse(tools));
  330. }
  331. template <>
  332. json common_chat_tools_to_json_oaicompat(const std::vector<common_chat_tool> & tools) {
  333. if (tools.empty()) {
  334. return json();
  335. }
  336. auto result = json::array();
  337. for (const auto & tool : tools) {
  338. result.push_back({
  339. {"type", "function"},
  340. {"function", {
  341. {"name", tool.name},
  342. {"description", tool.description},
  343. {"parameters", json::parse(tool.parameters)},
  344. }},
  345. });
  346. }
  347. return result;
  348. }
  349. template <> json common_chat_msg_diff_to_json_oaicompat(const common_chat_msg_diff & diff) {
  350. json delta = json::object();
  351. // if (!diff.reasoning_content_delta.empty()) {
  352. // delta["reasoning_content"] = msg.reasoning_content;
  353. // }
  354. if (!diff.content_delta.empty()) {
  355. delta["content"] = diff.content_delta;
  356. }
  357. if (diff.tool_call_index != std::string::npos) {
  358. json function = json::object();
  359. if (!diff.tool_call_delta.name.empty()) {
  360. function["name"] = diff.tool_call_delta.name;
  361. }
  362. if (!diff.tool_call_delta.id.empty()) {
  363. function["id"] = diff.tool_call_delta.id;
  364. }
  365. if (!diff.tool_call_delta.arguments.empty()) {
  366. function["arguments"] = diff.tool_call_delta.arguments;
  367. }
  368. delta["tool_calls"] = json::array({
  369. json {
  370. {"index", diff.tool_call_index},
  371. {"function", function}
  372. }
  373. });
  374. }
  375. return delta;
  376. }
  377. bool common_chat_verify_template(const std::string & tmpl, bool use_jinja) {
  378. if (use_jinja) {
  379. try {
  380. common_chat_msg msg;
  381. msg.role = "user";
  382. msg.content = "test";
  383. auto tmpls = common_chat_templates_init(/* model= */ nullptr, tmpl);
  384. common_chat_templates_inputs inputs;
  385. inputs.messages = {msg};
  386. common_chat_templates_apply(tmpls.get(), inputs);
  387. return true;
  388. } catch (const std::exception & e) {
  389. LOG_ERR("%s: failed to apply template: %s\n", __func__, e.what());
  390. return false;
  391. }
  392. }
  393. llama_chat_message chat[] = {{"user", "test"}};
  394. const int res = llama_chat_apply_template(tmpl.c_str(), chat, 1, true, nullptr, 0);
  395. return res >= 0;
  396. }
  397. std::string common_chat_format_single(
  398. const struct common_chat_templates * tmpls,
  399. const std::vector<common_chat_msg> & past_msg,
  400. const common_chat_msg & new_msg,
  401. bool add_ass,
  402. bool use_jinja) {
  403. common_chat_templates_inputs inputs;
  404. inputs.use_jinja = use_jinja;
  405. std::string fmt_past_msg;
  406. if (!past_msg.empty()) {
  407. inputs.messages = past_msg;
  408. inputs.add_generation_prompt = false;
  409. fmt_past_msg = common_chat_templates_apply(tmpls, inputs).prompt;
  410. }
  411. std::ostringstream ss;
  412. // if the past_msg ends with a newline, we must preserve it in the formatted version
  413. if (add_ass && !fmt_past_msg.empty() && fmt_past_msg.back() == '\n') {
  414. ss << "\n";
  415. };
  416. // format chat with new_msg
  417. inputs.messages.push_back(new_msg);
  418. inputs.add_generation_prompt = add_ass;
  419. auto fmt_new_msg = common_chat_templates_apply(tmpls, inputs).prompt;
  420. // get the diff part
  421. ss << fmt_new_msg.substr(fmt_past_msg.size(), fmt_new_msg.size() - fmt_past_msg.size());
  422. return ss.str();
  423. }
  424. std::string common_chat_format_example(const struct common_chat_templates * tmpls, bool use_jinja) {
  425. common_chat_templates_inputs inputs;
  426. inputs.use_jinja = use_jinja;
  427. auto add_simple_msg = [&](auto role, auto content) {
  428. common_chat_msg msg;
  429. msg.role = role;
  430. msg.content = content;
  431. inputs.messages.push_back(msg);
  432. };
  433. add_simple_msg("system", "You are a helpful assistant");
  434. add_simple_msg("user", "Hello");
  435. add_simple_msg("assistant", "Hi there");
  436. add_simple_msg("user", "How are you?");
  437. return common_chat_templates_apply(tmpls, inputs).prompt;
  438. }
  439. #define CHATML_TEMPLATE_SRC \
  440. "{%- for message in messages -%}\n" \
  441. " {{- '<|im_start|>' + message.role + '\n' + message.content + '<|im_end|>\n' -}}\n" \
  442. "{%- endfor -%}\n" \
  443. "{%- if add_generation_prompt -%}\n" \
  444. " {{- '<|im_start|>assistant\n' -}}\n" \
  445. "{%- endif -%}"
  446. void common_chat_templates_free(struct common_chat_templates * tmpls) {
  447. delete tmpls;
  448. }
  449. bool common_chat_templates_was_explicit(const struct common_chat_templates * tmpls) {
  450. return tmpls->has_explicit_template;
  451. }
  452. const char * common_chat_templates_source(const struct common_chat_templates * tmpls, const char * variant) {
  453. if (variant != nullptr) {
  454. if (strcmp(variant, "tool_use") == 0) {
  455. if (tmpls->template_tool_use) {
  456. return tmpls->template_tool_use->source().c_str();
  457. }
  458. return nullptr;
  459. } else {
  460. LOG_DBG("%s: unknown template variant: %s\n", __func__, variant);
  461. }
  462. }
  463. return tmpls->template_default->source().c_str();
  464. }
  465. common_chat_templates_ptr common_chat_templates_init(
  466. const struct llama_model * model,
  467. const std::string & chat_template_override,
  468. const std::string & bos_token_override,
  469. const std::string & eos_token_override)
  470. {
  471. std::string default_template_src;
  472. std::string template_tool_use_src;
  473. bool has_explicit_template = !chat_template_override.empty();
  474. if (chat_template_override.empty()) {
  475. GGML_ASSERT(model != nullptr);
  476. const auto * str = llama_model_chat_template(model, /* name */ nullptr);
  477. if (str) {
  478. default_template_src = str;
  479. has_explicit_template = true;
  480. }
  481. str = llama_model_chat_template(model, /* name */ "tool_use");
  482. if (str) {
  483. template_tool_use_src = str;
  484. has_explicit_template = true;
  485. }
  486. } else {
  487. default_template_src = chat_template_override;
  488. }
  489. if (default_template_src.empty() || default_template_src == "chatml") {
  490. if (!template_tool_use_src.empty()) {
  491. default_template_src = template_tool_use_src;
  492. } else {
  493. default_template_src = CHATML_TEMPLATE_SRC;
  494. }
  495. }
  496. std::string token_bos = bos_token_override;
  497. std::string token_eos = eos_token_override;
  498. if (model) {
  499. const auto * vocab = llama_model_get_vocab(model);
  500. const auto get_token = [&](llama_token token, const char * name, const char * jinja_variable_name) {
  501. if (token == LLAMA_TOKEN_NULL) {
  502. if (default_template_src.find(jinja_variable_name) != std::string::npos
  503. || template_tool_use_src.find(jinja_variable_name) != std::string::npos) {
  504. LOG_WRN("common_chat_templates_init: warning: vocab does not have a %s token, jinja template won't work as intended.\n", name);
  505. }
  506. return std::string();
  507. }
  508. return common_token_to_piece(vocab, token, true);
  509. };
  510. token_bos = get_token(llama_vocab_bos(vocab), "BOS", "bos_token");
  511. token_eos = get_token(llama_vocab_eos(vocab), "EOS", "eos_token");
  512. }
  513. common_chat_templates_ptr tmpls(new common_chat_templates());
  514. tmpls->has_explicit_template = has_explicit_template;
  515. try {
  516. tmpls->template_default = std::make_unique<minja::chat_template>(default_template_src, token_bos, token_eos);
  517. } catch (const std::exception & e) {
  518. LOG_ERR("%s: failed to parse chat template (defaulting to chatml): %s \n", __func__, e.what());
  519. tmpls->template_default = std::make_unique<minja::chat_template>(CHATML_TEMPLATE_SRC, token_bos, token_eos);
  520. }
  521. if (!template_tool_use_src.empty()) {
  522. try {
  523. tmpls->template_tool_use = std::make_unique<minja::chat_template>(template_tool_use_src, token_bos, token_eos);
  524. } catch (const std::exception & e) {
  525. LOG_ERR("%s: failed to parse tool use chat template (ignoring it): %s\n", __func__, e.what());
  526. }
  527. }
  528. return tmpls;
  529. }
  530. std::string common_chat_format_name(common_chat_format format) {
  531. switch (format) {
  532. case COMMON_CHAT_FORMAT_CONTENT_ONLY: return "Content-only";
  533. case COMMON_CHAT_FORMAT_GENERIC: return "Generic";
  534. case COMMON_CHAT_FORMAT_MISTRAL_NEMO: return "Mistral Nemo";
  535. case COMMON_CHAT_FORMAT_LLAMA_3_X: return "Llama 3.x";
  536. case COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS: return "Llama 3.x with builtin tools";
  537. case COMMON_CHAT_FORMAT_DEEPSEEK_R1: return "DeepSeek R1";
  538. case COMMON_CHAT_FORMAT_FIREFUNCTION_V2: return "FireFunction v2";
  539. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2: return "Functionary v3.2";
  540. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1: return "Functionary v3.1 Llama 3.1";
  541. case COMMON_CHAT_FORMAT_HERMES_2_PRO: return "Hermes 2 Pro";
  542. case COMMON_CHAT_FORMAT_COMMAND_R7B: return "Command R7B";
  543. default:
  544. throw std::runtime_error("Unknown chat format");
  545. }
  546. }
  547. static std::string wrap_code_as_arguments(common_chat_msg_parser & builder, const std::string & code) {
  548. std::string arguments;
  549. if (builder.is_partial()) {
  550. arguments = (json {{"code", code + builder.healing_marker()}}).dump();
  551. auto idx = arguments.find(builder.healing_marker());
  552. if (idx != std::string::npos) {
  553. arguments.resize(idx);
  554. }
  555. } else {
  556. arguments = (json {{"code", code}}).dump();
  557. }
  558. return arguments;
  559. }
  560. /**
  561. * Takes a prefix regex that must have 1 group to capture the function name, a closing suffix, and expects json parameters in between.
  562. * Aggregates the prefix, suffix and in-between text into the content.
  563. */
  564. static void parse_json_tool_calls(
  565. common_chat_msg_parser & builder,
  566. const std::optional<common_regex> & block_open,
  567. const std::optional<common_regex> & function_regex_start_only,
  568. const std::optional<common_regex> & function_regex,
  569. const common_regex & close_regex,
  570. const std::optional<common_regex> & block_close,
  571. bool allow_raw_python = false,
  572. const std::function<std::string(const common_chat_msg_parser::find_regex_result & fres)> & get_function_name = nullptr) {
  573. auto parse_tool_calls = [&]() {
  574. size_t from = std::string::npos;
  575. auto first = true;
  576. while (true) {
  577. auto res = function_regex_start_only && first
  578. ? builder.try_consume_regex(*function_regex_start_only)
  579. : function_regex
  580. ? builder.try_find_regex(*function_regex, from)
  581. : std::nullopt;
  582. if (res) {
  583. std::string name;
  584. if (get_function_name) {
  585. name = get_function_name(*res);
  586. } else {
  587. GGML_ASSERT(res->groups.size() == 2);
  588. name = builder.str(res->groups[1]);
  589. }
  590. first = false;
  591. if (name.empty()) {
  592. // get_function_name signalled us that we should skip this match and treat it as content.
  593. from = res->groups[0].begin + 1;
  594. continue;
  595. }
  596. from = std::string::npos;
  597. builder.add_content(res->prelude);
  598. auto maybe_raw_python = name == "python" && allow_raw_python;
  599. if (builder.input()[builder.pos()] == '{' || !maybe_raw_python) {
  600. if (auto arguments = builder.try_consume_json_with_dumped_args({{}})) {
  601. if (!builder.add_tool_call(name, "", arguments->value) || arguments->is_partial) {
  602. throw common_chat_msg_partial_exception("incomplete tool call");
  603. }
  604. builder.consume_regex(close_regex);
  605. }
  606. continue;
  607. }
  608. if (maybe_raw_python) {
  609. auto arguments = wrap_code_as_arguments(builder, builder.consume_rest());
  610. if (!builder.add_tool_call(name, "", arguments)) {
  611. throw common_chat_msg_partial_exception("incomplete tool call");
  612. }
  613. return;
  614. }
  615. throw common_chat_msg_partial_exception("incomplete tool call");
  616. }
  617. break;
  618. }
  619. if (block_close) {
  620. builder.consume_regex(*block_close);
  621. }
  622. builder.consume_spaces();
  623. builder.add_content(builder.consume_rest());
  624. };
  625. if (block_open) {
  626. if (auto res = builder.try_find_regex(*block_open)) {
  627. builder.add_content(res->prelude);
  628. parse_tool_calls();
  629. } else {
  630. builder.add_content(builder.consume_rest());
  631. }
  632. } else {
  633. parse_tool_calls();
  634. }
  635. }
  636. static void parse_prefixed_json_tool_call_array(common_chat_msg_parser & builder, const common_regex & prefix, size_t rstrip_prefix = 0) {
  637. static const std::vector<std::vector<std::string>> args_paths = {{"arguments"}};
  638. if (auto res = builder.try_find_regex(prefix)) {
  639. builder.add_content(res->prelude);
  640. builder.move_back(rstrip_prefix);
  641. auto tool_calls = builder.consume_json_with_dumped_args(args_paths);
  642. if (!builder.add_tool_calls(tool_calls.value) || tool_calls.is_partial) {
  643. throw common_chat_msg_partial_exception("incomplete tool call array");
  644. }
  645. } else {
  646. builder.add_content(builder.consume_rest());
  647. }
  648. }
  649. static void foreach_function(const json & tools, const std::function<void(const json &)> & fn) {
  650. for (const auto & tool : tools) {
  651. if (!tool.contains("type") || tool.at("type") != "function" || !tool.contains("function")) {
  652. LOG_INF("Skipping tool without function: %s", tool.dump(2).c_str());
  653. continue;
  654. }
  655. fn(tool);
  656. }
  657. }
  658. static std::string apply(
  659. const common_chat_template & tmpl,
  660. const nlohmann::ordered_json & messages,
  661. const nlohmann::ordered_json & tools,
  662. bool add_generation_prompt,
  663. const nlohmann::ordered_json & extra_context = nlohmann::ordered_json())
  664. {
  665. minja::chat_template_inputs tmpl_inputs;
  666. tmpl_inputs.messages = messages;
  667. tmpl_inputs.tools = tools;
  668. tmpl_inputs.add_generation_prompt = add_generation_prompt;
  669. tmpl_inputs.extra_context = extra_context;
  670. // TODO: add flag to control date/time, if only for testing purposes.
  671. // tmpl_inputs.now = std::chrono::system_clock::now();
  672. minja::chat_template_options tmpl_opts;
  673. // To avoid double BOS / EOS tokens, we're manually removing begining / trailing tokens
  674. // instead of using `chat_template_options.use_bos_token = false`, since these tokens
  675. // may be needed inside the template / between messages too.
  676. auto result = tmpl.apply(tmpl_inputs, tmpl_opts);
  677. if (string_starts_with(result, tmpl.bos_token())) {
  678. result = result.substr(tmpl.bos_token().size());
  679. }
  680. if (string_ends_with(result, tmpl.eos_token())) {
  681. result = result.substr(0, result.size() - tmpl.eos_token().size());
  682. }
  683. return result;
  684. }
  685. static common_chat_params common_chat_params_init_generic(const common_chat_template & tmpl, const struct templates_params & inputs) {
  686. common_chat_params data;
  687. auto tool_call_schemas = json::array();
  688. foreach_function(inputs.tools, [&](const json & tool) {
  689. const auto & function = tool.at("function");
  690. auto tool_schema = json {
  691. {"type", "object"},
  692. {"properties", {
  693. {"name", {
  694. {"type", "string"},
  695. {"const", function.at("name")},
  696. }},
  697. {"arguments", function.at("parameters")},
  698. }},
  699. {"required", json::array({"name", "arguments"})},
  700. };
  701. if (function.contains("description")) {
  702. tool_schema["description"] = function.at("description");
  703. }
  704. if (inputs.parallel_tool_calls) {
  705. tool_schema.at("properties")["id"] = {
  706. {"type", "string"},
  707. {"minLength", 4},
  708. };
  709. tool_schema.at("required").push_back("id");
  710. }
  711. tool_call_schemas.emplace_back(tool_schema);
  712. });
  713. const auto tool_call =
  714. inputs.parallel_tool_calls
  715. ? json {
  716. {"type", "object"},
  717. {"properties", {
  718. {"tool_calls", {
  719. {"type", "array"},
  720. {"items", tool_call_schemas.size() == 1 ? tool_call_schemas[0] : json {
  721. {"anyOf", tool_call_schemas},
  722. }},
  723. {"minItems", 1},
  724. }},
  725. }},
  726. {"required", json::array({"tool_calls"})},
  727. }
  728. : json {
  729. {"type", "object"},
  730. {"properties", {
  731. {"tool_call", tool_call_schemas.size() == 1 ? tool_call_schemas[0] : json {
  732. {"anyOf", tool_call_schemas},
  733. }},
  734. }},
  735. {"required", json::array({"tool_call"})},
  736. };
  737. const auto schema =
  738. inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED
  739. ? json {
  740. {"anyOf", json::array({
  741. tool_call,
  742. {
  743. {"type", "object"},
  744. {"properties", {
  745. {"response", inputs.json_schema.is_null()
  746. ? json {{"type", "string"}}
  747. : inputs.json_schema
  748. },
  749. }},
  750. {"required", json::array({"response"})},
  751. },
  752. })}
  753. }
  754. : tool_call;
  755. data.grammar_lazy = false;
  756. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  757. builder.add_schema("root", schema);
  758. });
  759. auto tweaked_messages = common_chat_template::add_system(
  760. inputs.messages,
  761. "Respond in JSON format, either with `tool_call` (a request to call tools) or with `response` reply to the user's request");
  762. data.prompt = apply(tmpl, tweaked_messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
  763. data.format = COMMON_CHAT_FORMAT_GENERIC;
  764. return data;
  765. }
  766. static void common_chat_parse_generic(common_chat_msg_parser & builder) {
  767. static const std::vector<std::vector<std::string>> content_paths = {
  768. {"response"},
  769. };
  770. static const std::vector<std::vector<std::string>> args_paths = {
  771. {"tool_call", "arguments"},
  772. {"tool_calls", "arguments"},
  773. };
  774. auto data = builder.consume_json_with_dumped_args(args_paths, content_paths);
  775. if (data.value.contains("tool_calls")) {
  776. if (!builder.add_tool_calls(data.value.at("tool_calls")) || data.is_partial) {
  777. throw common_chat_msg_partial_exception("incomplete tool calls");
  778. }
  779. } else if (data.value.contains("tool_call")) {
  780. if (!builder.add_tool_call(data.value.at("tool_call")) || data.is_partial) {
  781. throw common_chat_msg_partial_exception("incomplete tool call");
  782. }
  783. } else if (data.value.contains("response")) {
  784. const auto & response = data.value.at("response");
  785. builder.add_content(response.is_string() ? response.template get<std::string>() : response.dump(2));
  786. if (data.is_partial) {
  787. throw common_chat_msg_partial_exception("incomplete response");
  788. }
  789. } else {
  790. throw common_chat_msg_partial_exception("Expected 'tool_call', 'tool_calls' or 'response' in JSON");
  791. }
  792. }
  793. static common_chat_params common_chat_params_init_mistral_nemo(const common_chat_template & tmpl, const struct templates_params & inputs) {
  794. common_chat_params data;
  795. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  796. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  797. auto schemas = json::array();
  798. foreach_function(inputs.tools, [&](const json & tool) {
  799. const auto & function = tool.at("function");
  800. schemas.push_back({
  801. {"type", "object"},
  802. {"properties", {
  803. // Important note: the model is probably trained to take a JSON stringified arguments value.
  804. // It's hard to constrain that for now (while reusing the JSON schema conversion), so we're just expecting a plain object.
  805. {"name", {
  806. {"type", "string"},
  807. {"const", function.at("name")},
  808. }},
  809. {"arguments", function.at("parameters")},
  810. {"id", {
  811. {"type", "string"},
  812. // Nemo's template expects a 9-character alphanumeric ID.
  813. {"pattern", "^[a-zA-Z0-9]{9}$"},
  814. }},
  815. }},
  816. {"required", json::array({"name", "arguments", "id"})},
  817. });
  818. });
  819. auto schema = json {
  820. {"type", "array"},
  821. {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}},
  822. {"minItems", 1},
  823. };
  824. if (!inputs.parallel_tool_calls) {
  825. schema["maxItems"] = 1;
  826. }
  827. builder.add_rule("root", "\"[TOOL_CALLS]\" " + builder.add_schema("tool_calls", schema));
  828. });
  829. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "[TOOL_CALLS]"});
  830. data.preserved_tokens = {
  831. "[TOOL_CALLS]",
  832. };
  833. data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
  834. data.format = COMMON_CHAT_FORMAT_MISTRAL_NEMO;
  835. return data;
  836. }
  837. static void common_chat_parse_mistral_nemo(common_chat_msg_parser & builder) {
  838. static const common_regex prefix(regex_escape("[TOOL_CALLS]"));
  839. parse_prefixed_json_tool_call_array(builder, prefix);
  840. }
  841. static common_chat_params common_chat_params_init_command_r7b(const common_chat_template & tmpl, const struct templates_params & inputs) {
  842. common_chat_params data;
  843. auto adjusted_messages = json::array();
  844. for (const auto & msg : inputs.messages) {
  845. auto has_reasoning_content = msg.contains("reasoning_content") && msg.at("reasoning_content").is_string();
  846. auto has_tool_calls = msg.contains("tool_calls") && msg.at("tool_calls").is_array();
  847. if (has_reasoning_content && has_tool_calls) {
  848. auto adjusted_message = msg;
  849. adjusted_message["tool_plan"] = msg.at("reasoning_content");
  850. adjusted_message.erase("reasoning_content");
  851. adjusted_messages.push_back(adjusted_message);
  852. } else {
  853. adjusted_messages.push_back(msg);
  854. }
  855. }
  856. data.prompt = apply(tmpl, adjusted_messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt, {});
  857. data.format = COMMON_CHAT_FORMAT_COMMAND_R7B;
  858. if (string_ends_with(data.prompt, "<|START_THINKING|>")) {
  859. data.thinking_forced_open = true;
  860. }
  861. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  862. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  863. auto schemas = json::array();
  864. foreach_function(inputs.tools, [&](const json & tool) {
  865. const auto & function = tool.at("function");
  866. schemas.push_back({
  867. {"type", "object"},
  868. {"properties", {
  869. {"tool_call_id", {
  870. {"type", "string"},
  871. // Command-R's template expects an integer string.
  872. {"pattern", "^[0-9]{1,10}$"},
  873. }},
  874. {"tool_name", {
  875. {"type", "string"},
  876. {"const", function.at("name")},
  877. }},
  878. {"parameters", function.at("parameters")},
  879. }},
  880. {"required", json::array({"tool_call_id", "tool_name", "parameters"})},
  881. });
  882. });
  883. auto schema = json {
  884. {"type", "array"},
  885. {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}},
  886. {"minItems", 1},
  887. };
  888. if (!inputs.parallel_tool_calls) {
  889. schema["maxItems"] = 1;
  890. }
  891. builder.add_rule("root",
  892. std::string(data.thinking_forced_open ? "( \"<|END_THINKING|>\" space )? " : "") +
  893. "\"<|START_ACTION|>\" " + builder.add_schema("tool_calls", schema) + " \"<|END_ACTION|>\"");
  894. });
  895. data.grammar_triggers.push_back({
  896. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  897. // If thinking_forced_open, then we capture the </think> tag in the grammar,
  898. // (important for required tool choice) and in the trigger's first capture (decides what is sent to the grammar)
  899. std::string(data.thinking_forced_open ? "[\\s\\S]*?(<\\|END_THINKING\\|>\\s*)" : "(?:<\\|START_THINKING\\|>[\\s\\S]*?<\\|END_THINKING\\|>\\s*)?") +
  900. "(<\\|START_ACTION\\|>)[\\s\\S]*"
  901. });
  902. data.preserved_tokens = {
  903. "<|START_ACTION|>",
  904. "<|END_ACTION|>",
  905. "<|START_RESPONSE|>",
  906. "<|END_RESPONSE|>",
  907. "<|START_THINKING|>",
  908. "<|END_THINKING|>",
  909. };
  910. return data;
  911. }
  912. static void common_chat_parse_command_r7b(common_chat_msg_parser & builder) {
  913. builder.try_parse_reasoning("<|START_THINKING|>", "<|END_THINKING|>");
  914. static const common_regex start_action_regex("<\\|START_ACTION\\|>");
  915. static const common_regex end_action_regex("<\\|END_ACTION\\|>");
  916. static const common_regex start_response_regex("<\\|START_RESPONSE\\|>");
  917. static const common_regex end_response_regex("<\\|END_RESPONSE\\|>");
  918. if (auto res = builder.try_find_regex(start_action_regex)) {
  919. // If we didn't extract thoughts, prelude includes them.
  920. builder.add_content(res->prelude);
  921. auto tool_calls = builder.consume_json_with_dumped_args({{"parameters"}});
  922. for (const auto & tool_call : tool_calls.value) {
  923. std::string name = tool_call.contains("tool_name") ? tool_call.at("tool_name") : "";
  924. std::string id = tool_call.contains("tool_call_id") ? tool_call.at("tool_call_id") : "";
  925. std::string arguments = tool_call.contains("parameters") ? tool_call.at("parameters") : "";
  926. if (!builder.add_tool_call(name, id, arguments) || tool_calls.is_partial) {
  927. throw common_chat_msg_partial_exception("incomplete tool call");
  928. }
  929. }
  930. if (tool_calls.is_partial) {
  931. throw common_chat_msg_partial_exception("incomplete tool call");
  932. }
  933. builder.consume_regex(end_action_regex);
  934. } else if (auto res = builder.try_find_regex(start_response_regex)) {
  935. // If we didn't extract thoughts, prelude includes them.
  936. builder.add_content(res->prelude);
  937. if (auto res = builder.try_find_regex(end_response_regex)) {
  938. builder.add_content(res->prelude);
  939. } else {
  940. builder.add_content(builder.consume_rest());
  941. throw common_chat_msg_partial_exception(end_response_regex.str());
  942. }
  943. } else {
  944. builder.add_content(builder.consume_rest());
  945. }
  946. }
  947. static void expect_tool_parameters(const std::string & name, const json & parameters, const std::vector<std::string> & expected_properties) {
  948. if (!parameters.is_object() || !parameters.contains("type") || parameters.at("type") != "object" || !parameters.contains("properties") || !parameters.contains("required")) {
  949. throw std::runtime_error("Parameters of tool " + name + " must be an object w/ required properties");
  950. }
  951. const auto & parameters_properties = parameters.at("properties");
  952. const auto & parameters_required = parameters.at("required");
  953. for (const auto & prop : expected_properties) {
  954. if (!parameters_properties.contains(prop)) {
  955. throw std::runtime_error("Parameters of tool " + name + " is missing property: " + prop); // NOLINT
  956. }
  957. if (std::find(parameters_required.begin(), parameters_required.end(), json(prop)) == parameters_required.end()) {
  958. throw std::runtime_error("Parameters of tool " + name + " must have property marked as required: " + prop); // NOLINT
  959. }
  960. }
  961. if (parameters_properties.size() != expected_properties.size()) {
  962. throw std::runtime_error("Parameters of tool " + name + " must only have these properties:" + string_join(expected_properties, ", "));
  963. }
  964. }
  965. 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) {
  966. auto builtin_tools = json::array();
  967. common_chat_params data;
  968. if (!inputs.tools.is_null()) {
  969. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  970. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  971. std::vector<std::string> tool_rules;
  972. auto handle_builtin_tool = [&](const std::string & name, const json & parameters) {
  973. if (name == "wolfram_alpha" || name == "web_search" || name == "brave_search") {
  974. // https://github.com/meta-llama/llama-stack/blob/main/llama_stack/providers/remote/tool_runtime/wolfram_alpha/wolfram_alpha.py
  975. // https://github.com/meta-llama/llama-stack/blob/main/llama_stack/providers/remote/tool_runtime/brave_search/brave_search.py
  976. expect_tool_parameters(name, parameters, {"query"});
  977. } else if (name == "python" || name == "code_interpreter") {
  978. // https://github.com/meta-llama/llama-stack/blob/main/llama_stack/providers/inline/tool_runtime/code_interpreter/code_interpreter.py
  979. expect_tool_parameters(name, parameters, {"code"});
  980. } else {
  981. return false;
  982. }
  983. std::vector<std::string> kvs;
  984. for (const auto & [key, value] : parameters.at("properties").items()) {
  985. kvs.push_back("\"" + key + "=\" " + builder.add_schema(name + "-args-" + key, value)); // NOLINT
  986. }
  987. tool_rules.push_back(
  988. builder.add_rule(
  989. name + "-call",
  990. "\"<|python_tag|>" + name + ".call(\" " + string_join(kvs, " \", \" ") + " \")\""));
  991. builtin_tools.push_back(name);
  992. return true;
  993. };
  994. foreach_function(inputs.tools, [&](const json & tool) {
  995. const auto & function = tool.at("function");
  996. std::string name = function.at("name");
  997. auto parameters = function.at("parameters");
  998. builder.resolve_refs(parameters);
  999. // https://github.com/meta-llama/llama-stack/tree/main/llama_stack/providers/remote/tool_runtime
  1000. if (allow_python_tag_builtin_tools) {
  1001. handle_builtin_tool(name, parameters);
  1002. }
  1003. tool_rules.push_back(
  1004. builder.add_rule(
  1005. name + "-call",
  1006. "\"{\" space "
  1007. "( \"\\\"type\\\"\" space \":\" space \"\\\"function\\\"\" space \",\" space )? "
  1008. " \"\\\"name\\\"\" space \":\" space \"\\\"" + name + "\\\"\" space \",\" space "
  1009. " \"\\\"parameters\\\"\" space \":\" space " + builder.add_schema(name + "-args", parameters) + " "
  1010. "\"}\" space"));
  1011. });
  1012. // Small models may hallucinate function names so we match anything (*at the start*) that looks like the JSON of a function call, regardless of the name.
  1013. data.grammar_triggers.push_back({
  1014. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1015. "(\\{\\s*(?:\"type\"\\s*:\\s*\"function\"\\s*,\\s*)?\"name\"\\s*:\\s*\")[\\s\\S]*", // + name + "\"[\\s\\S]*",
  1016. });
  1017. if (!builtin_tools.empty()) {
  1018. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<|python_tag|>"});
  1019. data.preserved_tokens.push_back("<|python_tag|>");
  1020. }
  1021. // Allow a few empty lines on top of the usual constrained json schema space rule.
  1022. builder.add_rule("root", string_join(tool_rules, " | "));
  1023. data.additional_stops.push_back("<|eom_id|>");
  1024. });
  1025. data.format = allow_python_tag_builtin_tools && !builtin_tools.empty()
  1026. ? COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS
  1027. : COMMON_CHAT_FORMAT_LLAMA_3_X;
  1028. } else {
  1029. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1030. }
  1031. data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt, {
  1032. {"date_string", format_time(inputs.now, "%d %b %Y")},
  1033. {"tools_in_user_message", false},
  1034. {"builtin_tools", builtin_tools.empty() ? json() : builtin_tools},
  1035. });
  1036. return data;
  1037. }
  1038. static void common_chat_parse_llama_3_1(common_chat_msg_parser & builder, bool with_builtin_tools = false) {
  1039. static const common_regex function_regex(
  1040. "\\s*\\{\\s*(?:\"type\"\\s*:\\s*\"function\"\\s*,\\s*)?\"name\"\\s*:\\s*\"([^\"]+)\"\\s*,\\s*\"parameters\"\\s*: ");
  1041. static const common_regex close_regex("\\}\\s*");
  1042. static const common_regex function_name_regex("\\s*(\\w+)\\s*\\.\\s*call\\(");
  1043. static const common_regex arg_name_regex("\\s*(\\w+)\\s*=\\s*");
  1044. if (with_builtin_tools) {
  1045. static const common_regex builtin_call_regex("<\\|python_tag\\|>");
  1046. if (auto res = builder.try_find_regex(builtin_call_regex)) {
  1047. builder.add_content(res->prelude);
  1048. auto fun_res = builder.consume_regex(function_name_regex);
  1049. auto function_name = builder.str(fun_res.groups[1]);
  1050. common_healing_marker healing_marker;
  1051. json args = json::object();
  1052. while (true) {
  1053. if (auto arg_res = builder.try_consume_regex(arg_name_regex)) {
  1054. auto arg_name = builder.str(arg_res->groups[1]);
  1055. auto partial = builder.consume_json();
  1056. args[arg_name] = partial.json;
  1057. healing_marker.marker = partial.healing_marker.marker;
  1058. healing_marker.json_dump_marker = partial.healing_marker.json_dump_marker;
  1059. builder.consume_spaces();
  1060. if (!builder.try_consume_literal(",")) {
  1061. break;
  1062. }
  1063. } else {
  1064. break;
  1065. }
  1066. }
  1067. builder.consume_literal(")");
  1068. builder.consume_spaces();
  1069. auto arguments = args.dump();
  1070. if (!builder.add_tool_call(function_name, "", arguments)) {
  1071. throw common_chat_msg_partial_exception("Incomplete tool call");
  1072. }
  1073. return;
  1074. }
  1075. }
  1076. parse_json_tool_calls(
  1077. builder,
  1078. /* block_open= */ std::nullopt,
  1079. /* function_regex_start_only= */ function_regex,
  1080. /* function_regex= */ std::nullopt,
  1081. close_regex,
  1082. std::nullopt);
  1083. }
  1084. static common_chat_params common_chat_params_init_deepseek_r1(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1085. common_chat_params data;
  1086. auto prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
  1087. // Hacks to fix the official (broken) prompt.
  1088. // It is advisable to use --chat-template-file models/templates/llama-cpp-deepseek-r1.jinja instead,
  1089. // until the official template is fixed.
  1090. if (tmpl.source().find("{% if ns.is_tool %}{{'<|tool▁outputs▁end|>'}}") != std::string::npos) {
  1091. // Don't leave the chat dangling after tool results
  1092. if (string_ends_with(prompt, "<|tool▁outputs▁end|>")) {
  1093. prompt += "<|end▁of▁sentence|>";
  1094. if (inputs.add_generation_prompt) {
  1095. prompt += "<|Assistant|>";
  1096. }
  1097. }
  1098. // Fix up tool call delta example added by Minja
  1099. prompt = std::regex_replace(
  1100. prompt,
  1101. std::regex("(<|tool▁call▁end|>)[\\s\\r\\n]*(<|tool▁outputs▁begin|>|<|User|>)"),
  1102. "$1<|tool▁calls▁end|><|end▁of▁sentence|>$2");
  1103. }
  1104. data.prompt = prompt;
  1105. data.format = COMMON_CHAT_FORMAT_DEEPSEEK_R1;
  1106. if (string_ends_with(data.prompt, "<think>\n")) {
  1107. data.thinking_forced_open = true;
  1108. }
  1109. if (inputs.tools.is_array() && !inputs.tools.empty()) {
  1110. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED && inputs.json_schema.is_null();
  1111. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1112. std::vector<std::string> tool_rules;
  1113. foreach_function(inputs.tools, [&](const json & tool) {
  1114. const auto & function = tool.at("function");
  1115. std::string name = function.at("name");
  1116. auto parameters = function.at("parameters");
  1117. builder.resolve_refs(parameters);
  1118. tool_rules.push_back(builder.add_rule(name + "-call",
  1119. "( \"<|tool▁call▁begin|>\" )? \"function<|tool▁sep|>" + name + "\\n"
  1120. "```json\\n\" " + builder.add_schema(name + "-args", parameters) + " "
  1121. "\"```<|tool▁call▁end|>\""));
  1122. });
  1123. // Distill Qwen 7B & 32B models seem confused re/ syntax of their tool call opening tag,
  1124. // so we accept common variants (then it's all constrained)
  1125. builder.add_rule("root",
  1126. std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") +
  1127. "( \"<|tool▁calls▁begin|>\" | \"<|tool_calls_begin|>\" | \"<|tool calls begin|>\" | \"<|tool\\\\_calls\\\\_begin|>\" | \"<|tool▁calls|>\" ) "
  1128. "(" + string_join(tool_rules, " | ") + ")" + (inputs.parallel_tool_calls ? "*" : "") + " "
  1129. "\"<|tool▁calls▁end|>\""
  1130. " space");
  1131. data.grammar_triggers.push_back({
  1132. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1133. // If thinking_forced_open, then we capture the </think> tag in the grammar,
  1134. // (important for required tool choice) and in the trigger's first capture (decides what is sent to the grammar)
  1135. std::string(data.thinking_forced_open ? "[\\s\\S]*?(</think>\\s*)" : "(?:<think>[\\s\\S]*?</think>\\s*)?") +
  1136. "(<|tool▁calls▁begin|>|<|tool_calls_begin|>|<|tool calls begin|>|<|tool\\\\_calls\\\\_begin|>|<|tool▁calls|>)[\\s\\S]*"
  1137. });
  1138. data.preserved_tokens = {
  1139. "<think>",
  1140. "</think>",
  1141. "<|tool▁calls▁begin|>",
  1142. "<|tool▁call▁begin|>",
  1143. "<|tool▁sep|>",
  1144. "<|tool▁call▁end|>",
  1145. "<|tool▁calls▁end|",
  1146. };
  1147. });
  1148. }
  1149. return data;
  1150. }
  1151. static void common_chat_parse_deepseek_r1(common_chat_msg_parser & builder) {
  1152. builder.try_parse_reasoning("<think>", "</think>");
  1153. static const common_regex tool_calls_begin("(?:<|tool▁calls▁begin|>|<|tool_calls_begin|>|<|tool calls begin|>|<|tool\\\\_calls\\\\_begin|>|<|tool▁calls|>)");
  1154. static const common_regex tool_calls_end("<|tool▁calls▁end|>");
  1155. static const common_regex function_regex("(?:<|tool▁call▁begin|>)?function<|tool▁sep|>([^\n]+)\n```json\n");
  1156. static const common_regex close_regex("```[\\s\\r\\n]*<|tool▁call▁end|>");
  1157. parse_json_tool_calls(
  1158. builder,
  1159. /* block_open= */ tool_calls_begin,
  1160. /* function_regex_start_only= */ std::nullopt,
  1161. function_regex,
  1162. close_regex,
  1163. tool_calls_end);
  1164. }
  1165. static common_chat_params common_chat_params_init_firefunction_v2(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1166. LOG_DBG("%s\n", __func__);
  1167. common_chat_params data;
  1168. data.prompt = apply(tmpl, inputs.messages, /* tools= */ nullptr, inputs.add_generation_prompt, {
  1169. {"datetime", format_time(inputs.now, "%b %d %Y %H:%M:%S GMT")},
  1170. {"functions", json(inputs.tools.empty() ? "" : inputs.tools.dump(2))},
  1171. });
  1172. if (inputs.tools.is_array() && !inputs.tools.empty()) {
  1173. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1174. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1175. auto schemas = json::array();
  1176. foreach_function(inputs.tools, [&](const json & tool) {
  1177. const auto & function = tool.at("function");
  1178. schemas.push_back({
  1179. {"type", "object"},
  1180. {"properties", {
  1181. {"name", {
  1182. {"type", "string"},
  1183. {"const", function.at("name")},
  1184. }},
  1185. {"arguments", function.at("parameters")},
  1186. }},
  1187. {"required", json::array({"name", "arguments", "id"})},
  1188. });
  1189. });
  1190. auto schema = json {
  1191. {"type", "array"},
  1192. {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}},
  1193. {"minItems", 1},
  1194. };
  1195. if (!inputs.parallel_tool_calls) {
  1196. schema["maxItems"] = 1;
  1197. }
  1198. builder.add_rule("root", "\" functools\"? " + builder.add_schema("tool_calls", schema));
  1199. });
  1200. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, " functools["});
  1201. data.preserved_tokens = {
  1202. " functools[",
  1203. };
  1204. data.format = COMMON_CHAT_FORMAT_FIREFUNCTION_V2;
  1205. } else {
  1206. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1207. }
  1208. return data;
  1209. }
  1210. static void common_chat_parse_firefunction_v2(common_chat_msg_parser & builder) {
  1211. static const common_regex prefix(regex_escape(" functools["));
  1212. parse_prefixed_json_tool_call_array(builder, prefix, /* rstrip_prefix= */ 1);
  1213. }
  1214. static common_chat_params common_chat_params_init_functionary_v3_2(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1215. // >>>all\nlet's call functions>>>fn1\n{"arg1": 1...}\n>>>fn2\n{"arg1": 1...}...
  1216. // Using ">>>f1\n", ">>>f2\n"... as trigger words for the grammar
  1217. // If the function is python, we also allow raw python code (if the line after `python\n` doesn't start w/ opening `{`), which the model seems to prefer for multiline code.
  1218. common_chat_params data;
  1219. data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
  1220. data.format = COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2;
  1221. if (inputs.tools.is_array() && !inputs.tools.empty()) {
  1222. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1223. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1224. std::vector<std::string> first_tool_rules;
  1225. std::vector<std::string> subsequent_tool_rules;
  1226. foreach_function(inputs.tools, [&](const json & tool) {
  1227. const auto & function = tool.at("function");
  1228. std::string name = function.at("name");
  1229. auto parameters = function.at("parameters");
  1230. builder.resolve_refs(parameters);
  1231. std::string args_pattern = "[\\s\\S]*";
  1232. auto args_rule = builder.add_schema(name + "-args", parameters);
  1233. if (name == "python") {
  1234. args_rule = builder.add_rule(name + "-maybe-raw-args", args_rule + " | [^{] .*");
  1235. } else {
  1236. args_pattern = "\\{" + args_pattern;
  1237. }
  1238. auto call_rule = builder.add_rule(name + "-call", "\"" + name + "\\n\" " + args_rule);
  1239. first_tool_rules.push_back(call_rule);
  1240. if (inputs.parallel_tool_calls) {
  1241. subsequent_tool_rules.push_back(builder.add_rule(name + "-call2", "\">>>\" " + call_rule));
  1242. }
  1243. data.grammar_triggers.push_back({
  1244. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1245. "((?:[\\s\\S]+?>>>)?" + regex_escape(name) + "\n)" + args_pattern,
  1246. });
  1247. });
  1248. data.preserved_tokens = {
  1249. "<|end_header_id|>",
  1250. };
  1251. auto first_rule = first_tool_rules.empty() ? "" : builder.add_rule("first_tool_call", string_join(first_tool_rules, " | ")) + " space";
  1252. if (inputs.parallel_tool_calls) {
  1253. auto subsequent_rule = builder.add_rule("subsequent_tool_call", string_join(subsequent_tool_rules, " | ")) + " space";
  1254. builder.add_rule("root", first_rule + " (" + subsequent_rule + ")*");
  1255. } else {
  1256. builder.add_rule("root", first_rule);
  1257. }
  1258. });
  1259. }
  1260. return data;
  1261. }
  1262. static void common_chat_parse_functionary_v3_2(common_chat_msg_parser & builder) {
  1263. static const common_regex function_regex_start_only(R"((\w+\n\{|python\n|all\n))");
  1264. static const common_regex function_regex(R"(>>>(\w+\n\{|python\n|all\n))");
  1265. static const common_regex close_regex(R"(\s*)");
  1266. parse_json_tool_calls(
  1267. builder,
  1268. std::nullopt,
  1269. function_regex_start_only,
  1270. function_regex,
  1271. close_regex,
  1272. std::nullopt,
  1273. /* allow_raw_python= */ true,
  1274. /* get_function_name= */ [&](const auto & res) -> std::string {
  1275. auto at_start = res.groups[0].begin == 0;
  1276. auto name = builder.str(res.groups[1]);
  1277. if (!name.empty() && name.back() == '{') {
  1278. // Unconsume the opening brace '{' to ensure the JSON parsing goes well.
  1279. builder.move_back(1);
  1280. }
  1281. auto idx = name.find_last_not_of("\n{");
  1282. name = name.substr(0, idx + 1);
  1283. if (at_start && name == "all") {
  1284. return "";
  1285. }
  1286. return name;
  1287. });
  1288. }
  1289. static common_chat_params common_chat_params_init_functionary_v3_1_llama_3_1(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1290. // https://github.com/MeetKai/functionary/blob/main/tests/prompt_test_v3-llama3.1.txt
  1291. common_chat_params data;
  1292. if (!inputs.tools.is_null()) {
  1293. std::string python_code_argument_name;
  1294. auto has_raw_python = false;
  1295. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1296. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1297. std::vector<std::string> tool_rules;
  1298. foreach_function(inputs.tools, [&](const json & tool) {
  1299. const auto & function = tool.at("function");
  1300. const auto & parameters = function.at("parameters");
  1301. std::string name = function.at("name");
  1302. if (name == "python" || name == "ipython") {
  1303. if (!parameters.contains("type")) {
  1304. throw std::runtime_error("Missing type in python tool");
  1305. }
  1306. has_raw_python = true;
  1307. const auto & type = parameters.at("type");
  1308. if (type == "object") {
  1309. auto properties = parameters.at("properties");
  1310. for (auto it = properties.begin(); it != properties.end(); ++it) {
  1311. if (it.value().at("type") == "string") {
  1312. if (!python_code_argument_name.empty()) {
  1313. throw std::runtime_error("Multiple string arguments found in python tool");
  1314. }
  1315. python_code_argument_name = it.key();
  1316. }
  1317. }
  1318. if (python_code_argument_name.empty()) {
  1319. throw std::runtime_error("No string argument found in python tool");
  1320. }
  1321. } else if (type != "string") {
  1322. throw std::runtime_error("Invalid type in python tool: " + type.dump());
  1323. }
  1324. }
  1325. tool_rules.push_back(builder.add_rule(name + "-call", "\"<function=" + name + ">\" " + builder.add_schema(name + "-args", parameters) + " \"</function>\" space"));
  1326. });
  1327. if (has_raw_python) {
  1328. tool_rules.push_back(builder.add_rule("python-call", "\"<|python_tag|>\" .*"));
  1329. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<|python_tag|>"});
  1330. data.preserved_tokens.push_back("<|python_tag|>");
  1331. }
  1332. auto tool_call = builder.add_rule("tool_call", string_join(tool_rules, " | ")) + " space";
  1333. builder.add_rule("root", inputs.parallel_tool_calls ? "(" + tool_call + ")+" : tool_call);
  1334. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<function="});
  1335. });
  1336. data.format = COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1;
  1337. } else {
  1338. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1339. }
  1340. data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
  1341. // TODO: if (has_raw_python)
  1342. return data;
  1343. }
  1344. static void common_chat_parse_functionary_v3_1_llama_3_1(common_chat_msg_parser & builder) {
  1345. // This version of Functionary still supports the llama 3.1 tool call format for the python tool.
  1346. static const common_regex python_tag_regex(regex_escape("<|python_tag|>"));
  1347. if (auto res = builder.try_find_regex(python_tag_regex)) {
  1348. builder.add_content(res->prelude);
  1349. auto arguments = wrap_code_as_arguments(builder, builder.consume_rest());
  1350. builder.add_tool_call("python", "", arguments);
  1351. return;
  1352. }
  1353. static const common_regex function_regex(R"(<function=(\w+)>)");
  1354. static const common_regex close_regex(R"(</function>)");
  1355. parse_json_tool_calls(
  1356. builder,
  1357. /* block_open= */ std::nullopt,
  1358. /* function_regex_start_only= */ std::nullopt,
  1359. function_regex,
  1360. close_regex,
  1361. std::nullopt);
  1362. }
  1363. static common_chat_params common_chat_params_init_hermes_2_pro(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1364. common_chat_params data;
  1365. data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
  1366. data.format = COMMON_CHAT_FORMAT_HERMES_2_PRO;
  1367. if (string_ends_with(data.prompt, "<think>\n")) {
  1368. data.thinking_forced_open = true;
  1369. }
  1370. // (content)?(<tool_call>{"name": "foo", "arguments": {"a": 1}}</tool_call>)*
  1371. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1372. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1373. std::vector<std::string> tool_rules;
  1374. std::vector<std::string> tool_call_alts;
  1375. std::vector<std::string> escaped_names;
  1376. foreach_function(inputs.tools, [&](const json & tool) {
  1377. const auto & function = tool.at("function");
  1378. std::string name = function.at("name");
  1379. auto parameters = function.at("parameters");
  1380. builder.resolve_refs(parameters);
  1381. tool_rules.push_back(builder.add_schema(name + "-call", {
  1382. {"type", "object"},
  1383. {"properties", json {
  1384. {"name", json {{"const", name}}},
  1385. {"arguments", parameters},
  1386. }},
  1387. {"required", json::array({"name", "arguments"})},
  1388. }));
  1389. tool_call_alts.push_back(builder.add_rule(
  1390. name + "-function-tag",
  1391. "\"<function\" ( \"=" + name + "\" | \" name=\\\"" + name + "\\\"\" ) \">\" space " +
  1392. builder.add_schema(name + "-args", parameters) + " "
  1393. "\"</function>\" space"));
  1394. data.grammar_triggers.push_back({
  1395. COMMON_GRAMMAR_TRIGGER_TYPE_WORD,
  1396. "<function=" + name + ">",
  1397. });
  1398. auto escaped_name = regex_escape(name);
  1399. data.grammar_triggers.push_back({
  1400. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN,
  1401. "<function\\s+name\\s*=\\s*\"" + escaped_name + "\"",
  1402. });
  1403. escaped_names.push_back(escaped_name);
  1404. });
  1405. auto any_tool_call = builder.add_rule("any_tool_call", "( " + string_join(tool_rules, " | ") + " ) space");
  1406. std::vector<std::string> alt_tags {
  1407. any_tool_call,
  1408. "\"<tool_call>\" space " + any_tool_call + " \"</tool_call>\"",
  1409. // The rest is just to accommodate common "good bad" outputs.
  1410. "\"<function_call>\" space " + any_tool_call + " \"</function_call>\"",
  1411. "\"<response>\" space " + any_tool_call + " \"</response>\"",
  1412. "\"<tools>\" space " + any_tool_call + " \"</tools>\"",
  1413. "\"<json>\" space " + any_tool_call + " \"</json>\"",
  1414. "\"<xml>\" space " + any_tool_call + " \"</xml>\"",
  1415. "\"<JSON>\" space " + any_tool_call + " \"</JSON>\"",
  1416. };
  1417. auto wrappable_tool_call = builder.add_rule("wrappable_tool_call", "( " + string_join(alt_tags, " | ") + " ) space");
  1418. tool_call_alts.push_back(wrappable_tool_call);
  1419. tool_call_alts.push_back(
  1420. "( \"```\\n\" | \"```json\\n\" | \"```xml\\n\" ) space " + wrappable_tool_call + " space \"```\" space ");
  1421. auto tool_call = builder.add_rule("tool_call", string_join(tool_call_alts, " | "));
  1422. builder.add_rule("root",
  1423. std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") +
  1424. (inputs.parallel_tool_calls ? "(" + tool_call + ")+" : tool_call));
  1425. // Trigger on some common known "good bad" outputs (only from the start and with a json that's about a specific argument name to avoid false positives)
  1426. data.grammar_triggers.push_back({
  1427. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1428. // If thinking_forced_open, then we capture the </think> tag in the grammar,
  1429. // (important for required tool choice) and in the trigger's first capture (decides what is sent to the grammar)
  1430. std::string(data.thinking_forced_open ? "[\\s\\S]*?(</think>\\s*)" : "(?:<think>[\\s\\S]*?</think>\\s*)?") + (
  1431. "(\\s*"
  1432. "(?:<tool_call>"
  1433. "|<function"
  1434. "|(?:```(?:json|xml)?\n\\s*)?(?:<function_call>|<tools>|<xml><json>|<response>)?"
  1435. "\\s*\\{\\s*\"name\"\\s*:\\s*\"(?:" + string_join(escaped_names, "|") + ")\""
  1436. ")"
  1437. ")[\\s\\S]*"
  1438. ),
  1439. });
  1440. data.preserved_tokens = {
  1441. "<think>",
  1442. "</think>",
  1443. "<tool_call>",
  1444. "</tool_call>",
  1445. "<function",
  1446. "<tools>",
  1447. "</tools>",
  1448. "<response>",
  1449. "</response>",
  1450. "<function_call>",
  1451. "</function_call>",
  1452. "<json>",
  1453. "</json>",
  1454. "<JSON>",
  1455. "</JSON>",
  1456. "```",
  1457. "```json",
  1458. "```xml",
  1459. };
  1460. });
  1461. return data;
  1462. }
  1463. static void common_chat_parse_hermes_2_pro(common_chat_msg_parser & builder) {
  1464. builder.try_parse_reasoning("<think>", "</think>");
  1465. static const common_regex open_regex(
  1466. "(?:"
  1467. "(```(?:xml|json)?\\n\\s*)?" // match 1 (block_start)
  1468. "(" // match 2 (open_tag)
  1469. "<tool_call>"
  1470. "|<function_call>"
  1471. "|<tool>"
  1472. "|<tools>"
  1473. "|<response>"
  1474. "|<json>"
  1475. "|<xml>"
  1476. "|<JSON>"
  1477. ")?"
  1478. "(\\s*\\{\\s*\"name\")" // match 3 (named tool call)
  1479. ")"
  1480. "|<function=([^>]+)>" // match 4 (function name)
  1481. "|<function name=\"([^\"]+)\">" // match 5 (function name again)
  1482. );
  1483. if (auto res = builder.try_find_regex(open_regex)) {
  1484. builder.add_content(res->prelude);
  1485. const auto & block_start = res->groups[1];
  1486. std::string block_end = block_start.empty() ? "" : "```";
  1487. const auto & open_tag = res->groups[2];
  1488. std::string close_tag;
  1489. if (!res->groups[3].empty()) {
  1490. builder.move_to(res->groups[3].begin);
  1491. close_tag = open_tag.empty() ? "" : "</" + builder.str(open_tag).substr(1);
  1492. if (auto tool_call = builder.try_consume_json_with_dumped_args({{"arguments"}})) {
  1493. if (!builder.add_tool_call(tool_call->value) || tool_call->is_partial) {
  1494. throw common_chat_msg_partial_exception("incomplete tool call");
  1495. }
  1496. builder.consume_spaces();
  1497. builder.consume_literal(close_tag);
  1498. builder.consume_spaces();
  1499. if (!block_end.empty()) {
  1500. builder.consume_literal(block_end);
  1501. builder.consume_spaces();
  1502. }
  1503. builder.add_content(builder.consume_rest());
  1504. } else {
  1505. throw common_chat_msg_partial_exception("failed to parse tool call");
  1506. }
  1507. } else {
  1508. auto function_name = builder.str(res->groups[4]);
  1509. if (function_name.empty()) {
  1510. function_name = builder.str(res->groups[5]);
  1511. }
  1512. GGML_ASSERT(!function_name.empty());
  1513. close_tag = "</function>";
  1514. if (auto arguments = builder.try_consume_json_with_dumped_args({{}})) {
  1515. if (!builder.add_tool_call(function_name, "", arguments->value) || arguments->is_partial) {
  1516. throw common_chat_msg_partial_exception("incomplete tool call");
  1517. }
  1518. builder.consume_spaces();
  1519. builder.consume_literal(close_tag);
  1520. builder.consume_spaces();
  1521. if (!block_end.empty()) {
  1522. builder.consume_literal(block_end);
  1523. builder.consume_spaces();
  1524. }
  1525. }
  1526. builder.add_content(builder.consume_rest());
  1527. }
  1528. } else {
  1529. builder.add_content(builder.consume_rest());
  1530. }
  1531. }
  1532. static common_chat_params common_chat_params_init_without_tools(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1533. common_chat_params data;
  1534. data.prompt = apply(tmpl, inputs.messages, inputs.tools.empty() ? json() : inputs.tools, inputs.add_generation_prompt);
  1535. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1536. data.grammar_lazy = false;
  1537. if (!inputs.json_schema.is_null()) {
  1538. if (!inputs.grammar.empty()) {
  1539. throw std::runtime_error("Either \"json_schema\" or \"grammar\" can be specified, but not both");
  1540. }
  1541. data.grammar = json_schema_to_grammar(inputs.json_schema);
  1542. } else {
  1543. data.grammar = inputs.grammar;
  1544. }
  1545. return data;
  1546. }
  1547. static common_chat_params common_chat_templates_apply_jinja(
  1548. const struct common_chat_templates * tmpls,
  1549. const struct common_chat_templates_inputs & inputs)
  1550. {
  1551. templates_params params;
  1552. params.tools = common_chat_tools_to_json_oaicompat<json>(inputs.tools);
  1553. const auto & tmpl = params.tools.is_array() && tmpls->template_tool_use
  1554. ? *tmpls->template_tool_use
  1555. : *tmpls->template_default;
  1556. const auto & src = tmpl.source();
  1557. const auto & caps = tmpl.original_caps();
  1558. params.messages = common_chat_msgs_to_json_oaicompat<json>(inputs.messages, /* concat_text= */ !tmpl.original_caps().requires_typed_content);
  1559. params.add_generation_prompt = inputs.add_generation_prompt;
  1560. params.tool_choice = inputs.tool_choice;
  1561. params.grammar = inputs.grammar;
  1562. params.now = inputs.now;
  1563. if (!inputs.json_schema.empty()) {
  1564. params.json_schema = json::parse(inputs.json_schema);
  1565. }
  1566. if (inputs.parallel_tool_calls && !tmpl.original_caps().supports_parallel_tool_calls) {
  1567. LOG_DBG("Disabling parallel_tool_calls because the template does not support it\n");
  1568. params.parallel_tool_calls = false;
  1569. } else {
  1570. params.parallel_tool_calls = inputs.parallel_tool_calls;
  1571. }
  1572. if (params.tools.is_array()) {
  1573. if (params.tool_choice != COMMON_CHAT_TOOL_CHOICE_NONE && !params.grammar.empty()) {
  1574. throw std::runtime_error("Cannot specify grammar with tools");
  1575. }
  1576. if (caps.supports_tool_calls && !caps.supports_tools) {
  1577. 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");
  1578. }
  1579. }
  1580. // DeepSeek R1: use handler in all cases except json schema (thinking / tools).
  1581. if (src.find("<|tool▁calls▁begin|>") != std::string::npos && params.json_schema.is_null()) {
  1582. return common_chat_params_init_deepseek_r1(tmpl, params);
  1583. }
  1584. // Command R7B: : use handler in all cases except json schema (thinking / tools).
  1585. if (src.find("<|END_THINKING|><|START_ACTION|>") != std::string::npos && params.json_schema.is_null()) {
  1586. return common_chat_params_init_command_r7b(tmpl, params);
  1587. }
  1588. // Hermes 2/3 Pro, Qwen 2.5 Instruct (w/ tools)
  1589. if (src.find("<tool_call>") != std::string::npos && params.json_schema.is_null() && params.tools.is_array() && params.json_schema.is_null()) {
  1590. return common_chat_params_init_hermes_2_pro(tmpl, params);
  1591. }
  1592. // Use generic handler when mixing tools + JSON schema.
  1593. // TODO: support that mix in handlers below.
  1594. if ((params.tools.is_array() && params.json_schema.is_object())) {
  1595. return common_chat_params_init_generic(tmpl, params);
  1596. }
  1597. // Functionary prepends "all\n" to plain content outputs, so we use its handler in all cases.
  1598. if (src.find(">>>all") != std::string::npos) {
  1599. return common_chat_params_init_functionary_v3_2(tmpl, params);
  1600. }
  1601. // Firefunction v2 requires datetime and functions in the context even w/o tools, so we also use its handler in all cases.
  1602. if (src.find(" functools[") != std::string::npos) {
  1603. return common_chat_params_init_firefunction_v2(tmpl, params);
  1604. }
  1605. // Functionary v3.1 (w/ tools)
  1606. if (src.find("<|start_header_id|>") != std::string::npos
  1607. && src.find("<function=") != std::string::npos) {
  1608. return common_chat_params_init_functionary_v3_1_llama_3_1(tmpl, params);
  1609. }
  1610. // Llama 3.1, 3.2, 3.3 (also requires date_string so using it even w/o tools)
  1611. if (src.find("<|start_header_id|>ipython<|end_header_id|>") != std::string::npos) {
  1612. auto allow_python_tag_builtin_tools = src.find("<|python_tag|>") != std::string::npos;
  1613. return common_chat_params_init_llama_3_x(tmpl, params, allow_python_tag_builtin_tools);
  1614. }
  1615. // Plain handler (no tools)
  1616. if (params.tools.is_null() || inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_NONE) {
  1617. return common_chat_params_init_without_tools(tmpl, params);
  1618. }
  1619. // Mistral Nemo (w/ tools)
  1620. if (src.find("[TOOL_CALLS]") != std::string::npos) {
  1621. return common_chat_params_init_mistral_nemo(tmpl, params);
  1622. }
  1623. // Generic fallback
  1624. return common_chat_params_init_generic(tmpl, params);
  1625. }
  1626. // Legacy template route (adhoc C++ implementation of known templates), forward to llama_chat_apply_template.
  1627. static common_chat_params common_chat_templates_apply_legacy(
  1628. const struct common_chat_templates * tmpls,
  1629. const struct common_chat_templates_inputs & inputs)
  1630. {
  1631. int alloc_size = 0;
  1632. std::vector<llama_chat_message> chat;
  1633. std::vector<std::string> contents;
  1634. for (const auto & msg : inputs.messages) {
  1635. auto content = msg.content;
  1636. for (const auto & part : msg.content_parts) {
  1637. if (part.type != "text") {
  1638. LOG_WRN("Ignoring non-text content part: %s\n", part.type.c_str());
  1639. continue;
  1640. }
  1641. if (!content.empty()) {
  1642. content += "\n";;
  1643. }
  1644. content += part.text;
  1645. }
  1646. contents.emplace_back(std::move(content));
  1647. }
  1648. for (size_t i = 0; i < contents.size(); ++i) {
  1649. const auto & msg = inputs.messages[i];
  1650. const auto & content = contents[i];
  1651. chat.push_back({msg.role.c_str(), content.c_str()});
  1652. alloc_size += (msg.role.size() + content.size()) * 1.25;
  1653. }
  1654. std::vector<char> buf(alloc_size);
  1655. // run the first time to get the total output length
  1656. const auto & src = tmpls->template_default->source();
  1657. int32_t res = llama_chat_apply_template(src.c_str(), chat.data(), chat.size(), inputs.add_generation_prompt, buf.data(), buf.size());
  1658. // error: chat template is not supported
  1659. if (res < 0) {
  1660. // if the custom "tmpl" is not supported, we throw an error
  1661. // this is a bit redundant (for good), since we're not sure if user validated the custom template with llama_chat_verify_template()
  1662. throw std::runtime_error("this custom template is not supported");
  1663. }
  1664. // if it turns out that our buffer is too small, we resize it
  1665. if ((size_t) res > buf.size()) {
  1666. buf.resize(res);
  1667. res = llama_chat_apply_template(src.c_str(), chat.data(), chat.size(), inputs.add_generation_prompt, buf.data(), buf.size());
  1668. }
  1669. common_chat_params params;
  1670. params.prompt = std::string(buf.data(), res);
  1671. if (!inputs.json_schema.empty()) {
  1672. params.grammar = json_schema_to_grammar(json::parse(inputs.json_schema));
  1673. } else {
  1674. params.grammar = inputs.grammar;
  1675. }
  1676. return params;
  1677. }
  1678. common_chat_params common_chat_templates_apply(
  1679. const struct common_chat_templates * tmpls,
  1680. const struct common_chat_templates_inputs & inputs)
  1681. {
  1682. GGML_ASSERT(tmpls != nullptr);
  1683. return inputs.use_jinja
  1684. ? common_chat_templates_apply_jinja(tmpls, inputs)
  1685. : common_chat_templates_apply_legacy(tmpls, inputs);
  1686. }
  1687. static void common_chat_parse_content_only(common_chat_msg_parser & builder) {
  1688. builder.add_content(builder.consume_rest());
  1689. }
  1690. static void common_chat_parse(common_chat_msg_parser & builder, common_chat_format format) {
  1691. LOG_DBG("Parsing input with format %s: %s\n", common_chat_format_name(format).c_str(), builder.input().c_str());
  1692. switch (format) {
  1693. case COMMON_CHAT_FORMAT_CONTENT_ONLY:
  1694. common_chat_parse_content_only(builder);
  1695. break;
  1696. case COMMON_CHAT_FORMAT_GENERIC:
  1697. common_chat_parse_generic(builder);
  1698. break;
  1699. case COMMON_CHAT_FORMAT_MISTRAL_NEMO:
  1700. common_chat_parse_mistral_nemo(builder);
  1701. break;
  1702. case COMMON_CHAT_FORMAT_LLAMA_3_X:
  1703. common_chat_parse_llama_3_1(builder);
  1704. break;
  1705. case COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS:
  1706. common_chat_parse_llama_3_1(builder, /* with_builtin_tools= */ true);
  1707. break;
  1708. case COMMON_CHAT_FORMAT_DEEPSEEK_R1:
  1709. common_chat_parse_deepseek_r1(builder);
  1710. break;
  1711. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2:
  1712. common_chat_parse_functionary_v3_2(builder);
  1713. break;
  1714. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1:
  1715. common_chat_parse_functionary_v3_1_llama_3_1(builder);
  1716. break;
  1717. case COMMON_CHAT_FORMAT_HERMES_2_PRO:
  1718. common_chat_parse_hermes_2_pro(builder);
  1719. break;
  1720. case COMMON_CHAT_FORMAT_FIREFUNCTION_V2:
  1721. common_chat_parse_firefunction_v2(builder);
  1722. break;
  1723. case COMMON_CHAT_FORMAT_COMMAND_R7B:
  1724. common_chat_parse_command_r7b(builder);
  1725. break;
  1726. default:
  1727. throw std::runtime_error("Unsupported format: " + common_chat_format_name(format));
  1728. }
  1729. builder.finish();
  1730. }
  1731. common_chat_msg common_chat_parse(const std::string & input, bool is_partial, const common_chat_syntax & syntax) {
  1732. common_chat_msg_parser builder(input, is_partial, syntax);
  1733. try {
  1734. common_chat_parse(builder, syntax.format);
  1735. } catch (const common_chat_msg_partial_exception & ex) {
  1736. LOG_DBG("Partial parse: %s\n", ex.what());
  1737. if (!is_partial) {
  1738. throw std::runtime_error(ex.what());
  1739. }
  1740. }
  1741. auto msg = builder.result();
  1742. LOG_DBG("Parsed message: %s\n", common_chat_msgs_to_json_oaicompat<json>({msg}).at(0).dump().c_str());
  1743. return msg;
  1744. }