chat.cpp 118 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731
  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. bool is_inference = true;
  138. };
  139. common_chat_tool_choice common_chat_tool_choice_parse_oaicompat(const std::string & tool_choice) {
  140. if (tool_choice == "auto") {
  141. return COMMON_CHAT_TOOL_CHOICE_AUTO;
  142. }
  143. if (tool_choice == "none") {
  144. return COMMON_CHAT_TOOL_CHOICE_NONE;
  145. }
  146. if (tool_choice == "required") {
  147. return COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  148. }
  149. throw std::runtime_error("Invalid tool_choice: " + tool_choice);
  150. }
  151. bool common_chat_templates_support_enable_thinking(const common_chat_templates * chat_templates) {
  152. common_chat_templates_inputs dummy_inputs;
  153. common_chat_msg msg;
  154. msg.role = "user";
  155. msg.content = "test";
  156. dummy_inputs.messages = {msg};
  157. dummy_inputs.enable_thinking = false;
  158. const auto rendered_no_thinking = common_chat_templates_apply(chat_templates, dummy_inputs);
  159. dummy_inputs.enable_thinking = true;
  160. const auto rendered_with_thinking = common_chat_templates_apply(chat_templates, dummy_inputs);
  161. return rendered_no_thinking.prompt != rendered_with_thinking.prompt;
  162. }
  163. template <>
  164. std::vector<common_chat_msg> common_chat_msgs_parse_oaicompat(const json & messages) {
  165. std::vector<common_chat_msg> msgs;
  166. try {
  167. if (!messages.is_array()) {
  168. throw std::runtime_error("Expected 'messages' to be an array, got " + messages.dump());
  169. }
  170. for (const auto & message : messages) {
  171. if (!message.is_object()) {
  172. throw std::runtime_error("Expected 'message' to be an object, got " + message.dump());
  173. }
  174. common_chat_msg msg;
  175. if (!message.contains("role")) {
  176. throw std::runtime_error("Missing 'role' in message: " + message.dump());
  177. }
  178. msg.role = message.at("role");
  179. auto has_content = message.contains("content");
  180. auto has_tool_calls = message.contains("tool_calls");
  181. if (has_content) {
  182. const auto & content = message.at("content");
  183. if (content.is_string()) {
  184. msg.content = content;
  185. } else if (content.is_array()) {
  186. for (const auto & part : content) {
  187. if (!part.contains("type")) {
  188. throw std::runtime_error("Missing content part type: " + part.dump());
  189. }
  190. const auto & type = part.at("type");
  191. if (type != "text") {
  192. throw std::runtime_error("Unsupported content part type: " + type.dump());
  193. }
  194. common_chat_msg_content_part msg_part;
  195. msg_part.type = type;
  196. msg_part.text = part.at("text");
  197. msg.content_parts.push_back(msg_part);
  198. }
  199. } else if (!content.is_null()) {
  200. throw std::runtime_error("Invalid 'content' type: expected string or array, got " + content.dump() + " (ref: https://github.com/ggml-org/llama.cpp/issues/8367)");
  201. }
  202. }
  203. if (has_tool_calls) {
  204. for (const auto & tool_call : message.at("tool_calls")) {
  205. common_chat_tool_call tc;
  206. if (!tool_call.contains("type")) {
  207. throw std::runtime_error("Missing tool call type: " + tool_call.dump());
  208. }
  209. const auto & type = tool_call.at("type");
  210. if (type != "function") {
  211. throw std::runtime_error("Unsupported tool call type: " + tool_call.dump());
  212. }
  213. if (!tool_call.contains("function")) {
  214. throw std::runtime_error("Missing tool call function: " + tool_call.dump());
  215. }
  216. const auto & fc = tool_call.at("function");
  217. if (!fc.contains("name")) {
  218. throw std::runtime_error("Missing tool call name: " + tool_call.dump());
  219. }
  220. tc.name = fc.at("name");
  221. tc.arguments = fc.at("arguments");
  222. if (tool_call.contains("id")) {
  223. tc.id = tool_call.at("id");
  224. }
  225. msg.tool_calls.push_back(tc);
  226. }
  227. }
  228. if (!has_content && !has_tool_calls) {
  229. 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)");
  230. }
  231. if (message.contains("reasoning_content")) {
  232. msg.reasoning_content = message.at("reasoning_content");
  233. }
  234. if (message.contains("name")) {
  235. msg.tool_name = message.at("name");
  236. }
  237. if (message.contains("tool_call_id")) {
  238. msg.tool_call_id = message.at("tool_call_id");
  239. }
  240. msgs.push_back(msg);
  241. }
  242. } catch (const std::exception & e) {
  243. // @ngxson : disable otherwise it's bloating the API response
  244. // printf("%s\n", std::string("; messages = ") + messages.dump(2));
  245. throw std::runtime_error("Failed to parse messages: " + std::string(e.what()));
  246. }
  247. return msgs;
  248. }
  249. template <>
  250. json common_chat_msgs_to_json_oaicompat(const std::vector<common_chat_msg> & msgs, bool concat_typed_text) {
  251. json messages = json::array();
  252. for (const auto & msg : msgs) {
  253. if (!msg.content.empty() && !msg.content_parts.empty()) {
  254. throw std::runtime_error("Cannot specify both content and content_parts");
  255. }
  256. json jmsg {
  257. {"role", msg.role},
  258. };
  259. if (!msg.content.empty()) {
  260. jmsg["content"] = msg.content;
  261. } else if (!msg.content_parts.empty()) {
  262. if (concat_typed_text) {
  263. std::string text;
  264. for (const auto & part : msg.content_parts) {
  265. if (part.type != "text") {
  266. LOG_WRN("Ignoring content part type: %s\n", part.type.c_str());
  267. continue;
  268. }
  269. if (!text.empty()) {
  270. text += '\n';
  271. }
  272. text += part.text;
  273. }
  274. jmsg["content"] = text;
  275. } else {
  276. auto & parts = jmsg["content"] = json::array();
  277. for (const auto & part : msg.content_parts) {
  278. parts.push_back({
  279. {"type", part.type},
  280. {"text", part.text},
  281. });
  282. }
  283. }
  284. } else {
  285. jmsg["content"] = json(); // null
  286. }
  287. if (!msg.reasoning_content.empty()) {
  288. jmsg["reasoning_content"] = msg.reasoning_content;
  289. jmsg["thinking"] = msg.reasoning_content; // gpt-oss
  290. }
  291. if (!msg.tool_name.empty()) {
  292. jmsg["name"] = msg.tool_name;
  293. }
  294. if (!msg.tool_call_id.empty()) {
  295. jmsg["tool_call_id"] = msg.tool_call_id;
  296. }
  297. if (!msg.tool_calls.empty()) {
  298. auto & tool_calls = jmsg["tool_calls"] = json::array();
  299. for (const auto & tool_call : msg.tool_calls) {
  300. json tc {
  301. {"type", "function"},
  302. {"function", {
  303. {"name", tool_call.name},
  304. {"arguments", tool_call.arguments},
  305. }},
  306. };
  307. if (!tool_call.id.empty()) {
  308. tc["id"] = tool_call.id;
  309. }
  310. tool_calls.push_back(tc);
  311. }
  312. }
  313. messages.push_back(jmsg);
  314. }
  315. return messages;
  316. }
  317. template <>
  318. std::vector<common_chat_msg> common_chat_msgs_parse_oaicompat(const std::string & messages) {
  319. return common_chat_msgs_parse_oaicompat(json::parse(messages));
  320. }
  321. template <>
  322. std::vector<common_chat_tool> common_chat_tools_parse_oaicompat(const json & tools) {
  323. std::vector<common_chat_tool> result;
  324. try {
  325. if (!tools.is_null()) {
  326. if (!tools.is_array()) {
  327. throw std::runtime_error("Expected 'tools' to be an array, got " + tools.dump());
  328. }
  329. for (const auto & tool : tools) {
  330. if (!tool.contains("type")) {
  331. throw std::runtime_error("Missing tool type: " + tool.dump());
  332. }
  333. const auto & type = tool.at("type");
  334. if (!type.is_string() || type != "function") {
  335. throw std::runtime_error("Unsupported tool type: " + tool.dump());
  336. }
  337. if (!tool.contains("function")) {
  338. throw std::runtime_error("Missing tool function: " + tool.dump());
  339. }
  340. const auto & function = tool.at("function");
  341. result.push_back({
  342. /* .name = */ function.at("name"),
  343. /* .description = */ function.at("description"),
  344. /* .parameters = */ function.at("parameters").dump(),
  345. });
  346. }
  347. }
  348. } catch (const std::exception & e) {
  349. throw std::runtime_error("Failed to parse tools: " + std::string(e.what()) + "; tools = " + tools.dump(2));
  350. }
  351. return result;
  352. }
  353. template <>
  354. std::vector<common_chat_tool> common_chat_tools_parse_oaicompat(const std::string & tools) {
  355. return common_chat_tools_parse_oaicompat(json::parse(tools));
  356. }
  357. template <>
  358. json common_chat_tools_to_json_oaicompat(const std::vector<common_chat_tool> & tools) {
  359. if (tools.empty()) {
  360. return json();
  361. }
  362. auto result = json::array();
  363. for (const auto & tool : tools) {
  364. result.push_back({
  365. {"type", "function"},
  366. {"function", {
  367. {"name", tool.name},
  368. {"description", tool.description},
  369. {"parameters", json::parse(tool.parameters)},
  370. }},
  371. });
  372. }
  373. return result;
  374. }
  375. template <> json common_chat_msg_diff_to_json_oaicompat(const common_chat_msg_diff & diff) {
  376. json delta = json::object();
  377. if (!diff.reasoning_content_delta.empty()) {
  378. delta["reasoning_content"] = diff.reasoning_content_delta;
  379. }
  380. if (!diff.content_delta.empty()) {
  381. delta["content"] = diff.content_delta;
  382. }
  383. if (diff.tool_call_index != std::string::npos) {
  384. json tool_call;
  385. tool_call["index"] = diff.tool_call_index;
  386. if (!diff.tool_call_delta.id.empty()) {
  387. tool_call["id"] = diff.tool_call_delta.id;
  388. tool_call["type"] = "function";
  389. }
  390. json function = json::object();
  391. if (!diff.tool_call_delta.name.empty()) {
  392. function["name"] = diff.tool_call_delta.name;
  393. }
  394. function["arguments"] = diff.tool_call_delta.arguments;
  395. tool_call["function"] = function;
  396. delta["tool_calls"] = json::array({tool_call});
  397. }
  398. return delta;
  399. }
  400. bool common_chat_verify_template(const std::string & tmpl, bool use_jinja) {
  401. if (use_jinja) {
  402. try {
  403. common_chat_msg msg;
  404. msg.role = "user";
  405. msg.content = "test";
  406. auto tmpls = common_chat_templates_init(/* model= */ nullptr, tmpl);
  407. common_chat_templates_inputs inputs;
  408. inputs.messages = {msg};
  409. common_chat_templates_apply(tmpls.get(), inputs);
  410. return true;
  411. } catch (const std::exception & e) {
  412. LOG_ERR("%s: failed to apply template: %s\n", __func__, e.what());
  413. return false;
  414. }
  415. }
  416. llama_chat_message chat[] = {{"user", "test"}};
  417. const int res = llama_chat_apply_template(tmpl.c_str(), chat, 1, true, nullptr, 0);
  418. return res >= 0;
  419. }
  420. std::string common_chat_format_single(
  421. const struct common_chat_templates * tmpls,
  422. const std::vector<common_chat_msg> & past_msg,
  423. const common_chat_msg & new_msg,
  424. bool add_ass,
  425. bool use_jinja) {
  426. common_chat_templates_inputs inputs;
  427. inputs.use_jinja = use_jinja;
  428. inputs.add_bos = tmpls->add_bos;
  429. inputs.add_eos = tmpls->add_eos;
  430. std::string fmt_past_msg;
  431. if (!past_msg.empty()) {
  432. inputs.messages = past_msg;
  433. inputs.add_generation_prompt = false;
  434. fmt_past_msg = common_chat_templates_apply(tmpls, inputs).prompt;
  435. }
  436. std::ostringstream ss;
  437. // if the past_msg ends with a newline, we must preserve it in the formatted version
  438. if (add_ass && !fmt_past_msg.empty() && fmt_past_msg.back() == '\n') {
  439. ss << "\n";
  440. };
  441. // format chat with new_msg
  442. inputs.messages.push_back(new_msg);
  443. inputs.add_generation_prompt = add_ass;
  444. auto fmt_new_msg = common_chat_templates_apply(tmpls, inputs).prompt;
  445. // get the diff part
  446. ss << fmt_new_msg.substr(fmt_past_msg.size(), fmt_new_msg.size() - fmt_past_msg.size());
  447. return ss.str();
  448. }
  449. std::string common_chat_format_example(const struct common_chat_templates * tmpls, bool use_jinja, const std::map<std::string, std::string> & chat_template_kwargs) {
  450. common_chat_templates_inputs inputs;
  451. inputs.use_jinja = use_jinja;
  452. inputs.add_bos = tmpls->add_bos;
  453. inputs.add_eos = tmpls->add_eos;
  454. inputs.chat_template_kwargs = chat_template_kwargs;
  455. auto add_simple_msg = [&](auto role, auto content) {
  456. common_chat_msg msg;
  457. msg.role = role;
  458. msg.content = content;
  459. inputs.messages.push_back(msg);
  460. };
  461. add_simple_msg("system", "You are a helpful assistant");
  462. add_simple_msg("user", "Hello");
  463. add_simple_msg("assistant", "Hi there");
  464. add_simple_msg("user", "How are you?");
  465. return common_chat_templates_apply(tmpls, inputs).prompt;
  466. }
  467. #define CHATML_TEMPLATE_SRC \
  468. "{%- for message in messages -%}\n" \
  469. " {{- '<|im_start|>' + message.role + '\n' + message.content + '<|im_end|>\n' -}}\n" \
  470. "{%- endfor -%}\n" \
  471. "{%- if add_generation_prompt -%}\n" \
  472. " {{- '<|im_start|>assistant\n' -}}\n" \
  473. "{%- endif -%}"
  474. void common_chat_templates_free(struct common_chat_templates * tmpls) {
  475. delete tmpls;
  476. }
  477. bool common_chat_templates_was_explicit(const struct common_chat_templates * tmpls) {
  478. return tmpls->has_explicit_template;
  479. }
  480. const char * common_chat_templates_source(const struct common_chat_templates * tmpls, const char * variant) {
  481. if (variant != nullptr) {
  482. if (strcmp(variant, "tool_use") == 0) {
  483. if (tmpls->template_tool_use) {
  484. return tmpls->template_tool_use->source().c_str();
  485. }
  486. return nullptr;
  487. } else {
  488. LOG_DBG("%s: unknown template variant: %s\n", __func__, variant);
  489. }
  490. }
  491. return tmpls->template_default->source().c_str();
  492. }
  493. common_chat_templates_ptr common_chat_templates_init(
  494. const struct llama_model * model,
  495. const std::string & chat_template_override,
  496. const std::string & bos_token_override,
  497. const std::string & eos_token_override)
  498. {
  499. std::string default_template_src;
  500. std::string template_tool_use_src;
  501. bool has_explicit_template = !chat_template_override.empty();
  502. if (chat_template_override.empty()) {
  503. GGML_ASSERT(model != nullptr);
  504. const auto * str = llama_model_chat_template(model, /* name */ nullptr);
  505. if (str) {
  506. default_template_src = str;
  507. has_explicit_template = true;
  508. }
  509. str = llama_model_chat_template(model, /* name */ "tool_use");
  510. if (str) {
  511. template_tool_use_src = str;
  512. has_explicit_template = true;
  513. }
  514. } else {
  515. default_template_src = chat_template_override;
  516. }
  517. if (default_template_src.empty() || default_template_src == "chatml") {
  518. if (!template_tool_use_src.empty()) {
  519. default_template_src = template_tool_use_src;
  520. } else {
  521. default_template_src = CHATML_TEMPLATE_SRC;
  522. }
  523. }
  524. // TODO @ngxson : this is a temporary hack to prevent chat template from throwing an error
  525. // Ref: https://github.com/ggml-org/llama.cpp/pull/15230#issuecomment-3173959633
  526. if (default_template_src.find("<|channel|>") != std::string::npos
  527. // search for the error message and patch it
  528. && default_template_src.find("in message.content or") != std::string::npos) {
  529. string_replace_all(default_template_src,
  530. "{%- if \"<|channel|>analysis<|message|>\" in message.content or \"<|channel|>final<|message|>\" in message.content %}",
  531. "{%- if false %}");
  532. }
  533. std::string token_bos = bos_token_override;
  534. std::string token_eos = eos_token_override;
  535. bool add_bos = false;
  536. bool add_eos = false;
  537. if (model) {
  538. const auto * vocab = llama_model_get_vocab(model);
  539. const auto get_token = [&](llama_token token, const char * name, const char * jinja_variable_name) {
  540. if (token == LLAMA_TOKEN_NULL) {
  541. if (default_template_src.find(jinja_variable_name) != std::string::npos
  542. || template_tool_use_src.find(jinja_variable_name) != std::string::npos) {
  543. LOG_WRN("common_chat_templates_init: warning: vocab does not have a %s token, jinja template won't work as intended.\n", name);
  544. }
  545. return std::string();
  546. }
  547. return common_token_to_piece(vocab, token, true);
  548. };
  549. token_bos = get_token(llama_vocab_bos(vocab), "BOS", "bos_token");
  550. token_eos = get_token(llama_vocab_eos(vocab), "EOS", "eos_token");
  551. add_bos = llama_vocab_get_add_bos(vocab);
  552. add_eos = llama_vocab_get_add_eos(vocab);
  553. }
  554. common_chat_templates_ptr tmpls(new common_chat_templates());
  555. tmpls->has_explicit_template = has_explicit_template;
  556. tmpls->add_bos = add_bos;
  557. tmpls->add_eos = add_eos;
  558. try {
  559. tmpls->template_default = std::make_unique<minja::chat_template>(default_template_src, token_bos, token_eos);
  560. } catch (const std::exception & e) {
  561. LOG_ERR("%s: failed to parse chat template (defaulting to chatml): %s \n", __func__, e.what());
  562. tmpls->template_default = std::make_unique<minja::chat_template>(CHATML_TEMPLATE_SRC, token_bos, token_eos);
  563. }
  564. if (!template_tool_use_src.empty()) {
  565. try {
  566. tmpls->template_tool_use = std::make_unique<minja::chat_template>(template_tool_use_src, token_bos, token_eos);
  567. } catch (const std::exception & e) {
  568. LOG_ERR("%s: failed to parse tool use chat template (ignoring it): %s\n", __func__, e.what());
  569. }
  570. }
  571. return tmpls;
  572. }
  573. const char * common_chat_format_name(common_chat_format format) {
  574. switch (format) {
  575. case COMMON_CHAT_FORMAT_CONTENT_ONLY: return "Content-only";
  576. case COMMON_CHAT_FORMAT_GENERIC: return "Generic";
  577. case COMMON_CHAT_FORMAT_MISTRAL_NEMO: return "Mistral Nemo";
  578. case COMMON_CHAT_FORMAT_LLAMA_3_X: return "Llama 3.x";
  579. case COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS: return "Llama 3.x with builtin tools";
  580. case COMMON_CHAT_FORMAT_DEEPSEEK_R1: return "DeepSeek R1";
  581. case COMMON_CHAT_FORMAT_FIREFUNCTION_V2: return "FireFunction v2";
  582. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2: return "Functionary v3.2";
  583. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1: return "Functionary v3.1 Llama 3.1";
  584. case COMMON_CHAT_FORMAT_DEEPSEEK_V3_1: return "DeepSeek V3.1";
  585. case COMMON_CHAT_FORMAT_HERMES_2_PRO: return "Hermes 2 Pro";
  586. case COMMON_CHAT_FORMAT_COMMAND_R7B: return "Command R7B";
  587. case COMMON_CHAT_FORMAT_GRANITE: return "Granite";
  588. case COMMON_CHAT_FORMAT_GPT_OSS: return "GPT-OSS";
  589. case COMMON_CHAT_FORMAT_SEED_OSS: return "Seed-OSS";
  590. case COMMON_CHAT_FORMAT_NEMOTRON_V2: return "Nemotron V2";
  591. default:
  592. throw std::runtime_error("Unknown chat format");
  593. }
  594. }
  595. const char * common_reasoning_format_name(common_reasoning_format format) {
  596. switch (format) {
  597. case COMMON_REASONING_FORMAT_NONE: return "none";
  598. case COMMON_REASONING_FORMAT_AUTO: return "auto";
  599. case COMMON_REASONING_FORMAT_DEEPSEEK: return "deepseek";
  600. case COMMON_REASONING_FORMAT_DEEPSEEK_LEGACY: return "deepseek-legacy";
  601. default:
  602. throw std::runtime_error("Unknown reasoning format");
  603. }
  604. }
  605. common_reasoning_format common_reasoning_format_from_name(const std::string & format) {
  606. if (format == "none") {
  607. return COMMON_REASONING_FORMAT_NONE;
  608. } else if (format == "auto") {
  609. return COMMON_REASONING_FORMAT_AUTO;
  610. } else if (format == "deepseek") {
  611. return COMMON_REASONING_FORMAT_DEEPSEEK;
  612. } else if (format == "deepseek-legacy") {
  613. return COMMON_REASONING_FORMAT_DEEPSEEK_LEGACY;
  614. }
  615. throw std::runtime_error("Unknown reasoning format: " + format);
  616. }
  617. static std::string wrap_code_as_arguments(common_chat_msg_parser & builder, const std::string & code) {
  618. std::string arguments;
  619. if (builder.is_partial()) {
  620. arguments = (json {{"code", code + builder.healing_marker()}}).dump();
  621. auto idx = arguments.find(builder.healing_marker());
  622. if (idx != std::string::npos) {
  623. arguments.resize(idx);
  624. }
  625. } else {
  626. arguments = (json {{"code", code}}).dump();
  627. }
  628. return arguments;
  629. }
  630. /**
  631. * Takes a prefix regex that must have 1 group to capture the function name, a closing suffix, and expects json parameters in between.
  632. * Aggregates the prefix, suffix and in-between text into the content.
  633. */
  634. static void parse_json_tool_calls(
  635. common_chat_msg_parser & builder,
  636. const std::optional<common_regex> & block_open,
  637. const std::optional<common_regex> & function_regex_start_only,
  638. const std::optional<common_regex> & function_regex,
  639. const common_regex & close_regex,
  640. const std::optional<common_regex> & block_close,
  641. bool allow_raw_python = false,
  642. const std::function<std::string(const common_chat_msg_parser::find_regex_result & fres)> & get_function_name = nullptr) {
  643. auto parse_tool_calls = [&]() {
  644. size_t from = std::string::npos;
  645. auto first = true;
  646. while (true) {
  647. auto start_pos = builder.pos();
  648. auto res = function_regex_start_only && first
  649. ? builder.try_consume_regex(*function_regex_start_only)
  650. : function_regex
  651. ? builder.try_find_regex(*function_regex, from)
  652. : std::nullopt;
  653. if (res) {
  654. std::string name;
  655. if (get_function_name) {
  656. name = get_function_name(*res);
  657. } else {
  658. GGML_ASSERT(res->groups.size() == 2);
  659. name = builder.str(res->groups[1]);
  660. }
  661. first = false;
  662. if (name.empty()) {
  663. // get_function_name signalled us that we should skip this match and treat it as content.
  664. from = res->groups[0].begin + 1;
  665. continue;
  666. }
  667. from = std::string::npos;
  668. auto maybe_raw_python = name == "python" && allow_raw_python;
  669. if (builder.input()[builder.pos()] == '{' || !maybe_raw_python) {
  670. if (auto arguments = builder.try_consume_json_with_dumped_args({{}})) {
  671. if (!builder.add_tool_call(name, "", arguments->value) || arguments->is_partial) {
  672. throw common_chat_msg_partial_exception("incomplete tool call");
  673. }
  674. builder.consume_regex(close_regex);
  675. }
  676. continue;
  677. }
  678. if (maybe_raw_python) {
  679. auto arguments = wrap_code_as_arguments(builder, builder.consume_rest());
  680. if (!builder.add_tool_call(name, "", arguments)) {
  681. throw common_chat_msg_partial_exception("incomplete tool call");
  682. }
  683. return;
  684. }
  685. throw common_chat_msg_partial_exception("incomplete tool call");
  686. } else {
  687. builder.move_to(start_pos);
  688. }
  689. break;
  690. }
  691. if (block_close) {
  692. builder.consume_regex(*block_close);
  693. }
  694. builder.consume_spaces();
  695. builder.add_content(builder.consume_rest());
  696. };
  697. if (block_open) {
  698. if (auto res = builder.try_find_regex(*block_open)) {
  699. parse_tool_calls();
  700. } else {
  701. builder.add_content(builder.consume_rest());
  702. }
  703. } else {
  704. parse_tool_calls();
  705. }
  706. }
  707. static void parse_prefixed_json_tool_call_array(common_chat_msg_parser & builder, const common_regex & prefix, size_t rstrip_prefix = 0) {
  708. static const std::vector<std::vector<std::string>> args_paths = {{"arguments"}};
  709. if (auto res = builder.try_find_regex(prefix)) {
  710. builder.move_back(rstrip_prefix);
  711. auto tool_calls = builder.consume_json_with_dumped_args(args_paths);
  712. if (!builder.add_tool_calls(tool_calls.value) || tool_calls.is_partial) {
  713. throw common_chat_msg_partial_exception("incomplete tool call array");
  714. }
  715. } else {
  716. builder.add_content(builder.consume_rest());
  717. }
  718. }
  719. static void foreach_function(const json & tools, const std::function<void(const json &)> & fn) {
  720. for (const auto & tool : tools) {
  721. if (!tool.contains("type") || tool.at("type") != "function" || !tool.contains("function")) {
  722. LOG_INF("Skipping tool without function: %s", tool.dump(2).c_str());
  723. continue;
  724. }
  725. fn(tool);
  726. }
  727. }
  728. static std::string apply(
  729. const common_chat_template & tmpl,
  730. const struct templates_params & inputs,
  731. const std::optional<json> & messages_override = std::nullopt,
  732. const std::optional<json> & tools_override = std::nullopt,
  733. const std::optional<json> & additional_context = std::nullopt)
  734. {
  735. minja::chat_template_inputs tmpl_inputs;
  736. tmpl_inputs.messages = messages_override ? *messages_override : inputs.messages;
  737. if (tools_override) {
  738. tmpl_inputs.tools = *tools_override;
  739. } else {
  740. tmpl_inputs.tools = inputs.tools.empty() ? json() : inputs.tools;
  741. }
  742. tmpl_inputs.add_generation_prompt = inputs.add_generation_prompt;
  743. tmpl_inputs.extra_context = inputs.extra_context;
  744. if (additional_context) {
  745. tmpl_inputs.extra_context.merge_patch(*additional_context);
  746. }
  747. // TODO: add flag to control date/time, if only for testing purposes.
  748. // tmpl_inputs.now = std::chrono::system_clock::now();
  749. minja::chat_template_options tmpl_opts;
  750. // To avoid double BOS / EOS tokens, we're manually removing begining / trailing tokens
  751. // instead of using `chat_template_options.use_bos_token = false`, since these tokens
  752. // may be needed inside the template / between messages too.
  753. auto result = tmpl.apply(tmpl_inputs, tmpl_opts);
  754. if (inputs.add_bos && string_starts_with(result, tmpl.bos_token())) {
  755. result = result.substr(tmpl.bos_token().size());
  756. }
  757. if (inputs.add_eos && string_ends_with(result, tmpl.eos_token())) {
  758. result = result.substr(0, result.size() - tmpl.eos_token().size());
  759. }
  760. return result;
  761. }
  762. static common_chat_params common_chat_params_init_generic(const common_chat_template & tmpl, const struct templates_params & inputs) {
  763. common_chat_params data;
  764. auto tool_call_schemas = json::array();
  765. foreach_function(inputs.tools, [&](const json & tool) {
  766. const auto & function = tool.at("function");
  767. auto tool_schema = json {
  768. {"type", "object"},
  769. {"properties", {
  770. {"name", {
  771. {"type", "string"},
  772. {"const", function.at("name")},
  773. }},
  774. {"arguments", function.at("parameters")},
  775. }},
  776. {"required", json::array({"name", "arguments"})},
  777. };
  778. if (function.contains("description")) {
  779. tool_schema["description"] = function.at("description");
  780. }
  781. if (inputs.parallel_tool_calls) {
  782. tool_schema.at("properties")["id"] = {
  783. {"type", "string"},
  784. {"minLength", 4},
  785. };
  786. tool_schema.at("required").push_back("id");
  787. }
  788. tool_call_schemas.emplace_back(tool_schema);
  789. });
  790. const auto tool_call =
  791. inputs.parallel_tool_calls
  792. ? json {
  793. {"type", "object"},
  794. {"properties", {
  795. {"tool_calls", {
  796. {"type", "array"},
  797. {"items", tool_call_schemas.size() == 1 ? tool_call_schemas[0] : json {
  798. {"anyOf", tool_call_schemas},
  799. }},
  800. {"minItems", 1},
  801. }},
  802. }},
  803. {"required", json::array({"tool_calls"})},
  804. }
  805. : json {
  806. {"type", "object"},
  807. {"properties", {
  808. {"tool_call", tool_call_schemas.size() == 1 ? tool_call_schemas[0] : json {
  809. {"anyOf", tool_call_schemas},
  810. }},
  811. }},
  812. {"required", json::array({"tool_call"})},
  813. };
  814. const auto schema =
  815. inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED
  816. ? json {
  817. {"anyOf", json::array({
  818. tool_call,
  819. {
  820. {"type", "object"},
  821. {"properties", {
  822. {"response", inputs.json_schema.is_null()
  823. ? json {{"type", "string"}}
  824. : inputs.json_schema
  825. },
  826. }},
  827. {"required", json::array({"response"})},
  828. },
  829. })}
  830. }
  831. : tool_call;
  832. data.grammar_lazy = false;
  833. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  834. builder.add_schema("root", schema);
  835. });
  836. auto tweaked_messages = common_chat_template::add_system(
  837. inputs.messages,
  838. "Respond in JSON format, either with `tool_call` (a request to call tools) or with `response` reply to the user's request");
  839. data.prompt = apply(tmpl, inputs, /* messages_override= */ tweaked_messages);
  840. data.format = COMMON_CHAT_FORMAT_GENERIC;
  841. return data;
  842. }
  843. static void common_chat_parse_generic(common_chat_msg_parser & builder) {
  844. if (!builder.syntax().parse_tool_calls) {
  845. builder.add_content(builder.consume_rest());
  846. return;
  847. }
  848. static const std::vector<std::vector<std::string>> content_paths = {
  849. {"response"},
  850. };
  851. static const std::vector<std::vector<std::string>> args_paths = {
  852. {"tool_call", "arguments"},
  853. {"tool_calls", "arguments"},
  854. };
  855. auto data = builder.consume_json_with_dumped_args(args_paths, content_paths);
  856. if (data.value.contains("tool_calls")) {
  857. if (!builder.add_tool_calls(data.value.at("tool_calls")) || data.is_partial) {
  858. throw common_chat_msg_partial_exception("incomplete tool calls");
  859. }
  860. } else if (data.value.contains("tool_call")) {
  861. if (!builder.add_tool_call(data.value.at("tool_call")) || data.is_partial) {
  862. throw common_chat_msg_partial_exception("incomplete tool call");
  863. }
  864. } else if (data.value.contains("response")) {
  865. const auto & response = data.value.at("response");
  866. builder.add_content(response.is_string() ? response.template get<std::string>() : response.dump(2));
  867. if (data.is_partial) {
  868. throw common_chat_msg_partial_exception("incomplete response");
  869. }
  870. } else {
  871. throw common_chat_msg_partial_exception("Expected 'tool_call', 'tool_calls' or 'response' in JSON");
  872. }
  873. }
  874. static common_chat_params common_chat_params_init_mistral_nemo(const common_chat_template & tmpl, const struct templates_params & inputs) {
  875. common_chat_params data;
  876. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  877. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  878. auto schemas = json::array();
  879. foreach_function(inputs.tools, [&](const json & tool) {
  880. const auto & function = tool.at("function");
  881. schemas.push_back({
  882. {"type", "object"},
  883. {"properties", {
  884. // Important note: the model is probably trained to take a JSON stringified arguments value.
  885. // It's hard to constrain that for now (while reusing the JSON schema conversion), so we're just expecting a plain object.
  886. {"name", {
  887. {"type", "string"},
  888. {"const", function.at("name")},
  889. }},
  890. {"arguments", function.at("parameters")},
  891. {"id", {
  892. {"type", "string"},
  893. // Nemo's template expects a 9-character alphanumeric ID.
  894. {"pattern", "^[a-zA-Z0-9]{9}$"},
  895. }},
  896. }},
  897. {"required", json::array({"name", "arguments", "id"})},
  898. });
  899. });
  900. auto schema = json {
  901. {"type", "array"},
  902. {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}},
  903. {"minItems", 1},
  904. };
  905. if (!inputs.parallel_tool_calls) {
  906. schema["maxItems"] = 1;
  907. }
  908. builder.add_rule("root", "\"[TOOL_CALLS]\" " + builder.add_schema("tool_calls", schema));
  909. });
  910. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "[TOOL_CALLS]"});
  911. data.preserved_tokens = {
  912. "[TOOL_CALLS]",
  913. };
  914. data.prompt = apply(tmpl, inputs);
  915. data.format = COMMON_CHAT_FORMAT_MISTRAL_NEMO;
  916. return data;
  917. }
  918. static void common_chat_parse_mistral_nemo(common_chat_msg_parser & builder) {
  919. if (!builder.syntax().parse_tool_calls) {
  920. builder.add_content(builder.consume_rest());
  921. return;
  922. }
  923. static const common_regex prefix(regex_escape("[TOOL_CALLS]"));
  924. parse_prefixed_json_tool_call_array(builder, prefix);
  925. }
  926. static common_chat_params common_chat_params_init_command_r7b(const common_chat_template & tmpl, const struct templates_params & inputs) {
  927. common_chat_params data;
  928. auto adjusted_messages = json::array();
  929. for (const auto & msg : inputs.messages) {
  930. auto has_reasoning_content = msg.contains("reasoning_content") && msg.at("reasoning_content").is_string();
  931. auto has_tool_calls = msg.contains("tool_calls") && msg.at("tool_calls").is_array();
  932. if (has_reasoning_content && has_tool_calls) {
  933. auto adjusted_message = msg;
  934. adjusted_message["tool_plan"] = msg.at("reasoning_content");
  935. adjusted_message.erase("reasoning_content");
  936. adjusted_messages.push_back(adjusted_message);
  937. } else {
  938. adjusted_messages.push_back(msg);
  939. }
  940. }
  941. data.prompt = apply(tmpl, inputs, /* messages_override= */ adjusted_messages);
  942. data.format = COMMON_CHAT_FORMAT_COMMAND_R7B;
  943. if (string_ends_with(data.prompt, "<|START_THINKING|>")) {
  944. if (!inputs.enable_thinking) {
  945. data.prompt += "<|END_THINKING|>";
  946. } else {
  947. data.thinking_forced_open = true;
  948. }
  949. } else if (!inputs.enable_thinking && string_ends_with(data.prompt, "<|CHATBOT_TOKEN|>")) {
  950. data.prompt += "<|START_THINKING|><|END_THINKING|>";
  951. }
  952. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  953. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  954. auto schemas = json::array();
  955. foreach_function(inputs.tools, [&](const json & tool) {
  956. const auto & function = tool.at("function");
  957. schemas.push_back({
  958. {"type", "object"},
  959. {"properties", {
  960. {"tool_call_id", {
  961. {"type", "string"},
  962. // Command-R's template expects an integer string.
  963. {"pattern", "^[0-9]{1,10}$"},
  964. }},
  965. {"tool_name", {
  966. {"type", "string"},
  967. {"const", function.at("name")},
  968. }},
  969. {"parameters", function.at("parameters")},
  970. }},
  971. {"required", json::array({"tool_call_id", "tool_name", "parameters"})},
  972. });
  973. });
  974. auto schema = json {
  975. {"type", "array"},
  976. {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}},
  977. {"minItems", 1},
  978. };
  979. if (!inputs.parallel_tool_calls) {
  980. schema["maxItems"] = 1;
  981. }
  982. builder.add_rule("root",
  983. std::string(data.thinking_forced_open ? "( \"<|END_THINKING|>\" space )? " : "") +
  984. "\"<|START_ACTION|>\" " + builder.add_schema("tool_calls", schema) + " \"<|END_ACTION|>\"");
  985. });
  986. data.grammar_triggers.push_back({
  987. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  988. // If thinking_forced_open, then we capture the </think> tag in the grammar,
  989. // (important for required tool choice) and in the trigger's first capture (decides what is sent to the grammar)
  990. std::string(data.thinking_forced_open ? "[\\s\\S]*?(<\\|END_THINKING\\|>\\s*)" : "(?:<\\|START_THINKING\\|>[\\s\\S]*?<\\|END_THINKING\\|>\\s*)?") +
  991. "(<\\|START_ACTION\\|>)[\\s\\S]*"
  992. });
  993. data.preserved_tokens = {
  994. "<|START_ACTION|>",
  995. "<|END_ACTION|>",
  996. "<|START_RESPONSE|>",
  997. "<|END_RESPONSE|>",
  998. "<|START_THINKING|>",
  999. "<|END_THINKING|>",
  1000. };
  1001. return data;
  1002. }
  1003. static void common_chat_parse_command_r7b(common_chat_msg_parser & builder) {
  1004. builder.try_parse_reasoning("<|START_THINKING|>", "<|END_THINKING|>");
  1005. static const common_regex start_action_regex("<\\|START_ACTION\\|>");
  1006. static const common_regex end_action_regex("<\\|END_ACTION\\|>");
  1007. static const common_regex start_response_regex("<\\|START_RESPONSE\\|>");
  1008. static const common_regex end_response_regex("<\\|END_RESPONSE\\|>");
  1009. if (auto res = builder.try_find_regex(start_action_regex)) {
  1010. // If we didn't extract thoughts, prelude includes them.
  1011. auto tool_calls = builder.consume_json_with_dumped_args({{"parameters"}});
  1012. for (const auto & tool_call : tool_calls.value) {
  1013. std::string name = tool_call.contains("tool_name") ? tool_call.at("tool_name") : "";
  1014. std::string id = tool_call.contains("tool_call_id") ? tool_call.at("tool_call_id") : "";
  1015. std::string arguments = tool_call.contains("parameters") ? tool_call.at("parameters") : "";
  1016. if (!builder.add_tool_call(name, id, arguments) || tool_calls.is_partial) {
  1017. throw common_chat_msg_partial_exception("incomplete tool call");
  1018. }
  1019. }
  1020. if (tool_calls.is_partial) {
  1021. throw common_chat_msg_partial_exception("incomplete tool call");
  1022. }
  1023. builder.consume_regex(end_action_regex);
  1024. } else if (auto res = builder.try_find_regex(start_response_regex)) {
  1025. if (!builder.try_find_regex(end_response_regex)) {
  1026. builder.add_content(builder.consume_rest());
  1027. throw common_chat_msg_partial_exception(end_response_regex.str());
  1028. }
  1029. } else {
  1030. builder.add_content(builder.consume_rest());
  1031. }
  1032. }
  1033. static void expect_tool_parameters(const std::string & name, const json & parameters, const std::vector<std::string> & expected_properties) {
  1034. if (!parameters.is_object() || !parameters.contains("type") || parameters.at("type") != "object" || !parameters.contains("properties") || !parameters.contains("required")) {
  1035. throw std::runtime_error("Parameters of tool " + name + " must be an object w/ required properties");
  1036. }
  1037. const auto & parameters_properties = parameters.at("properties");
  1038. const auto & parameters_required = parameters.at("required");
  1039. for (const auto & prop : expected_properties) {
  1040. if (!parameters_properties.contains(prop)) {
  1041. throw std::runtime_error("Parameters of tool " + name + " is missing property: " + prop); // NOLINT
  1042. }
  1043. if (std::find(parameters_required.begin(), parameters_required.end(), json(prop)) == parameters_required.end()) {
  1044. throw std::runtime_error("Parameters of tool " + name + " must have property marked as required: " + prop); // NOLINT
  1045. }
  1046. }
  1047. if (parameters_properties.size() != expected_properties.size()) {
  1048. throw std::runtime_error("Parameters of tool " + name + " must only have these properties:" + string_join(expected_properties, ", "));
  1049. }
  1050. }
  1051. 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) {
  1052. auto builtin_tools = json::array();
  1053. common_chat_params data;
  1054. if (!inputs.tools.is_null()) {
  1055. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1056. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1057. std::vector<std::string> tool_rules;
  1058. auto handle_builtin_tool = [&](const std::string & name, const json & parameters) {
  1059. if (name == "wolfram_alpha" || name == "web_search" || name == "brave_search") {
  1060. // https://github.com/meta-llama/llama-stack/blob/main/llama_stack/providers/remote/tool_runtime/wolfram_alpha/wolfram_alpha.py
  1061. // https://github.com/meta-llama/llama-stack/blob/main/llama_stack/providers/remote/tool_runtime/brave_search/brave_search.py
  1062. expect_tool_parameters(name, parameters, {"query"});
  1063. } else if (name == "python" || name == "code_interpreter") {
  1064. // https://github.com/meta-llama/llama-stack/blob/main/llama_stack/providers/inline/tool_runtime/code_interpreter/code_interpreter.py
  1065. expect_tool_parameters(name, parameters, {"code"});
  1066. } else {
  1067. return false;
  1068. }
  1069. std::vector<std::string> kvs;
  1070. for (const auto & [key, value] : parameters.at("properties").items()) {
  1071. kvs.push_back("\"" + key + "=\" " + builder.add_schema(name + "-args-" + key, value)); // NOLINT
  1072. }
  1073. tool_rules.push_back(
  1074. builder.add_rule(
  1075. name + "-call",
  1076. "\"<|python_tag|>" + name + ".call(\" " + string_join(kvs, " \", \" ") + " \")\""));
  1077. builtin_tools.push_back(name);
  1078. return true;
  1079. };
  1080. foreach_function(inputs.tools, [&](const json & tool) {
  1081. const auto & function = tool.at("function");
  1082. std::string name = function.at("name");
  1083. auto parameters = function.at("parameters");
  1084. builder.resolve_refs(parameters);
  1085. // https://github.com/meta-llama/llama-stack/tree/main/llama_stack/providers/remote/tool_runtime
  1086. if (allow_python_tag_builtin_tools) {
  1087. handle_builtin_tool(name, parameters);
  1088. }
  1089. tool_rules.push_back(
  1090. builder.add_rule(
  1091. name + "-call",
  1092. "\"{\" space "
  1093. "( \"\\\"type\\\"\" space \":\" space \"\\\"function\\\"\" space \",\" space )? "
  1094. " \"\\\"name\\\"\" space \":\" space \"\\\"" + name + "\\\"\" space \",\" space "
  1095. " \"\\\"parameters\\\"\" space \":\" space " + builder.add_schema(name + "-args", parameters) + " "
  1096. "\"}\" space"));
  1097. });
  1098. // 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.
  1099. data.grammar_triggers.push_back({
  1100. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1101. "(\\{\\s*(?:\"type\"\\s*:\\s*\"function\"\\s*,\\s*)?\"name\"\\s*:\\s*\")[\\s\\S]*", // + name + "\"[\\s\\S]*",
  1102. });
  1103. if (!builtin_tools.empty()) {
  1104. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<|python_tag|>"});
  1105. data.preserved_tokens.push_back("<|python_tag|>");
  1106. }
  1107. // Allow a few empty lines on top of the usual constrained json schema space rule.
  1108. builder.add_rule("root", string_join(tool_rules, " | "));
  1109. data.additional_stops.push_back("<|eom_id|>");
  1110. });
  1111. data.format = allow_python_tag_builtin_tools && !builtin_tools.empty()
  1112. ? COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS
  1113. : COMMON_CHAT_FORMAT_LLAMA_3_X;
  1114. } else {
  1115. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1116. }
  1117. data.prompt = apply(tmpl, inputs, /* messages_override =*/ std::nullopt, /* tools_override= */ std::nullopt, json {
  1118. {"date_string", format_time(inputs.now, "%d %b %Y")},
  1119. {"tools_in_user_message", false},
  1120. {"builtin_tools", builtin_tools.empty() ? json() : builtin_tools},
  1121. });
  1122. return data;
  1123. }
  1124. static common_chat_params common_chat_params_init_nemotron_v2(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1125. common_chat_params data;
  1126. // Generate the prompt using the apply() function with the template
  1127. data.prompt = apply(tmpl, inputs);
  1128. data.format = COMMON_CHAT_FORMAT_NEMOTRON_V2;
  1129. // Handle thinking tags appropriately based on inputs.enable_thinking
  1130. if (string_ends_with(data.prompt, "<think>\n")) {
  1131. if (!inputs.enable_thinking) {
  1132. data.prompt += "</think>";
  1133. } else {
  1134. data.thinking_forced_open = true;
  1135. }
  1136. }
  1137. // When tools are present, build grammar for the <TOOLCALL> format, similar to CommandR, but without tool call ID
  1138. if (!inputs.tools.is_null() && inputs.tools.is_array() && !inputs.tools.empty()) {
  1139. data.grammar_lazy = true;
  1140. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1141. auto schemas = json::array();
  1142. foreach_function(inputs.tools, [&](const json & tool) {
  1143. const auto & function = tool.at("function");
  1144. schemas.push_back({
  1145. { "type", "object" },
  1146. { "properties",
  1147. {
  1148. { "name",
  1149. {
  1150. { "type", "string" },
  1151. { "const", function.at("name") },
  1152. } },
  1153. { "arguments", function.at("parameters") },
  1154. } },
  1155. { "required", json::array({ "name", "arguments" }) },
  1156. });
  1157. });
  1158. auto schema = json{
  1159. { "type", "array" },
  1160. { "items", schemas.size() == 1 ? schemas[0] : json{ { "anyOf", schemas } } },
  1161. { "minItems", 1 },
  1162. };
  1163. if (!inputs.parallel_tool_calls) {
  1164. schema["maxItems"] = 1;
  1165. }
  1166. builder.add_rule("root",
  1167. std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") +
  1168. "\"<TOOLCALL>\" " + builder.add_schema("tool_calls", schema) +
  1169. " \"</TOOLCALL>\"");
  1170. });
  1171. data.grammar_triggers.push_back({ COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1172. // If thinking_forced_open, then we capture the </think> tag in the grammar,
  1173. // (important for required tool choice) and in the trigger's first capture (decides what is sent to the grammar)
  1174. std::string(data.thinking_forced_open ?
  1175. "[\\s\\S]*?(</think>\\s*)" :
  1176. "(?:<think>[\\s\\S]*?</think>\\s*)?") +
  1177. "(<TOOLCALL>)[\\s\\S]*" });
  1178. }
  1179. return data;
  1180. }
  1181. static void common_chat_parse_llama_3_1(common_chat_msg_parser & builder, bool with_builtin_tools = false) {
  1182. if (!builder.syntax().parse_tool_calls) {
  1183. builder.add_content(builder.consume_rest());
  1184. return;
  1185. }
  1186. static const common_regex function_regex(
  1187. "\\s*\\{\\s*(?:\"type\"\\s*:\\s*\"function\"\\s*,\\s*)?\"name\"\\s*:\\s*\"([^\"]+)\"\\s*,\\s*\"parameters\"\\s*: ");
  1188. static const common_regex close_regex("\\}\\s*");
  1189. static const common_regex function_name_regex("\\s*(\\w+)\\s*\\.\\s*call\\(");
  1190. static const common_regex arg_name_regex("\\s*(\\w+)\\s*=\\s*");
  1191. if (with_builtin_tools) {
  1192. static const common_regex builtin_call_regex("<\\|python_tag\\|>");
  1193. if (auto res = builder.try_find_regex(builtin_call_regex)) {
  1194. auto fun_res = builder.consume_regex(function_name_regex);
  1195. auto function_name = builder.str(fun_res.groups[1]);
  1196. common_healing_marker healing_marker;
  1197. json args = json::object();
  1198. while (true) {
  1199. if (auto arg_res = builder.try_consume_regex(arg_name_regex)) {
  1200. auto arg_name = builder.str(arg_res->groups[1]);
  1201. auto partial = builder.consume_json();
  1202. args[arg_name] = partial.json;
  1203. healing_marker.marker = partial.healing_marker.marker;
  1204. healing_marker.json_dump_marker = partial.healing_marker.json_dump_marker;
  1205. builder.consume_spaces();
  1206. if (!builder.try_consume_literal(",")) {
  1207. break;
  1208. }
  1209. } else {
  1210. break;
  1211. }
  1212. }
  1213. builder.consume_literal(")");
  1214. builder.consume_spaces();
  1215. auto arguments = args.dump();
  1216. if (!builder.add_tool_call(function_name, "", arguments)) {
  1217. throw common_chat_msg_partial_exception("Incomplete tool call");
  1218. }
  1219. return;
  1220. }
  1221. }
  1222. parse_json_tool_calls(
  1223. builder,
  1224. /* block_open= */ std::nullopt,
  1225. /* function_regex_start_only= */ function_regex,
  1226. /* function_regex= */ std::nullopt,
  1227. close_regex,
  1228. std::nullopt);
  1229. }
  1230. static common_chat_params common_chat_params_init_deepseek_r1(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1231. common_chat_params data;
  1232. auto prompt = apply(tmpl, inputs);
  1233. // Hacks to fix the official (broken) prompt.
  1234. // It is advisable to use --chat-template-file models/templates/llama-cpp-deepseek-r1.jinja instead,
  1235. // until the official template is fixed.
  1236. if (tmpl.source().find("{% if ns.is_tool %}{{'<|tool▁outputs▁end|>'}}") != std::string::npos) {
  1237. // Don't leave the chat dangling after tool results
  1238. if (string_ends_with(prompt, "<|tool▁outputs▁end|>")) {
  1239. prompt += "<|end▁of▁sentence|>";
  1240. if (inputs.add_generation_prompt) {
  1241. prompt += "<|Assistant|>";
  1242. }
  1243. }
  1244. // Fix up tool call delta example added by Minja
  1245. prompt = std::regex_replace(
  1246. prompt,
  1247. std::regex("(<|tool▁call▁end|>)[\\s\\r\\n]*(<|tool▁outputs▁begin|>|<|User|>)"),
  1248. "$1<|tool▁calls▁end|><|end▁of▁sentence|>$2");
  1249. }
  1250. data.prompt = prompt;
  1251. data.format = COMMON_CHAT_FORMAT_DEEPSEEK_R1;
  1252. if (string_ends_with(data.prompt, "<think>\n")) {
  1253. if (!inputs.enable_thinking) {
  1254. data.prompt += "</think>";
  1255. } else {
  1256. data.thinking_forced_open = true;
  1257. }
  1258. }
  1259. if (inputs.tools.is_array() && !inputs.tools.empty()) {
  1260. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED && inputs.json_schema.is_null();
  1261. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1262. std::vector<std::string> tool_rules;
  1263. foreach_function(inputs.tools, [&](const json & tool) {
  1264. const auto & function = tool.at("function");
  1265. std::string name = function.at("name");
  1266. auto parameters = function.at("parameters");
  1267. builder.resolve_refs(parameters);
  1268. tool_rules.push_back(builder.add_rule(name + "-call",
  1269. "( \"<|tool▁call▁begin|>\" )? \"function<|tool▁sep|>" + name + "\\n"
  1270. "```json\\n\" " + builder.add_schema(name + "-args", parameters) + " "
  1271. "\"```<|tool▁call▁end|>\""));
  1272. });
  1273. // Distill Qwen 7B & 32B models seem confused re/ syntax of their tool call opening tag,
  1274. // so we accept common variants (then it's all constrained)
  1275. builder.add_rule("root",
  1276. std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") +
  1277. "( \"<|tool▁calls▁begin|>\" | \"<|tool_calls_begin|>\" | \"<|tool calls begin|>\" | \"<|tool\\\\_calls\\\\_begin|>\" | \"<|tool▁calls|>\" ) "
  1278. "(" + string_join(tool_rules, " | ") + ")" + (inputs.parallel_tool_calls ? "*" : "") + " "
  1279. "\"<|tool▁calls▁end|>\""
  1280. " space");
  1281. data.grammar_triggers.push_back({
  1282. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1283. // If thinking_forced_open, then we capture the </think> tag in the grammar,
  1284. // (important for required tool choice) and in the trigger's first capture (decides what is sent to the grammar)
  1285. std::string(data.thinking_forced_open ? "[\\s\\S]*?(</think>\\s*)" : "(?:<think>[\\s\\S]*?</think>\\s*)?") +
  1286. "(<|tool▁calls▁begin|>|<|tool_calls_begin|>|<|tool calls begin|>|<|tool\\\\_calls\\\\_begin|>|<|tool▁calls|>)[\\s\\S]*"
  1287. });
  1288. data.preserved_tokens = {
  1289. "<think>",
  1290. "</think>",
  1291. "<|tool▁calls▁begin|>",
  1292. "<|tool▁call▁begin|>",
  1293. "<|tool▁sep|>",
  1294. "<|tool▁call▁end|>",
  1295. "<|tool▁calls▁end|",
  1296. };
  1297. });
  1298. }
  1299. return data;
  1300. }
  1301. static common_chat_params common_chat_params_init_deepseek_v3_1(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1302. common_chat_params data;
  1303. // Pass thinking context for DeepSeek V3.1 template
  1304. json additional_context = {
  1305. {"thinking", inputs.enable_thinking},
  1306. };
  1307. auto prompt = apply(tmpl, inputs,
  1308. /* messages_override= */ inputs.messages,
  1309. /* tools_override= */ std::nullopt,
  1310. additional_context);
  1311. data.prompt = prompt;
  1312. data.format = COMMON_CHAT_FORMAT_DEEPSEEK_V3_1;
  1313. if (string_ends_with(data.prompt, "<think>")) {
  1314. if (!inputs.enable_thinking) {
  1315. data.prompt += "</think>";
  1316. } else {
  1317. data.thinking_forced_open = true;
  1318. }
  1319. }
  1320. if (inputs.tools.is_array() && !inputs.tools.empty()) {
  1321. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED && inputs.json_schema.is_null();
  1322. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1323. std::vector<std::string> tool_rules;
  1324. foreach_function(inputs.tools, [&](const json & tool) {
  1325. const auto & function = tool.at("function");
  1326. std::string name = function.at("name");
  1327. auto parameters = function.at("parameters");
  1328. builder.resolve_refs(parameters);
  1329. tool_rules.push_back(builder.add_rule(name + "-call",
  1330. "( \"<|tool▁call▁begin|>\" )? \"" + name + "<|tool▁sep|>"
  1331. "\" " + builder.add_schema(name + "-args", parameters) + " "
  1332. "\"<|tool▁call▁end|>\""));
  1333. });
  1334. // Distill Qwen 7B & 32B models seem confused re/ syntax of their tool call opening tag,
  1335. // so we accept common variants (then it's all constrained)
  1336. builder.add_rule("root",
  1337. std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") +
  1338. "( \"<|tool▁calls▁begin|>\" | \"<|tool_calls_begin|>\" | \"<|tool calls begin|>\" | \"<|tool\\\\_calls\\\\_begin|>\" | \"<|tool▁calls|>\" ) "
  1339. "(" + string_join(tool_rules, " | ") + ")" + (inputs.parallel_tool_calls ? "*" : "") + " "
  1340. "\"<|tool▁calls▁end|>\""
  1341. " space");
  1342. data.grammar_triggers.push_back({
  1343. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1344. // If thinking_forced_open, then we capture the </think> tag in the grammar,
  1345. // (important for required tool choice) and in the trigger's first capture (decides what is sent to the grammar)
  1346. std::string(data.thinking_forced_open ? "[\\s\\S]*?(</think>\\s*)" : "(?:<think>[\\s\\S]*?</think>\\s*)?") +
  1347. "(<|tool▁calls▁begin|>|<|tool_calls_begin|>|<|tool calls begin|>|<|tool\\\\_calls\\\\_begin|>|<|tool▁calls|>)[\\s\\S]*"
  1348. });
  1349. data.preserved_tokens = {
  1350. "<think>",
  1351. "</think>",
  1352. "<|tool▁calls▁begin|>",
  1353. "<|tool▁call▁begin|>",
  1354. "<|tool▁sep|>",
  1355. "<|tool▁call▁end|>",
  1356. "<|tool▁calls▁end|>",
  1357. };
  1358. });
  1359. }
  1360. return data;
  1361. }
  1362. static void common_chat_parse_deepseek_r1(common_chat_msg_parser & builder) {
  1363. builder.try_parse_reasoning("<think>", "</think>");
  1364. if (!builder.syntax().parse_tool_calls) {
  1365. builder.add_content(builder.consume_rest());
  1366. return;
  1367. }
  1368. static const common_regex tool_calls_begin("(?:<|tool▁calls▁begin|>|<|tool_calls_begin|>|<|tool calls begin|>|<|tool\\\\_calls\\\\_begin|>|<|tool▁calls|>)");
  1369. static const common_regex tool_calls_end("<|tool▁calls▁end|>");
  1370. static const common_regex function_regex("(?:<|tool▁call▁begin|>)?function<|tool▁sep|>([^\n]+)\n```json\n");
  1371. static const common_regex close_regex("```[\\s\\r\\n]*<|tool▁call▁end|>");
  1372. parse_json_tool_calls(
  1373. builder,
  1374. /* block_open= */ tool_calls_begin,
  1375. /* function_regex_start_only= */ std::nullopt,
  1376. function_regex,
  1377. close_regex,
  1378. tool_calls_end);
  1379. }
  1380. static void common_chat_parse_deepseek_v3_1_content(common_chat_msg_parser & builder) {
  1381. static const common_regex function_regex("(?:<|tool▁call▁begin|>)?([^\\n<]+)(?:<|tool▁sep|>)");
  1382. static const common_regex close_regex("(?:[\\s]*)?<|tool▁call▁end|>");
  1383. static const common_regex tool_calls_begin("(?:<|tool▁calls▁begin|>|<|tool_calls_begin|>|<|tool calls begin|>|<|tool\\\\_calls\\\\_begin|>|<|tool▁calls|>)");
  1384. static const common_regex tool_calls_end("<|tool▁calls▁end|>");
  1385. if (!builder.syntax().parse_tool_calls) {
  1386. LOG_DBG("%s: not parse_tool_calls\n", __func__);
  1387. builder.add_content(builder.consume_rest());
  1388. return;
  1389. }
  1390. LOG_DBG("%s: parse_tool_calls\n", __func__);
  1391. parse_json_tool_calls(
  1392. builder,
  1393. /* block_open= */ tool_calls_begin,
  1394. /* function_regex_start_only= */ std::nullopt,
  1395. function_regex,
  1396. close_regex,
  1397. tool_calls_end);
  1398. }
  1399. static void common_chat_parse_deepseek_v3_1(common_chat_msg_parser & builder) {
  1400. // DeepSeek V3.1 outputs reasoning content between "<think>" and "</think>" tags, followed by regular content
  1401. // First try to parse using the standard reasoning parsing method
  1402. LOG_DBG("%s: thinking_forced_open: %s\n", __func__, std::to_string(builder.syntax().thinking_forced_open).c_str());
  1403. auto start_pos = builder.pos();
  1404. auto found_end_think = builder.try_find_literal("</think>");
  1405. builder.move_to(start_pos);
  1406. if (builder.syntax().thinking_forced_open && !builder.is_partial() && !found_end_think) {
  1407. LOG_DBG("%s: no end_think, not partial, adding content\n", __func__);
  1408. common_chat_parse_deepseek_v3_1_content(builder);
  1409. } else if (builder.try_parse_reasoning("<think>", "</think>")) {
  1410. // If reasoning was parsed successfully, the remaining content is regular content
  1411. LOG_DBG("%s: parsed reasoning, adding content\n", __func__);
  1412. // </think><|tool▁calls▁begin|><|tool▁call▁begin|>function<|tool▁sep|>NAME\n```json\nJSON\n```<|tool▁call▁end|><|tool▁calls▁end|>
  1413. common_chat_parse_deepseek_v3_1_content(builder);
  1414. } else {
  1415. if (builder.syntax().reasoning_format == COMMON_REASONING_FORMAT_NONE) {
  1416. LOG_DBG("%s: reasoning_format none, adding content\n", __func__);
  1417. common_chat_parse_deepseek_v3_1_content(builder);
  1418. return;
  1419. }
  1420. // If no reasoning tags found, check if we should treat everything as reasoning
  1421. if (builder.syntax().thinking_forced_open) {
  1422. // If thinking is forced open but no tags found, treat everything as reasoning
  1423. LOG_DBG("%s: thinking_forced_open, adding reasoning content\n", __func__);
  1424. builder.add_reasoning_content(builder.consume_rest());
  1425. } else {
  1426. LOG_DBG("%s: no thinking_forced_open, adding content\n", __func__);
  1427. // <|tool▁call▁begin|>NAME<|tool▁sep|>JSON<|tool▁call▁end|>
  1428. common_chat_parse_deepseek_v3_1_content(builder);
  1429. }
  1430. }
  1431. }
  1432. static common_chat_params common_chat_params_init_gpt_oss(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1433. common_chat_params data;
  1434. auto prompt = apply(tmpl, inputs);
  1435. // Check if we need to replace the return token with end token during
  1436. // inference and without generation prompt. For more details see:
  1437. // https://github.com/ggml-org/llama.cpp/issues/15417
  1438. if (inputs.is_inference && !inputs.add_generation_prompt) {
  1439. static constexpr std::string_view return_token = "<|return|>";
  1440. static constexpr std::string_view end_token = "<|end|>";
  1441. if (size_t pos = prompt.rfind(return_token); pos != std::string::npos) {
  1442. prompt.replace(pos, return_token.length(), end_token);
  1443. }
  1444. }
  1445. data.prompt = prompt;
  1446. data.format = COMMON_CHAT_FORMAT_GPT_OSS;
  1447. // These special tokens are required to parse properly, so we include them
  1448. // even if parse_tool_calls is false.
  1449. data.preserved_tokens = {
  1450. "<|channel|>",
  1451. "<|constrain|>",
  1452. "<|message|>",
  1453. "<|start|>",
  1454. "<|end|>",
  1455. };
  1456. if (!inputs.json_schema.is_null()) {
  1457. data.grammar_lazy = false;
  1458. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1459. auto schema = inputs.json_schema;
  1460. builder.resolve_refs(schema);
  1461. auto not_end = builder.add_rule("not-end",
  1462. "[^<] | \"<\" [^|] | \"<|\" [^e] | \"<|e\" [^n] | \"<|en\" [^d] | \"<|end\" [^|] | \"<|end|\" [^>]");
  1463. auto analysis = builder.add_rule("analysis",
  1464. "\"<|channel|>analysis<|message|>\" ( " + not_end + " )* \"<|end|>\"");
  1465. auto constraint = builder.add_rule("constraint", "\"<|constrain|>\"? [a-zA-Z0-9_-]+");
  1466. auto final = builder.add_rule("final",
  1467. "\"<|channel|>final\" ( \" \" " + constraint + " )? \"<|message|>\" " +
  1468. builder.add_schema("response", schema)
  1469. );
  1470. builder.add_rule("root", "( " + analysis + " \"<|start|>assistant\" )? " + final);
  1471. });
  1472. }
  1473. if (inputs.tools.is_array() && !inputs.tools.empty()) {
  1474. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1475. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1476. // tool calls can appear in commentary or analysis channels
  1477. auto channel = builder.add_rule("channel", "\"<|channel|>\" ( \"commentary\" | \"analysis\" )");
  1478. std::vector<std::string> tool_rules_recipient_in_role;
  1479. std::vector<std::string> tool_rules_recipient_in_channel;
  1480. foreach_function(inputs.tools, [&](const json & tool) {
  1481. const auto & function = tool.at("function");
  1482. std::string name = function.at("name");
  1483. auto parameters = function.at("parameters");
  1484. builder.resolve_refs(parameters);
  1485. tool_rules_recipient_in_role.push_back(
  1486. builder.add_rule(name + "-call",
  1487. "\"" + name + "\"" + channel + " \" <|constrain|>json\"? \"<|message|>\" " +
  1488. builder.add_schema(name + "-args", parameters)
  1489. )
  1490. );
  1491. tool_rules_recipient_in_channel.push_back(
  1492. builder.add_rule(name + "-call",
  1493. "\"" + name + "\"" + " \" <|constrain|>json\"? \"<|message|>\" " +
  1494. builder.add_schema(name + "-args", parameters)
  1495. )
  1496. );
  1497. });
  1498. auto recipient_in_role = builder.add_rule("recipient_in_role",
  1499. "\"<|start|>assistant\"? \" to=functions.\" ( " +
  1500. string_join(tool_rules_recipient_in_role, " | ") + " )"
  1501. );
  1502. auto recipient_in_channel = builder.add_rule("recipient_in_channel",
  1503. channel + " \" to=functions.\" ( " +
  1504. string_join(tool_rules_recipient_in_channel, " | ") + " )"
  1505. );
  1506. builder.add_rule("root", recipient_in_role + " | " + recipient_in_channel);
  1507. // Trigger on tool calls that appear in the commentary channel
  1508. data.grammar_triggers.push_back({
  1509. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN,
  1510. "<\\|channel\\|>(commentary|analysis) to"
  1511. });
  1512. // Trigger tool calls that appear in the role section, either at the
  1513. // start or in the middle.
  1514. data.grammar_triggers.push_back({
  1515. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1516. "^ to"
  1517. });
  1518. data.grammar_triggers.push_back({
  1519. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN,
  1520. "<\\|start\\|>assistant to"
  1521. });
  1522. });
  1523. }
  1524. return data;
  1525. }
  1526. static void common_chat_parse_gpt_oss(common_chat_msg_parser & builder) {
  1527. static const std::string constraint = "(?: (<\\|constrain\\|>)?([a-zA-Z0-9_-]+))";
  1528. static const std::string recipient("(?: to=functions\\.([^<\\s]+))");
  1529. static const common_regex start_regex("<\\|start\\|>assistant");
  1530. static const common_regex analysis_regex("<\\|channel\\|>analysis");
  1531. static const common_regex final_regex("<\\|channel\\|>final" + constraint + "?");
  1532. static const common_regex preamble_regex("<\\|channel\\|>commentary");
  1533. static const common_regex tool_call1_regex(recipient + "<\\|channel\\|>(analysis|commentary)" + constraint + "?");
  1534. static const common_regex tool_call2_regex("<\\|channel\\|>(analysis|commentary)" + recipient + constraint + "?");
  1535. auto consume_end = [&](bool include_end = false) {
  1536. if (auto res = builder.try_find_literal("<|end|>")) {
  1537. return res->prelude + (include_end ? builder.str(res->groups[0]) : "");
  1538. }
  1539. return builder.consume_rest();
  1540. };
  1541. auto handle_tool_call = [&](const std::string & name) {
  1542. if (auto args = builder.try_consume_json_with_dumped_args({{}})) {
  1543. if (builder.syntax().parse_tool_calls) {
  1544. if (!builder.add_tool_call(name, "", args->value) || args->is_partial) {
  1545. throw common_chat_msg_partial_exception("incomplete tool call");
  1546. }
  1547. } else if (args->is_partial) {
  1548. throw common_chat_msg_partial_exception("incomplete tool call");
  1549. }
  1550. }
  1551. };
  1552. auto regex_match = [](const common_regex & regex, const std::string & input) -> std::optional<common_regex_match> {
  1553. auto match = regex.search(input, 0, true);
  1554. if (match.type == COMMON_REGEX_MATCH_TYPE_FULL) {
  1555. return match;
  1556. }
  1557. return std::nullopt;
  1558. };
  1559. do {
  1560. auto header_start_pos = builder.pos();
  1561. auto content_start = builder.try_find_literal("<|message|>");
  1562. if (!content_start) {
  1563. throw common_chat_msg_partial_exception("incomplete header");
  1564. }
  1565. auto header = content_start->prelude;
  1566. if (auto match = regex_match(tool_call1_regex, header)) {
  1567. auto group = match->groups[1];
  1568. auto name = header.substr(group.begin, group.end - group.begin);
  1569. handle_tool_call(name);
  1570. continue;
  1571. }
  1572. if (auto match = regex_match(tool_call2_regex, header)) {
  1573. auto group = match->groups[2];
  1574. auto name = header.substr(group.begin, group.end - group.begin);
  1575. handle_tool_call(name);
  1576. continue;
  1577. }
  1578. if (regex_match(analysis_regex, header)) {
  1579. builder.move_to(header_start_pos);
  1580. if (builder.syntax().reasoning_format == COMMON_REASONING_FORMAT_NONE || builder.syntax().reasoning_in_content) {
  1581. builder.add_content(consume_end(true));
  1582. } else {
  1583. builder.try_parse_reasoning("<|channel|>analysis<|message|>", "<|end|>");
  1584. }
  1585. continue;
  1586. }
  1587. if(regex_match(final_regex, header) || regex_match(preamble_regex, header)) {
  1588. builder.add_content(consume_end());
  1589. continue;
  1590. }
  1591. // Possibly a malformed message, attempt to recover by rolling
  1592. // back to pick up the next <|start|>
  1593. LOG_DBG("%s: unknown header from message: %s\n", __func__, header.c_str());
  1594. builder.move_to(header_start_pos);
  1595. } while (builder.try_find_regex(start_regex, std::string::npos, false));
  1596. auto remaining = builder.consume_rest();
  1597. if (!remaining.empty()) {
  1598. LOG_DBG("%s: content after last message: %s\n", __func__, remaining.c_str());
  1599. }
  1600. }
  1601. static common_chat_params common_chat_params_init_firefunction_v2(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1602. LOG_DBG("%s\n", __func__);
  1603. common_chat_params data;
  1604. const std::optional<json> tools_override = json();
  1605. const std::optional<json> additional_context = json {
  1606. {"datetime", format_time(inputs.now, "%b %d %Y %H:%M:%S GMT")},
  1607. {"functions", json(inputs.tools.empty() ? "" : inputs.tools.dump(2))},
  1608. };
  1609. data.prompt = apply(tmpl, inputs, /* messages_override =*/ std::nullopt, tools_override, additional_context);
  1610. if (inputs.tools.is_array() && !inputs.tools.empty()) {
  1611. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1612. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1613. auto schemas = json::array();
  1614. foreach_function(inputs.tools, [&](const json & tool) {
  1615. const auto & function = tool.at("function");
  1616. schemas.push_back({
  1617. {"type", "object"},
  1618. {"properties", {
  1619. {"name", {
  1620. {"type", "string"},
  1621. {"const", function.at("name")},
  1622. }},
  1623. {"arguments", function.at("parameters")},
  1624. }},
  1625. {"required", json::array({"name", "arguments", "id"})},
  1626. });
  1627. });
  1628. auto schema = json {
  1629. {"type", "array"},
  1630. {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}},
  1631. {"minItems", 1},
  1632. };
  1633. if (!inputs.parallel_tool_calls) {
  1634. schema["maxItems"] = 1;
  1635. }
  1636. builder.add_rule("root", "\" functools\"? " + builder.add_schema("tool_calls", schema));
  1637. });
  1638. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, " functools["});
  1639. data.preserved_tokens = {
  1640. " functools[",
  1641. };
  1642. data.format = COMMON_CHAT_FORMAT_FIREFUNCTION_V2;
  1643. } else {
  1644. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1645. }
  1646. return data;
  1647. }
  1648. static void common_chat_parse_firefunction_v2(common_chat_msg_parser & builder) {
  1649. if (!builder.syntax().parse_tool_calls) {
  1650. builder.add_content(builder.consume_rest());
  1651. return;
  1652. }
  1653. static const common_regex prefix(regex_escape(" functools["));
  1654. parse_prefixed_json_tool_call_array(builder, prefix, /* rstrip_prefix= */ 1);
  1655. }
  1656. static common_chat_params common_chat_params_init_functionary_v3_2(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1657. // >>>all\nlet's call functions>>>fn1\n{"arg1": 1...}\n>>>fn2\n{"arg1": 1...}...
  1658. // Using ">>>f1\n", ">>>f2\n"... as trigger words for the grammar
  1659. // 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.
  1660. common_chat_params data;
  1661. data.prompt = apply(tmpl, inputs);
  1662. data.format = COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2;
  1663. if (inputs.tools.is_array() && !inputs.tools.empty()) {
  1664. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1665. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1666. std::vector<std::string> first_tool_rules;
  1667. std::vector<std::string> subsequent_tool_rules;
  1668. foreach_function(inputs.tools, [&](const json & tool) {
  1669. const auto & function = tool.at("function");
  1670. std::string name = function.at("name");
  1671. auto parameters = function.at("parameters");
  1672. builder.resolve_refs(parameters);
  1673. std::string args_pattern = "[\\s\\S]*";
  1674. auto args_rule = builder.add_schema(name + "-args", parameters);
  1675. if (name == "python") {
  1676. args_rule = builder.add_rule(name + "-maybe-raw-args", args_rule + " | [^{] .*");
  1677. } else {
  1678. args_pattern = "\\{" + args_pattern;
  1679. }
  1680. auto call_rule = builder.add_rule(name + "-call", "\"" + name + "\\n\" " + args_rule);
  1681. first_tool_rules.push_back(call_rule);
  1682. if (inputs.parallel_tool_calls) {
  1683. subsequent_tool_rules.push_back(builder.add_rule(name + "-call2", "\">>>\" " + call_rule));
  1684. }
  1685. data.grammar_triggers.push_back({
  1686. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1687. "((?:[\\s\\S]+?>>>)?" + regex_escape(name) + "\n)" + args_pattern,
  1688. });
  1689. });
  1690. data.preserved_tokens = {
  1691. "<|end_header_id|>",
  1692. };
  1693. auto first_rule = first_tool_rules.empty() ? "" : builder.add_rule("first_tool_call", string_join(first_tool_rules, " | ")) + " space";
  1694. if (inputs.parallel_tool_calls) {
  1695. auto subsequent_rule = builder.add_rule("subsequent_tool_call", string_join(subsequent_tool_rules, " | ")) + " space";
  1696. builder.add_rule("root", first_rule + " (" + subsequent_rule + ")*");
  1697. } else {
  1698. builder.add_rule("root", first_rule);
  1699. }
  1700. });
  1701. }
  1702. return data;
  1703. }
  1704. static void common_chat_parse_functionary_v3_2(common_chat_msg_parser & builder) {
  1705. static const common_regex function_regex_start_only(R"((\w+\n\{|python\n|all\n))");
  1706. static const common_regex function_regex(R"(>>>(\w+\n\{|python\n|all\n))");
  1707. static const common_regex close_regex(R"(\s*)");
  1708. parse_json_tool_calls(
  1709. builder,
  1710. std::nullopt,
  1711. function_regex_start_only,
  1712. function_regex,
  1713. close_regex,
  1714. std::nullopt,
  1715. /* allow_raw_python= */ true,
  1716. /* get_function_name= */ [&](const auto & res) -> std::string {
  1717. auto at_start = res.groups[0].begin == 0;
  1718. auto name = builder.str(res.groups[1]);
  1719. if (!name.empty() && name.back() == '{') {
  1720. // Unconsume the opening brace '{' to ensure the JSON parsing goes well.
  1721. builder.move_back(1);
  1722. }
  1723. auto idx = name.find_last_not_of("\n{");
  1724. name = name.substr(0, idx + 1);
  1725. if (at_start && name == "all") {
  1726. return "";
  1727. }
  1728. return name;
  1729. });
  1730. }
  1731. static common_chat_params common_chat_params_init_functionary_v3_1_llama_3_1(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1732. // https://github.com/MeetKai/functionary/blob/main/tests/prompt_test_v3-llama3.1.txt
  1733. common_chat_params data;
  1734. if (!inputs.tools.is_null()) {
  1735. std::string python_code_argument_name;
  1736. auto has_raw_python = false;
  1737. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1738. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1739. std::vector<std::string> tool_rules;
  1740. foreach_function(inputs.tools, [&](const json & tool) {
  1741. const auto & function = tool.at("function");
  1742. const auto & parameters = function.at("parameters");
  1743. std::string name = function.at("name");
  1744. if (name == "python" || name == "ipython") {
  1745. if (!parameters.contains("type")) {
  1746. throw std::runtime_error("Missing type in python tool");
  1747. }
  1748. has_raw_python = true;
  1749. const auto & type = parameters.at("type");
  1750. if (type == "object") {
  1751. auto properties = parameters.at("properties");
  1752. for (auto it = properties.begin(); it != properties.end(); ++it) {
  1753. if (it.value().at("type") == "string") {
  1754. if (!python_code_argument_name.empty()) {
  1755. throw std::runtime_error("Multiple string arguments found in python tool");
  1756. }
  1757. python_code_argument_name = it.key();
  1758. }
  1759. }
  1760. if (python_code_argument_name.empty()) {
  1761. throw std::runtime_error("No string argument found in python tool");
  1762. }
  1763. } else if (type != "string") {
  1764. throw std::runtime_error("Invalid type in python tool: " + type.dump());
  1765. }
  1766. }
  1767. tool_rules.push_back(builder.add_rule(name + "-call", "\"<function=" + name + ">\" " + builder.add_schema(name + "-args", parameters) + " \"</function>\" space"));
  1768. });
  1769. if (has_raw_python) {
  1770. tool_rules.push_back(builder.add_rule("python-call", "\"<|python_tag|>\" .*"));
  1771. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<|python_tag|>"});
  1772. data.preserved_tokens.push_back("<|python_tag|>");
  1773. }
  1774. auto tool_call = builder.add_rule("tool_call", string_join(tool_rules, " | ")) + " space";
  1775. builder.add_rule("root", inputs.parallel_tool_calls ? "(" + tool_call + ")+" : tool_call);
  1776. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<function="});
  1777. });
  1778. data.format = COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1;
  1779. } else {
  1780. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1781. }
  1782. data.prompt = apply(tmpl, inputs);
  1783. // TODO: if (has_raw_python)
  1784. return data;
  1785. }
  1786. static void common_chat_parse_functionary_v3_1_llama_3_1(common_chat_msg_parser & builder) {
  1787. if (!builder.syntax().parse_tool_calls) {
  1788. builder.add_content(builder.consume_rest());
  1789. return;
  1790. }
  1791. // This version of Functionary still supports the llama 3.1 tool call format for the python tool.
  1792. static const common_regex python_tag_regex(regex_escape("<|python_tag|>"));
  1793. static const common_regex function_regex(R"(<function=(\w+)>)");
  1794. static const common_regex close_regex(R"(</function>)");
  1795. parse_json_tool_calls(
  1796. builder,
  1797. /* block_open= */ std::nullopt,
  1798. /* function_regex_start_only= */ std::nullopt,
  1799. function_regex,
  1800. close_regex,
  1801. std::nullopt);
  1802. if (auto res = builder.try_find_regex(python_tag_regex)) {
  1803. auto arguments = wrap_code_as_arguments(builder, builder.consume_rest());
  1804. builder.add_tool_call("python", "", arguments);
  1805. return;
  1806. }
  1807. }
  1808. static common_chat_params common_chat_params_init_hermes_2_pro(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1809. common_chat_params data;
  1810. json extra_context = json {
  1811. {"enable_thinking", inputs.enable_thinking},
  1812. };
  1813. extra_context.update(inputs.extra_context);
  1814. data.prompt = apply(tmpl, inputs, /* messages_override =*/ std::nullopt, /* tools_override= */ std::nullopt, extra_context);
  1815. data.format = COMMON_CHAT_FORMAT_HERMES_2_PRO;
  1816. if (string_ends_with(data.prompt, "<think>\n")) {
  1817. if (!extra_context["enable_thinking"]) {
  1818. data.prompt += "</think>";
  1819. } else {
  1820. data.thinking_forced_open = true;
  1821. }
  1822. }
  1823. if (!inputs.tools.is_null()) {
  1824. // (content)?(<tool_call>{"name": "foo", "arguments": {"a": 1}}</tool_call>)*
  1825. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1826. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1827. std::vector<std::string> tool_rules;
  1828. std::vector<std::string> tool_call_alts;
  1829. std::vector<std::string> escaped_names;
  1830. foreach_function(inputs.tools, [&](const json & tool) {
  1831. const auto & function = tool.at("function");
  1832. std::string name = function.at("name");
  1833. auto parameters = function.at("parameters");
  1834. builder.resolve_refs(parameters);
  1835. tool_rules.push_back(builder.add_schema(name + "-call", {
  1836. {"type", "object"},
  1837. {"properties", json {
  1838. {"name", json {{"const", name}}},
  1839. {"arguments", parameters},
  1840. }},
  1841. {"required", json::array({"name", "arguments"})},
  1842. }));
  1843. tool_call_alts.push_back(builder.add_rule(
  1844. name + "-function-tag",
  1845. "\"<function\" ( \"=" + name + "\" | \" name=\\\"" + name + "\\\"\" ) \">\" space " +
  1846. builder.add_schema(name + "-args", parameters) + " "
  1847. "\"</function>\" space"));
  1848. data.grammar_triggers.push_back({
  1849. COMMON_GRAMMAR_TRIGGER_TYPE_WORD,
  1850. "<function=" + name + ">",
  1851. });
  1852. auto escaped_name = regex_escape(name);
  1853. data.grammar_triggers.push_back({
  1854. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN,
  1855. "<function\\s+name\\s*=\\s*\"" + escaped_name + "\"",
  1856. });
  1857. escaped_names.push_back(escaped_name);
  1858. });
  1859. auto any_tool_call = builder.add_rule("any_tool_call", "( " + string_join(tool_rules, " | ") + " ) space");
  1860. std::vector<std::string> alt_tags {
  1861. any_tool_call,
  1862. "\"<tool_call>\" space " + any_tool_call + " \"</tool_call>\"",
  1863. // The rest is just to accommodate common "good bad" outputs.
  1864. "\"<function_call>\" space " + any_tool_call + " \"</function_call>\"",
  1865. "\"<response>\" space " + any_tool_call + " \"</response>\"",
  1866. "\"<tools>\" space " + any_tool_call + " \"</tools>\"",
  1867. "\"<json>\" space " + any_tool_call + " \"</json>\"",
  1868. "\"<xml>\" space " + any_tool_call + " \"</xml>\"",
  1869. "\"<JSON>\" space " + any_tool_call + " \"</JSON>\"",
  1870. };
  1871. auto wrappable_tool_call = builder.add_rule("wrappable_tool_call", "( " + string_join(alt_tags, " | ") + " ) space");
  1872. tool_call_alts.push_back(wrappable_tool_call);
  1873. tool_call_alts.push_back(
  1874. "( \"```\\n\" | \"```json\\n\" | \"```xml\\n\" ) space " + wrappable_tool_call + " space \"```\" space ");
  1875. auto tool_call = builder.add_rule("tool_call", string_join(tool_call_alts, " | "));
  1876. builder.add_rule("root",
  1877. std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") +
  1878. (inputs.parallel_tool_calls ? "(" + tool_call + ")+" : tool_call));
  1879. // 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)
  1880. data.grammar_triggers.push_back({
  1881. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1882. // If thinking_forced_open, then we capture the </think> tag in the grammar,
  1883. // (important for required tool choice) and in the trigger's first capture (decides what is sent to the grammar)
  1884. std::string(data.thinking_forced_open ? "[\\s\\S]*?(</think>\\s*)" : "(?:<think>[\\s\\S]*?</think>\\s*)?") + (
  1885. "\\s*("
  1886. "(?:<tool_call>"
  1887. "|<function"
  1888. "|(?:```(?:json|xml)?\n\\s*)?(?:<function_call>|<tools>|<xml><json>|<response>)?"
  1889. "\\s*\\{\\s*\"name\"\\s*:\\s*\"(?:" + string_join(escaped_names, "|") + ")\""
  1890. ")"
  1891. ")[\\s\\S]*"
  1892. ),
  1893. });
  1894. data.preserved_tokens = {
  1895. "<think>",
  1896. "</think>",
  1897. "<tool_call>",
  1898. "</tool_call>",
  1899. "<function",
  1900. "<tools>",
  1901. "</tools>",
  1902. "<response>",
  1903. "</response>",
  1904. "<function_call>",
  1905. "</function_call>",
  1906. "<json>",
  1907. "</json>",
  1908. "<JSON>",
  1909. "</JSON>",
  1910. "```",
  1911. "```json",
  1912. "```xml",
  1913. };
  1914. });
  1915. }
  1916. return data;
  1917. }
  1918. static void common_chat_parse_hermes_2_pro(common_chat_msg_parser & builder) {
  1919. builder.try_parse_reasoning("<think>", "</think>");
  1920. if (!builder.syntax().parse_tool_calls) {
  1921. builder.add_content(builder.consume_rest());
  1922. return;
  1923. }
  1924. static const common_regex open_regex(
  1925. "(?:"
  1926. "(```(?:xml|json)?\\n\\s*)?" // match 1 (block_start)
  1927. "(" // match 2 (open_tag)
  1928. "<tool_call>"
  1929. "|<function_call>"
  1930. "|<tool>"
  1931. "|<tools>"
  1932. "|<response>"
  1933. "|<json>"
  1934. "|<xml>"
  1935. "|<JSON>"
  1936. ")?"
  1937. "(\\s*\\{\\s*\"name\")" // match 3 (named tool call)
  1938. ")"
  1939. "|<function=([^>]+)>" // match 4 (function name)
  1940. "|<function name=\"([^\"]+)\">" // match 5 (function name again)
  1941. );
  1942. while (auto res = builder.try_find_regex(open_regex)) {
  1943. const auto & block_start = res->groups[1];
  1944. std::string block_end = block_start.empty() ? "" : "```";
  1945. const auto & open_tag = res->groups[2];
  1946. std::string close_tag;
  1947. if (!res->groups[3].empty()) {
  1948. builder.move_to(res->groups[3].begin);
  1949. close_tag = open_tag.empty() ? "" : "</" + builder.str(open_tag).substr(1);
  1950. if (auto tool_call = builder.try_consume_json_with_dumped_args({{"arguments"}})) {
  1951. if (!builder.add_tool_call(tool_call->value) || tool_call->is_partial) {
  1952. throw common_chat_msg_partial_exception("incomplete tool call");
  1953. }
  1954. builder.consume_spaces();
  1955. builder.consume_literal(close_tag);
  1956. builder.consume_spaces();
  1957. if (!block_end.empty()) {
  1958. builder.consume_literal(block_end);
  1959. builder.consume_spaces();
  1960. }
  1961. } else {
  1962. throw common_chat_msg_partial_exception("failed to parse tool call");
  1963. }
  1964. } else {
  1965. auto function_name = builder.str(res->groups[4]);
  1966. if (function_name.empty()) {
  1967. function_name = builder.str(res->groups[5]);
  1968. }
  1969. GGML_ASSERT(!function_name.empty());
  1970. close_tag = "</function>";
  1971. if (auto arguments = builder.try_consume_json_with_dumped_args({{}})) {
  1972. if (!builder.add_tool_call(function_name, "", arguments->value) || arguments->is_partial) {
  1973. throw common_chat_msg_partial_exception("incomplete tool call");
  1974. }
  1975. builder.consume_spaces();
  1976. builder.consume_literal(close_tag);
  1977. builder.consume_spaces();
  1978. if (!block_end.empty()) {
  1979. builder.consume_literal(block_end);
  1980. builder.consume_spaces();
  1981. }
  1982. }
  1983. }
  1984. }
  1985. builder.add_content(builder.consume_rest());
  1986. }
  1987. static common_chat_params common_chat_params_init_granite(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1988. common_chat_params data;
  1989. // Pass thinking context for Granite template
  1990. json additional_context = {
  1991. {"thinking", inputs.enable_thinking},
  1992. };
  1993. data.prompt = apply(tmpl, inputs, /* messages_override= */ std::nullopt, /* tools_override= */ std::nullopt, additional_context);
  1994. data.format = COMMON_CHAT_FORMAT_GRANITE;
  1995. if (string_ends_with(data.prompt, "<think>\n") || string_ends_with(data.prompt, "<think>")) {
  1996. if (!inputs.enable_thinking) {
  1997. data.prompt += "</think>";
  1998. } else {
  1999. data.thinking_forced_open = true;
  2000. }
  2001. }
  2002. if (!inputs.tools.is_null()) {
  2003. // Granite uses <|tool_call|> followed by JSON list
  2004. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  2005. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  2006. std::vector<std::string> tool_rules;
  2007. foreach_function(inputs.tools, [&](const json & tool) {
  2008. const auto & function = tool.at("function");
  2009. std::string name = function.at("name");
  2010. auto parameters = function.at("parameters");
  2011. builder.resolve_refs(parameters);
  2012. tool_rules.push_back(builder.add_rule(name + "-call", builder.add_schema(name +
  2013. "-args", {
  2014. {"type", "object"},
  2015. {"properties", {
  2016. {"name", {{"const", name}}},
  2017. {"arguments", parameters},
  2018. }},
  2019. {"required", json::array({"name", "arguments"})},
  2020. })));
  2021. });
  2022. auto tool_call = builder.add_rule("tool_call", string_join(tool_rules, " | "));
  2023. auto tool_list = builder.add_rule("tool_list", "\"[\" space " + tool_call + " (\",\" space " + tool_call + ")* space \"]\"");
  2024. if (data.thinking_forced_open) {
  2025. builder.add_rule("root", "\"</think>\" space \"<response>\" space [^<]* \"</response>\" space \"<|tool_call|>\" space " + tool_list);
  2026. } else {
  2027. builder.add_rule("root", "\"<|tool_call|>\" space " + tool_list);
  2028. }
  2029. data.grammar_triggers.push_back({
  2030. COMMON_GRAMMAR_TRIGGER_TYPE_WORD,
  2031. "<|tool_call|>"
  2032. });
  2033. data.preserved_tokens = {
  2034. "<think>",
  2035. "</think>",
  2036. "<response>",
  2037. "</response>",
  2038. "<|tool_call|>",
  2039. };
  2040. });
  2041. } else {
  2042. // Handle thinking tags for non-tool responses
  2043. if (data.thinking_forced_open && inputs.enable_thinking) {
  2044. data.grammar_lazy = false;
  2045. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  2046. builder.add_rule("root", "\"</think>\" space \"<response>\" space .* \"</response>\" space");
  2047. });
  2048. data.preserved_tokens = {
  2049. "<think>",
  2050. "</think>",
  2051. "<response>",
  2052. "</response>",
  2053. };
  2054. }
  2055. }
  2056. return data;
  2057. }
  2058. static void common_chat_parse_granite(common_chat_msg_parser & builder) {
  2059. // Parse thinking tags
  2060. builder.try_parse_reasoning("<think>", "</think>");
  2061. // Parse response tags using regex
  2062. static const common_regex response_regex("<response>([\\s\\S]*?)</response>");
  2063. if (auto res = builder.try_find_regex(response_regex)) {
  2064. // Extract the content between the tags (capture group 1)
  2065. auto content = builder.str(res->groups[1]);
  2066. builder.add_content(content);
  2067. builder.move_to(res->groups[0].end);
  2068. }
  2069. if (!builder.syntax().parse_tool_calls) {
  2070. builder.add_content(builder.consume_rest());
  2071. return;
  2072. }
  2073. // Look for tool calls
  2074. static const common_regex tool_call_regex(regex_escape("<|tool_call|>"));
  2075. if (auto res = builder.try_find_regex(tool_call_regex)) {
  2076. builder.move_to(res->groups[0].end);
  2077. // Expect JSON array of tool calls
  2078. auto tool_calls_data = builder.consume_json();
  2079. if (tool_calls_data.json.is_array()) {
  2080. if (!builder.add_tool_calls(tool_calls_data.json)) {
  2081. builder.add_content("<|tool_call|>" + tool_calls_data.json.dump());
  2082. }
  2083. } else {
  2084. builder.add_content("<|tool_call|>" + tool_calls_data.json.dump());
  2085. }
  2086. } else {
  2087. builder.add_content(builder.consume_rest());
  2088. }
  2089. }
  2090. static void common_chat_parse_nemotron_v2(common_chat_msg_parser & builder) {
  2091. // Parse thinking tags
  2092. builder.try_parse_reasoning("<think>", "</think>");
  2093. if (!builder.syntax().parse_tool_calls) {
  2094. builder.add_content(builder.consume_rest());
  2095. return;
  2096. }
  2097. // Look for tool calls
  2098. static const common_regex tool_call_regex(regex_escape("<TOOLCALL>"));
  2099. if (auto res = builder.try_find_regex(tool_call_regex)) {
  2100. builder.move_to(res->groups[0].end);
  2101. // Expect JSON array of tool calls
  2102. auto tool_calls_data = builder.consume_json();
  2103. if (tool_calls_data.json.is_array()) {
  2104. if (!builder.try_consume_literal("</TOOLCALL>")) {
  2105. throw common_chat_msg_partial_exception("Incomplete tool call");
  2106. }
  2107. builder.add_tool_calls(tool_calls_data.json);
  2108. } else {
  2109. throw common_chat_msg_partial_exception("Incomplete tool call");
  2110. }
  2111. }
  2112. builder.add_content(builder.consume_rest());
  2113. }
  2114. static void common_chat_parse_seed_oss(common_chat_msg_parser & builder) {
  2115. // Parse thinking tags first - this handles the main reasoning content
  2116. builder.try_parse_reasoning("<seed:think>", "</seed:think>");
  2117. if (!builder.syntax().parse_tool_calls) {
  2118. builder.add_content(builder.consume_rest());
  2119. return;
  2120. }
  2121. // Parse tool calls - Seed-OSS uses <seed:tool_call> format
  2122. static const common_regex tool_call_begin_regex("<seed:tool_call>");
  2123. static const common_regex tool_call_end_regex("</seed:tool_call>");
  2124. static const common_regex function_regex("<function=([^>]+)>");
  2125. static const common_regex param_regex("<parameter=([^>]+)>");
  2126. while (auto tool_res = builder.try_find_regex(tool_call_begin_regex)) {
  2127. builder.consume_spaces(); // Consume whitespace after <seed:tool_call>
  2128. // Look for function call inside tool call, ignore any content before it
  2129. if (auto func_res = builder.try_find_regex(function_regex, std::string::npos, false)) {
  2130. auto function_name = builder.str(func_res->groups[1]);
  2131. // Parse Seed-OSS parameters <parameter=name>value</parameter>
  2132. json args = json::object();
  2133. // Parse all parameters
  2134. while (auto param_res = builder.try_find_regex(param_regex, std::string::npos, false)) {
  2135. // again, ignore noise around parameters
  2136. auto param_name = builder.str(param_res->groups[1]);
  2137. builder.move_to(param_res->groups[0].end);
  2138. builder.consume_spaces(); // Consume whitespace after parameter
  2139. auto savedPos = builder.pos();
  2140. if (auto param_parse = builder.try_find_literal("</parameter>")) {
  2141. auto param = param_parse->prelude;
  2142. builder.move_to(savedPos);
  2143. try {
  2144. if (auto param_res = builder.try_consume_json()) {
  2145. args[param_name] = param_res->json;
  2146. } else {
  2147. args[param_name] = param;
  2148. }
  2149. } catch (json::exception &) {
  2150. args[param_name] = param;
  2151. }
  2152. } else {
  2153. throw common_chat_msg_partial_exception("Incomplete tool parameter");
  2154. }
  2155. }
  2156. // Look for closing function tag
  2157. auto end_func = builder.try_find_literal("</function>");
  2158. if (end_func) {
  2159. builder.move_to(end_func->groups[0].end);
  2160. builder.consume_spaces(); // Consume whitespace after </function>
  2161. // Add the tool call with parsed arguments, but only if we REALLY got the literal
  2162. auto eaten_fragment = builder.input().substr(end_func->groups[0].begin, end_func->groups[0].end);
  2163. auto funlen = std::string("</function>").length();
  2164. if (eaten_fragment.length() >= funlen && eaten_fragment.substr(0, funlen) == std::string("</function>")) {
  2165. if (!builder.add_tool_call(function_name, "", args.dump())) {
  2166. throw common_chat_msg_partial_exception("Incomplete tool call");
  2167. }
  2168. } else {
  2169. throw common_chat_msg_partial_exception("Incomplete tool call");
  2170. }
  2171. } else {
  2172. throw common_chat_msg_partial_exception("Incomplete tool call");
  2173. }
  2174. // Look for closing tool call tag
  2175. if (auto end_tool = builder.try_find_regex(tool_call_end_regex, std::string::npos, false)) {
  2176. builder.move_to(end_tool->groups[0].end);
  2177. builder.consume_spaces(); // Consume trailing whitespace after tool call
  2178. } else {
  2179. throw common_chat_msg_partial_exception("Incomplete tool call");
  2180. }
  2181. } else {
  2182. // No function found - don't consume content here, let it be handled at the end
  2183. break;
  2184. }
  2185. }
  2186. // Consume any remaining whitespace after all tool call processing
  2187. builder.consume_spaces();
  2188. auto remaining = builder.consume_rest();
  2189. // If there's any non-whitespace content remaining, add it as content
  2190. if (!string_strip(remaining).empty()) {
  2191. builder.add_content(remaining);
  2192. }
  2193. }
  2194. static common_chat_params common_chat_params_init_without_tools(const common_chat_template & tmpl, const struct templates_params & inputs) {
  2195. common_chat_params data;
  2196. data.prompt = apply(tmpl, inputs);
  2197. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  2198. data.grammar_lazy = false;
  2199. if (!inputs.json_schema.is_null()) {
  2200. if (!inputs.grammar.empty()) {
  2201. throw std::runtime_error("Either \"json_schema\" or \"grammar\" can be specified, but not both");
  2202. }
  2203. data.grammar = json_schema_to_grammar(inputs.json_schema);
  2204. } else {
  2205. data.grammar = inputs.grammar;
  2206. }
  2207. return data;
  2208. }
  2209. static common_chat_params common_chat_params_init_seed_oss(
  2210. const common_chat_template & tmpl,
  2211. templates_params & params,
  2212. const common_chat_templates_inputs & inputs)
  2213. {
  2214. common_chat_params data;
  2215. data.prompt = apply(tmpl, params);
  2216. data.format = COMMON_CHAT_FORMAT_SEED_OSS;
  2217. if (string_ends_with(data.prompt, "<seed:think>")) {
  2218. if (!inputs.enable_thinking) {
  2219. data.prompt += "</seed:think>";
  2220. } else {
  2221. data.thinking_forced_open = true;
  2222. }
  2223. }
  2224. if (params.tools.is_array() && !params.tools.empty()) {
  2225. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  2226. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  2227. std::vector<std::string> tool_rules;
  2228. foreach_function(params.tools, [&](const json & tool) {
  2229. const auto & function = tool.at("function");
  2230. std::string name = function.at("name");
  2231. auto parameters = function.at("parameters");
  2232. builder.resolve_refs(parameters);
  2233. // Create rule for Seed-OSS function call format
  2234. std::string param_rules;
  2235. if (parameters.contains("properties")) {
  2236. for (const auto & [key, value] : parameters.at("properties").items()) {
  2237. param_rules += "\"<parameter=" + key + ">\"" + builder.add_schema(name + "-arg-" + key, value) +
  2238. "\"</parameter>\"";
  2239. }
  2240. }
  2241. tool_rules.push_back(builder.add_rule(name + "-call",
  2242. "\"<seed:tool_call>\" space \"<function=" + name + ">\" space " +
  2243. param_rules +
  2244. " \"</function>\" space \"</seed:tool_call>\""));
  2245. });
  2246. data.grammar_triggers.push_back({ COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<seed:tool_call>" });
  2247. data.preserved_tokens = {
  2248. "<seed:think>", "</seed:think>", "<seed:tool_call>", "</seed:tool_call>",
  2249. "<function=", "</function>", "<parameter=", "</parameter>",
  2250. };
  2251. builder.add_rule("root", string_join(tool_rules, " | "));
  2252. });
  2253. }
  2254. return data;
  2255. }
  2256. static common_chat_params common_chat_templates_apply_jinja(
  2257. const struct common_chat_templates * tmpls,
  2258. const struct common_chat_templates_inputs & inputs)
  2259. {
  2260. templates_params params;
  2261. params.tools = common_chat_tools_to_json_oaicompat<json>(inputs.tools);
  2262. const auto & tmpl = params.tools.is_array() && tmpls->template_tool_use
  2263. ? *tmpls->template_tool_use
  2264. : *tmpls->template_default;
  2265. const auto & src = tmpl.source();
  2266. const auto & caps = tmpl.original_caps();
  2267. params.messages = common_chat_msgs_to_json_oaicompat<json>(inputs.messages, /* concat_text= */ !tmpl.original_caps().requires_typed_content);
  2268. params.add_generation_prompt = inputs.add_generation_prompt;
  2269. params.tool_choice = inputs.tool_choice;
  2270. params.enable_thinking = inputs.enable_thinking;
  2271. params.grammar = inputs.grammar;
  2272. params.now = inputs.now;
  2273. params.add_bos = tmpls->add_bos;
  2274. params.add_eos = tmpls->add_eos;
  2275. params.extra_context = json::object();
  2276. for (auto el : inputs.chat_template_kwargs) {
  2277. params.extra_context[el.first] = json::parse(el.second);
  2278. }
  2279. if (!inputs.json_schema.empty()) {
  2280. params.json_schema = json::parse(inputs.json_schema);
  2281. }
  2282. if (inputs.parallel_tool_calls && !tmpl.original_caps().supports_parallel_tool_calls) {
  2283. LOG_DBG("Disabling parallel_tool_calls because the template does not support it\n");
  2284. params.parallel_tool_calls = false;
  2285. } else {
  2286. params.parallel_tool_calls = inputs.parallel_tool_calls;
  2287. }
  2288. if (params.tools.is_array()) {
  2289. if (params.tool_choice != COMMON_CHAT_TOOL_CHOICE_NONE && !params.grammar.empty()) {
  2290. throw std::runtime_error("Cannot specify grammar with tools");
  2291. }
  2292. if (caps.supports_tool_calls && !caps.supports_tools) {
  2293. 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");
  2294. }
  2295. }
  2296. // DeepSeek V3.1: detect based on specific patterns in the template
  2297. if (src.find("message['prefix'] is defined and message['prefix'] and thinking") != std::string::npos &&
  2298. params.json_schema.is_null()) {
  2299. return common_chat_params_init_deepseek_v3_1(tmpl, params);
  2300. }
  2301. // DeepSeek R1: use handler in all cases except json schema (thinking / tools).
  2302. if (src.find("<|tool▁calls▁begin|>") != std::string::npos && params.json_schema.is_null()) {
  2303. return common_chat_params_init_deepseek_r1(tmpl, params);
  2304. }
  2305. // Command R7B: : use handler in all cases except json schema (thinking / tools).
  2306. if (src.find("<|END_THINKING|><|START_ACTION|>") != std::string::npos && params.json_schema.is_null()) {
  2307. return common_chat_params_init_command_r7b(tmpl, params);
  2308. }
  2309. // Granite (IBM) - detects thinking / tools support
  2310. if (src.find("elif thinking") != std::string::npos && src.find("<|tool_call|>") != std::string::npos) {
  2311. return common_chat_params_init_granite(tmpl, params);
  2312. }
  2313. // Hermes 2/3 Pro, Qwen 2.5 Instruct (w/ tools)
  2314. if (src.find("<tool_call>") != std::string::npos && params.json_schema.is_null()) {
  2315. return common_chat_params_init_hermes_2_pro(tmpl, params);
  2316. }
  2317. // GPT-OSS
  2318. if (src.find("<|channel|>") != std::string::npos) {
  2319. return common_chat_params_init_gpt_oss(tmpl, params);
  2320. }
  2321. // Seed-OSS
  2322. if (src.find("<seed:think>") != std::string::npos) {
  2323. return common_chat_params_init_seed_oss(tmpl, params, inputs);
  2324. }
  2325. // Nemotron v2
  2326. if (src.find("<SPECIAL_10>") != std::string::npos) {
  2327. return common_chat_params_init_nemotron_v2(tmpl, params);
  2328. }
  2329. // Use generic handler when mixing tools + JSON schema.
  2330. // TODO: support that mix in handlers below.
  2331. if ((params.tools.is_array() && params.json_schema.is_object())) {
  2332. return common_chat_params_init_generic(tmpl, params);
  2333. }
  2334. // Functionary prepends "all\n" to plain content outputs, so we use its handler in all cases.
  2335. if (src.find(">>>all") != std::string::npos) {
  2336. return common_chat_params_init_functionary_v3_2(tmpl, params);
  2337. }
  2338. // Firefunction v2 requires datetime and functions in the context even w/o tools, so we also use its handler in all cases.
  2339. if (src.find(" functools[") != std::string::npos) {
  2340. return common_chat_params_init_firefunction_v2(tmpl, params);
  2341. }
  2342. // Functionary v3.1 (w/ tools)
  2343. if (src.find("<|start_header_id|>") != std::string::npos
  2344. && src.find("<function=") != std::string::npos) {
  2345. return common_chat_params_init_functionary_v3_1_llama_3_1(tmpl, params);
  2346. }
  2347. // Llama 3.1, 3.2, 3.3 (also requires date_string so using it even w/o tools)
  2348. if (src.find("<|start_header_id|>ipython<|end_header_id|>") != std::string::npos) {
  2349. auto allow_python_tag_builtin_tools = src.find("<|python_tag|>") != std::string::npos;
  2350. return common_chat_params_init_llama_3_x(tmpl, params, allow_python_tag_builtin_tools);
  2351. }
  2352. // Plain handler (no tools)
  2353. if (params.tools.is_null() || inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_NONE) {
  2354. return common_chat_params_init_without_tools(tmpl, params);
  2355. }
  2356. // Mistral Nemo (w/ tools)
  2357. if (src.find("[TOOL_CALLS]") != std::string::npos) {
  2358. return common_chat_params_init_mistral_nemo(tmpl, params);
  2359. }
  2360. // Generic fallback
  2361. return common_chat_params_init_generic(tmpl, params);
  2362. }
  2363. // Legacy template route (adhoc C++ implementation of known templates), forward to llama_chat_apply_template.
  2364. static common_chat_params common_chat_templates_apply_legacy(
  2365. const struct common_chat_templates * tmpls,
  2366. const struct common_chat_templates_inputs & inputs)
  2367. {
  2368. int alloc_size = 0;
  2369. std::vector<llama_chat_message> chat;
  2370. std::vector<std::string> contents;
  2371. for (const auto & msg : inputs.messages) {
  2372. auto content = msg.content;
  2373. for (const auto & part : msg.content_parts) {
  2374. if (part.type != "text") {
  2375. LOG_WRN("Ignoring non-text content part: %s\n", part.type.c_str());
  2376. continue;
  2377. }
  2378. if (!content.empty()) {
  2379. content += "\n";;
  2380. }
  2381. content += part.text;
  2382. }
  2383. contents.emplace_back(std::move(content));
  2384. }
  2385. for (size_t i = 0; i < contents.size(); ++i) {
  2386. const auto & msg = inputs.messages[i];
  2387. const auto & content = contents[i];
  2388. chat.push_back({msg.role.c_str(), content.c_str()});
  2389. alloc_size += (msg.role.size() + content.size()) * 1.25;
  2390. }
  2391. std::vector<char> buf(alloc_size);
  2392. // run the first time to get the total output length
  2393. const auto & src = tmpls->template_default->source();
  2394. int32_t res = llama_chat_apply_template(src.c_str(), chat.data(), chat.size(), inputs.add_generation_prompt, buf.data(), buf.size());
  2395. // error: chat template is not supported
  2396. if (res < 0) {
  2397. // if the custom "tmpl" is not supported, we throw an error
  2398. // this is a bit redundant (for good), since we're not sure if user validated the custom template with llama_chat_verify_template()
  2399. throw std::runtime_error("this custom template is not supported, try using --jinja");
  2400. }
  2401. // if it turns out that our buffer is too small, we resize it
  2402. if ((size_t) res > buf.size()) {
  2403. buf.resize(res);
  2404. res = llama_chat_apply_template(src.c_str(), chat.data(), chat.size(), inputs.add_generation_prompt, buf.data(), buf.size());
  2405. }
  2406. common_chat_params params;
  2407. params.prompt = std::string(buf.data(), res);
  2408. if (!inputs.json_schema.empty()) {
  2409. params.grammar = json_schema_to_grammar(json::parse(inputs.json_schema));
  2410. } else {
  2411. params.grammar = inputs.grammar;
  2412. }
  2413. return params;
  2414. }
  2415. common_chat_params common_chat_templates_apply(
  2416. const struct common_chat_templates * tmpls,
  2417. const struct common_chat_templates_inputs & inputs)
  2418. {
  2419. GGML_ASSERT(tmpls != nullptr);
  2420. return inputs.use_jinja
  2421. ? common_chat_templates_apply_jinja(tmpls, inputs)
  2422. : common_chat_templates_apply_legacy(tmpls, inputs);
  2423. }
  2424. static void common_chat_parse_content_only(common_chat_msg_parser & builder) {
  2425. builder.add_content(builder.consume_rest());
  2426. }
  2427. static void common_chat_parse(common_chat_msg_parser & builder) {
  2428. LOG_DBG("Parsing input with format %s: %s\n", common_chat_format_name(builder.syntax().format), builder.input().c_str());
  2429. switch (builder.syntax().format) {
  2430. case COMMON_CHAT_FORMAT_CONTENT_ONLY:
  2431. common_chat_parse_content_only(builder);
  2432. break;
  2433. case COMMON_CHAT_FORMAT_GENERIC:
  2434. common_chat_parse_generic(builder);
  2435. break;
  2436. case COMMON_CHAT_FORMAT_MISTRAL_NEMO:
  2437. common_chat_parse_mistral_nemo(builder);
  2438. break;
  2439. case COMMON_CHAT_FORMAT_LLAMA_3_X:
  2440. common_chat_parse_llama_3_1(builder);
  2441. break;
  2442. case COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS:
  2443. common_chat_parse_llama_3_1(builder, /* with_builtin_tools= */ true);
  2444. break;
  2445. case COMMON_CHAT_FORMAT_DEEPSEEK_R1:
  2446. common_chat_parse_deepseek_r1(builder);
  2447. break;
  2448. case COMMON_CHAT_FORMAT_DEEPSEEK_V3_1:
  2449. common_chat_parse_deepseek_v3_1(builder);
  2450. break;
  2451. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2:
  2452. common_chat_parse_functionary_v3_2(builder);
  2453. break;
  2454. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1:
  2455. common_chat_parse_functionary_v3_1_llama_3_1(builder);
  2456. break;
  2457. case COMMON_CHAT_FORMAT_HERMES_2_PRO:
  2458. common_chat_parse_hermes_2_pro(builder);
  2459. break;
  2460. case COMMON_CHAT_FORMAT_FIREFUNCTION_V2:
  2461. common_chat_parse_firefunction_v2(builder);
  2462. break;
  2463. case COMMON_CHAT_FORMAT_COMMAND_R7B:
  2464. common_chat_parse_command_r7b(builder);
  2465. break;
  2466. case COMMON_CHAT_FORMAT_GRANITE:
  2467. common_chat_parse_granite(builder);
  2468. break;
  2469. case COMMON_CHAT_FORMAT_GPT_OSS:
  2470. common_chat_parse_gpt_oss(builder);
  2471. break;
  2472. case COMMON_CHAT_FORMAT_SEED_OSS:
  2473. common_chat_parse_seed_oss(builder);
  2474. break;
  2475. case COMMON_CHAT_FORMAT_NEMOTRON_V2:
  2476. common_chat_parse_nemotron_v2(builder);
  2477. break;
  2478. default:
  2479. throw std::runtime_error(std::string("Unsupported format: ") + common_chat_format_name(builder.syntax().format));
  2480. }
  2481. builder.finish();
  2482. }
  2483. common_chat_msg common_chat_parse(const std::string & input, bool is_partial, const common_chat_syntax & syntax) {
  2484. common_chat_msg_parser builder(input, is_partial, syntax);
  2485. try {
  2486. common_chat_parse(builder);
  2487. } catch (const common_chat_msg_partial_exception & ex) {
  2488. LOG_DBG("Partial parse: %s\n", ex.what());
  2489. if (!is_partial) {
  2490. builder.clear_tools();
  2491. builder.move_to(0);
  2492. common_chat_parse_content_only(builder);
  2493. }
  2494. }
  2495. auto msg = builder.result();
  2496. if (!is_partial) {
  2497. LOG_DBG("Parsed message: %s\n", common_chat_msgs_to_json_oaicompat<json>({msg}).at(0).dump().c_str());
  2498. }
  2499. return msg;
  2500. }