chat.cpp 128 KB

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