chat.cpp 134 KB

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