chat.cpp 112 KB

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