chat.cpp 137 KB

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