chat.cpp 137 KB

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