chat.cpp 83 KB

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