chat.cpp 90 KB

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