chat.cpp 110 KB

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