chat.cpp 85 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995
  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. };
  138. common_chat_tool_choice common_chat_tool_choice_parse_oaicompat(const std::string & tool_choice) {
  139. if (tool_choice == "auto") {
  140. return COMMON_CHAT_TOOL_CHOICE_AUTO;
  141. }
  142. if (tool_choice == "none") {
  143. return COMMON_CHAT_TOOL_CHOICE_NONE;
  144. }
  145. if (tool_choice == "required") {
  146. return COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  147. }
  148. throw std::runtime_error("Invalid tool_choice: " + tool_choice);
  149. }
  150. template <>
  151. std::vector<common_chat_msg> common_chat_msgs_parse_oaicompat(const json & messages) {
  152. std::vector<common_chat_msg> msgs;
  153. try {
  154. if (!messages.is_array()) {
  155. throw std::runtime_error("Expected 'messages' to be an array, got " + messages.dump());
  156. }
  157. for (const auto & message : messages) {
  158. if (!message.is_object()) {
  159. throw std::runtime_error("Expected 'message' to be an object, got " + message.dump());
  160. }
  161. common_chat_msg msg;
  162. if (!message.contains("role")) {
  163. throw std::runtime_error("Missing 'role' in message: " + message.dump());
  164. }
  165. msg.role = message.at("role");
  166. auto has_content = message.contains("content");
  167. auto has_tool_calls = message.contains("tool_calls");
  168. if (has_content) {
  169. const auto & content = message.at("content");
  170. if (content.is_string()) {
  171. msg.content = content;
  172. } else if (content.is_array()) {
  173. for (const auto & part : content) {
  174. if (!part.contains("type")) {
  175. throw std::runtime_error("Missing content part type: " + part.dump());
  176. }
  177. const auto & type = part.at("type");
  178. if (type != "text") {
  179. throw std::runtime_error("Unsupported content part type: " + type.dump());
  180. }
  181. common_chat_msg_content_part msg_part;
  182. msg_part.type = type;
  183. msg_part.text = part.at("text");
  184. msg.content_parts.push_back(msg_part);
  185. }
  186. } else if (!content.is_null()) {
  187. throw std::runtime_error("Invalid 'content' type: expected string or array, got " + content.dump() + " (ref: https://github.com/ggml-org/llama.cpp/issues/8367)");
  188. }
  189. }
  190. if (has_tool_calls) {
  191. for (const auto & tool_call : message.at("tool_calls")) {
  192. common_chat_tool_call tc;
  193. if (!tool_call.contains("type")) {
  194. throw std::runtime_error("Missing tool call type: " + tool_call.dump());
  195. }
  196. const auto & type = tool_call.at("type");
  197. if (type != "function") {
  198. throw std::runtime_error("Unsupported tool call type: " + tool_call.dump());
  199. }
  200. if (!tool_call.contains("function")) {
  201. throw std::runtime_error("Missing tool call function: " + tool_call.dump());
  202. }
  203. const auto & fc = tool_call.at("function");
  204. if (!fc.contains("name")) {
  205. throw std::runtime_error("Missing tool call name: " + tool_call.dump());
  206. }
  207. tc.name = fc.at("name");
  208. tc.arguments = fc.at("arguments");
  209. if (tool_call.contains("id")) {
  210. tc.id = tool_call.at("id");
  211. }
  212. msg.tool_calls.push_back(tc);
  213. }
  214. }
  215. if (!has_content && !has_tool_calls) {
  216. 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)");
  217. }
  218. if (message.contains("reasoning_content")) {
  219. msg.reasoning_content = message.at("reasoning_content");
  220. }
  221. if (message.contains("name")) {
  222. msg.tool_name = message.at("name");
  223. }
  224. if (message.contains("tool_call_id")) {
  225. msg.tool_call_id = message.at("tool_call_id");
  226. }
  227. msgs.push_back(msg);
  228. }
  229. } catch (const std::exception & e) {
  230. // @ngxson : disable otherwise it's bloating the API response
  231. // printf("%s\n", std::string("; messages = ") + messages.dump(2));
  232. throw std::runtime_error("Failed to parse messages: " + std::string(e.what()));
  233. }
  234. return msgs;
  235. }
  236. template <>
  237. json common_chat_msgs_to_json_oaicompat(const std::vector<common_chat_msg> & msgs, bool concat_typed_text) {
  238. json messages = json::array();
  239. for (const auto & msg : msgs) {
  240. if (!msg.content.empty() && !msg.content_parts.empty()) {
  241. throw std::runtime_error("Cannot specify both content and content_parts");
  242. }
  243. json jmsg {
  244. {"role", msg.role},
  245. };
  246. if (!msg.content.empty()) {
  247. jmsg["content"] = msg.content;
  248. } else if (!msg.content_parts.empty()) {
  249. if (concat_typed_text) {
  250. std::string text;
  251. for (const auto & part : msg.content_parts) {
  252. if (part.type != "text") {
  253. LOG_WRN("Ignoring content part type: %s\n", part.type.c_str());
  254. continue;
  255. }
  256. if (!text.empty()) {
  257. text += '\n';
  258. }
  259. text += part.text;
  260. }
  261. jmsg["content"] = text;
  262. } else {
  263. auto & parts = jmsg["content"] = json::array();
  264. for (const auto & part : msg.content_parts) {
  265. parts.push_back({
  266. {"type", part.type},
  267. {"text", part.text},
  268. });
  269. }
  270. }
  271. } else {
  272. jmsg["content"] = json(); // null
  273. }
  274. if (!msg.reasoning_content.empty()) {
  275. jmsg["reasoning_content"] = msg.reasoning_content;
  276. }
  277. if (!msg.tool_name.empty()) {
  278. jmsg["name"] = msg.tool_name;
  279. }
  280. if (!msg.tool_call_id.empty()) {
  281. jmsg["tool_call_id"] = msg.tool_call_id;
  282. }
  283. if (!msg.tool_calls.empty()) {
  284. auto & tool_calls = jmsg["tool_calls"] = json::array();
  285. for (const auto & tool_call : msg.tool_calls) {
  286. json tc {
  287. {"type", "function"},
  288. {"function", {
  289. {"name", tool_call.name},
  290. {"arguments", tool_call.arguments},
  291. }},
  292. };
  293. if (!tool_call.id.empty()) {
  294. tc["id"] = tool_call.id;
  295. }
  296. tool_calls.push_back(tc);
  297. }
  298. }
  299. messages.push_back(jmsg);
  300. }
  301. return messages;
  302. }
  303. template <>
  304. std::vector<common_chat_msg> common_chat_msgs_parse_oaicompat(const std::string & messages) {
  305. return common_chat_msgs_parse_oaicompat(json::parse(messages));
  306. }
  307. template <>
  308. std::vector<common_chat_tool> common_chat_tools_parse_oaicompat(const json & tools) {
  309. std::vector<common_chat_tool> result;
  310. try {
  311. if (!tools.is_null()) {
  312. if (!tools.is_array()) {
  313. throw std::runtime_error("Expected 'tools' to be an array, got " + tools.dump());
  314. }
  315. for (const auto & tool : tools) {
  316. if (!tool.contains("type")) {
  317. throw std::runtime_error("Missing tool type: " + tool.dump());
  318. }
  319. const auto & type = tool.at("type");
  320. if (!type.is_string() || type != "function") {
  321. throw std::runtime_error("Unsupported tool type: " + tool.dump());
  322. }
  323. if (!tool.contains("function")) {
  324. throw std::runtime_error("Missing tool function: " + tool.dump());
  325. }
  326. const auto & function = tool.at("function");
  327. result.push_back({
  328. /* .name = */ function.at("name"),
  329. /* .description = */ function.at("description"),
  330. /* .parameters = */ function.at("parameters").dump(),
  331. });
  332. }
  333. }
  334. } catch (const std::exception & e) {
  335. throw std::runtime_error("Failed to parse tools: " + std::string(e.what()) + "; tools = " + tools.dump(2));
  336. }
  337. return result;
  338. }
  339. template <>
  340. std::vector<common_chat_tool> common_chat_tools_parse_oaicompat(const std::string & tools) {
  341. return common_chat_tools_parse_oaicompat(json::parse(tools));
  342. }
  343. template <>
  344. json common_chat_tools_to_json_oaicompat(const std::vector<common_chat_tool> & tools) {
  345. if (tools.empty()) {
  346. return json();
  347. }
  348. auto result = json::array();
  349. for (const auto & tool : tools) {
  350. result.push_back({
  351. {"type", "function"},
  352. {"function", {
  353. {"name", tool.name},
  354. {"description", tool.description},
  355. {"parameters", json::parse(tool.parameters)},
  356. }},
  357. });
  358. }
  359. return result;
  360. }
  361. template <> json common_chat_msg_diff_to_json_oaicompat(const common_chat_msg_diff & diff) {
  362. json delta = json::object();
  363. if (!diff.reasoning_content_delta.empty()) {
  364. delta["reasoning_content"] = diff.reasoning_content_delta;
  365. }
  366. if (!diff.content_delta.empty()) {
  367. delta["content"] = diff.content_delta;
  368. }
  369. if (diff.tool_call_index != std::string::npos) {
  370. json tool_call;
  371. tool_call["index"] = diff.tool_call_index;
  372. if (!diff.tool_call_delta.id.empty()) {
  373. tool_call["id"] = diff.tool_call_delta.id;
  374. tool_call["type"] = "function";
  375. }
  376. json function = json::object();
  377. if (!diff.tool_call_delta.name.empty()) {
  378. function["name"] = diff.tool_call_delta.name;
  379. }
  380. function["arguments"] = diff.tool_call_delta.arguments;
  381. tool_call["function"] = function;
  382. delta["tool_calls"] = json::array({tool_call});
  383. }
  384. return delta;
  385. }
  386. bool common_chat_verify_template(const std::string & tmpl, bool use_jinja) {
  387. if (use_jinja) {
  388. try {
  389. common_chat_msg msg;
  390. msg.role = "user";
  391. msg.content = "test";
  392. auto tmpls = common_chat_templates_init(/* model= */ nullptr, tmpl);
  393. common_chat_templates_inputs inputs;
  394. inputs.messages = {msg};
  395. common_chat_templates_apply(tmpls.get(), inputs);
  396. return true;
  397. } catch (const std::exception & e) {
  398. LOG_ERR("%s: failed to apply template: %s\n", __func__, e.what());
  399. return false;
  400. }
  401. }
  402. llama_chat_message chat[] = {{"user", "test"}};
  403. const int res = llama_chat_apply_template(tmpl.c_str(), chat, 1, true, nullptr, 0);
  404. return res >= 0;
  405. }
  406. std::string common_chat_format_single(
  407. const struct common_chat_templates * tmpls,
  408. const std::vector<common_chat_msg> & past_msg,
  409. const common_chat_msg & new_msg,
  410. bool add_ass,
  411. bool use_jinja) {
  412. common_chat_templates_inputs inputs;
  413. inputs.use_jinja = use_jinja;
  414. inputs.add_bos = tmpls->add_bos;
  415. inputs.add_eos = tmpls->add_eos;
  416. std::string fmt_past_msg;
  417. if (!past_msg.empty()) {
  418. inputs.messages = past_msg;
  419. inputs.add_generation_prompt = false;
  420. fmt_past_msg = common_chat_templates_apply(tmpls, inputs).prompt;
  421. }
  422. std::ostringstream ss;
  423. // if the past_msg ends with a newline, we must preserve it in the formatted version
  424. if (add_ass && !fmt_past_msg.empty() && fmt_past_msg.back() == '\n') {
  425. ss << "\n";
  426. };
  427. // format chat with new_msg
  428. inputs.messages.push_back(new_msg);
  429. inputs.add_generation_prompt = add_ass;
  430. auto fmt_new_msg = common_chat_templates_apply(tmpls, inputs).prompt;
  431. // get the diff part
  432. ss << fmt_new_msg.substr(fmt_past_msg.size(), fmt_new_msg.size() - fmt_past_msg.size());
  433. return ss.str();
  434. }
  435. std::string common_chat_format_example(const struct common_chat_templates * tmpls, bool use_jinja) {
  436. common_chat_templates_inputs inputs;
  437. inputs.use_jinja = use_jinja;
  438. inputs.add_bos = tmpls->add_bos;
  439. inputs.add_eos = tmpls->add_eos;
  440. auto add_simple_msg = [&](auto role, auto content) {
  441. common_chat_msg msg;
  442. msg.role = role;
  443. msg.content = content;
  444. inputs.messages.push_back(msg);
  445. };
  446. add_simple_msg("system", "You are a helpful assistant");
  447. add_simple_msg("user", "Hello");
  448. add_simple_msg("assistant", "Hi there");
  449. add_simple_msg("user", "How are you?");
  450. return common_chat_templates_apply(tmpls, inputs).prompt;
  451. }
  452. #define CHATML_TEMPLATE_SRC \
  453. "{%- for message in messages -%}\n" \
  454. " {{- '<|im_start|>' + message.role + '\n' + message.content + '<|im_end|>\n' -}}\n" \
  455. "{%- endfor -%}\n" \
  456. "{%- if add_generation_prompt -%}\n" \
  457. " {{- '<|im_start|>assistant\n' -}}\n" \
  458. "{%- endif -%}"
  459. void common_chat_templates_free(struct common_chat_templates * tmpls) {
  460. delete tmpls;
  461. }
  462. bool common_chat_templates_was_explicit(const struct common_chat_templates * tmpls) {
  463. return tmpls->has_explicit_template;
  464. }
  465. const char * common_chat_templates_source(const struct common_chat_templates * tmpls, const char * variant) {
  466. if (variant != nullptr) {
  467. if (strcmp(variant, "tool_use") == 0) {
  468. if (tmpls->template_tool_use) {
  469. return tmpls->template_tool_use->source().c_str();
  470. }
  471. return nullptr;
  472. } else {
  473. LOG_DBG("%s: unknown template variant: %s\n", __func__, variant);
  474. }
  475. }
  476. return tmpls->template_default->source().c_str();
  477. }
  478. common_chat_templates_ptr common_chat_templates_init(
  479. const struct llama_model * model,
  480. const std::string & chat_template_override,
  481. const std::string & bos_token_override,
  482. const std::string & eos_token_override)
  483. {
  484. std::string default_template_src;
  485. std::string template_tool_use_src;
  486. bool has_explicit_template = !chat_template_override.empty();
  487. if (chat_template_override.empty()) {
  488. GGML_ASSERT(model != nullptr);
  489. const auto * str = llama_model_chat_template(model, /* name */ nullptr);
  490. if (str) {
  491. default_template_src = str;
  492. has_explicit_template = true;
  493. }
  494. str = llama_model_chat_template(model, /* name */ "tool_use");
  495. if (str) {
  496. template_tool_use_src = str;
  497. has_explicit_template = true;
  498. }
  499. } else {
  500. default_template_src = chat_template_override;
  501. }
  502. if (default_template_src.empty() || default_template_src == "chatml") {
  503. if (!template_tool_use_src.empty()) {
  504. default_template_src = template_tool_use_src;
  505. } else {
  506. default_template_src = CHATML_TEMPLATE_SRC;
  507. }
  508. }
  509. std::string token_bos = bos_token_override;
  510. std::string token_eos = eos_token_override;
  511. bool add_bos = false;
  512. bool add_eos = false;
  513. if (model) {
  514. const auto * vocab = llama_model_get_vocab(model);
  515. const auto get_token = [&](llama_token token, const char * name, const char * jinja_variable_name) {
  516. if (token == LLAMA_TOKEN_NULL) {
  517. if (default_template_src.find(jinja_variable_name) != std::string::npos
  518. || template_tool_use_src.find(jinja_variable_name) != std::string::npos) {
  519. LOG_WRN("common_chat_templates_init: warning: vocab does not have a %s token, jinja template won't work as intended.\n", name);
  520. }
  521. return std::string();
  522. }
  523. return common_token_to_piece(vocab, token, true);
  524. };
  525. token_bos = get_token(llama_vocab_bos(vocab), "BOS", "bos_token");
  526. token_eos = get_token(llama_vocab_eos(vocab), "EOS", "eos_token");
  527. add_bos = llama_vocab_get_add_bos(vocab);
  528. add_eos = llama_vocab_get_add_eos(vocab);
  529. }
  530. common_chat_templates_ptr tmpls(new common_chat_templates());
  531. tmpls->has_explicit_template = has_explicit_template;
  532. tmpls->add_bos = add_bos;
  533. tmpls->add_eos = add_eos;
  534. try {
  535. tmpls->template_default = std::make_unique<minja::chat_template>(default_template_src, token_bos, token_eos);
  536. } catch (const std::exception & e) {
  537. LOG_ERR("%s: failed to parse chat template (defaulting to chatml): %s \n", __func__, e.what());
  538. tmpls->template_default = std::make_unique<minja::chat_template>(CHATML_TEMPLATE_SRC, token_bos, token_eos);
  539. }
  540. if (!template_tool_use_src.empty()) {
  541. try {
  542. tmpls->template_tool_use = std::make_unique<minja::chat_template>(template_tool_use_src, token_bos, token_eos);
  543. } catch (const std::exception & e) {
  544. LOG_ERR("%s: failed to parse tool use chat template (ignoring it): %s\n", __func__, e.what());
  545. }
  546. }
  547. return tmpls;
  548. }
  549. const char * common_chat_format_name(common_chat_format format) {
  550. switch (format) {
  551. case COMMON_CHAT_FORMAT_CONTENT_ONLY: return "Content-only";
  552. case COMMON_CHAT_FORMAT_GENERIC: return "Generic";
  553. case COMMON_CHAT_FORMAT_MISTRAL_NEMO: return "Mistral Nemo";
  554. case COMMON_CHAT_FORMAT_LLAMA_3_X: return "Llama 3.x";
  555. case COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS: return "Llama 3.x with builtin tools";
  556. case COMMON_CHAT_FORMAT_DEEPSEEK_R1: return "DeepSeek R1";
  557. case COMMON_CHAT_FORMAT_FIREFUNCTION_V2: return "FireFunction v2";
  558. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2: return "Functionary v3.2";
  559. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1: return "Functionary v3.1 Llama 3.1";
  560. case COMMON_CHAT_FORMAT_HERMES_2_PRO: return "Hermes 2 Pro";
  561. case COMMON_CHAT_FORMAT_COMMAND_R7B: return "Command R7B";
  562. case COMMON_CHAT_FORMAT_GPT_OSS: return "GPT-OSS";
  563. default:
  564. throw std::runtime_error("Unknown chat format");
  565. }
  566. }
  567. const char * common_reasoning_format_name(common_reasoning_format format) {
  568. switch (format) {
  569. case COMMON_REASONING_FORMAT_NONE: return "none";
  570. case COMMON_REASONING_FORMAT_AUTO: return "auto";
  571. case COMMON_REASONING_FORMAT_DEEPSEEK: return "deepseek";
  572. case COMMON_REASONING_FORMAT_DEEPSEEK_LEGACY: return "deepseek-legacy";
  573. default:
  574. throw std::runtime_error("Unknown reasoning format");
  575. }
  576. }
  577. static std::string wrap_code_as_arguments(common_chat_msg_parser & builder, const std::string & code) {
  578. std::string arguments;
  579. if (builder.is_partial()) {
  580. arguments = (json {{"code", code + builder.healing_marker()}}).dump();
  581. auto idx = arguments.find(builder.healing_marker());
  582. if (idx != std::string::npos) {
  583. arguments.resize(idx);
  584. }
  585. } else {
  586. arguments = (json {{"code", code}}).dump();
  587. }
  588. return arguments;
  589. }
  590. /**
  591. * Takes a prefix regex that must have 1 group to capture the function name, a closing suffix, and expects json parameters in between.
  592. * Aggregates the prefix, suffix and in-between text into the content.
  593. */
  594. static void parse_json_tool_calls(
  595. common_chat_msg_parser & builder,
  596. const std::optional<common_regex> & block_open,
  597. const std::optional<common_regex> & function_regex_start_only,
  598. const std::optional<common_regex> & function_regex,
  599. const common_regex & close_regex,
  600. const std::optional<common_regex> & block_close,
  601. bool allow_raw_python = false,
  602. const std::function<std::string(const common_chat_msg_parser::find_regex_result & fres)> & get_function_name = nullptr) {
  603. auto parse_tool_calls = [&]() {
  604. size_t from = std::string::npos;
  605. auto first = true;
  606. while (true) {
  607. auto res = function_regex_start_only && first
  608. ? builder.try_consume_regex(*function_regex_start_only)
  609. : function_regex
  610. ? builder.try_find_regex(*function_regex, from)
  611. : std::nullopt;
  612. if (res) {
  613. std::string name;
  614. if (get_function_name) {
  615. name = get_function_name(*res);
  616. } else {
  617. GGML_ASSERT(res->groups.size() == 2);
  618. name = builder.str(res->groups[1]);
  619. }
  620. first = false;
  621. if (name.empty()) {
  622. // get_function_name signalled us that we should skip this match and treat it as content.
  623. from = res->groups[0].begin + 1;
  624. continue;
  625. }
  626. from = std::string::npos;
  627. auto maybe_raw_python = name == "python" && allow_raw_python;
  628. if (builder.input()[builder.pos()] == '{' || !maybe_raw_python) {
  629. if (auto arguments = builder.try_consume_json_with_dumped_args({{}})) {
  630. if (!builder.add_tool_call(name, "", arguments->value) || arguments->is_partial) {
  631. throw common_chat_msg_partial_exception("incomplete tool call");
  632. }
  633. builder.consume_regex(close_regex);
  634. }
  635. continue;
  636. }
  637. if (maybe_raw_python) {
  638. auto arguments = wrap_code_as_arguments(builder, builder.consume_rest());
  639. if (!builder.add_tool_call(name, "", arguments)) {
  640. throw common_chat_msg_partial_exception("incomplete tool call");
  641. }
  642. return;
  643. }
  644. throw common_chat_msg_partial_exception("incomplete tool call");
  645. }
  646. break;
  647. }
  648. if (block_close) {
  649. builder.consume_regex(*block_close);
  650. }
  651. builder.consume_spaces();
  652. builder.add_content(builder.consume_rest());
  653. };
  654. if (block_open) {
  655. if (auto res = builder.try_find_regex(*block_open)) {
  656. parse_tool_calls();
  657. } else {
  658. builder.add_content(builder.consume_rest());
  659. }
  660. } else {
  661. parse_tool_calls();
  662. }
  663. }
  664. static void parse_prefixed_json_tool_call_array(common_chat_msg_parser & builder, const common_regex & prefix, size_t rstrip_prefix = 0) {
  665. static const std::vector<std::vector<std::string>> args_paths = {{"arguments"}};
  666. if (auto res = builder.try_find_regex(prefix)) {
  667. builder.move_back(rstrip_prefix);
  668. auto tool_calls = builder.consume_json_with_dumped_args(args_paths);
  669. if (!builder.add_tool_calls(tool_calls.value) || tool_calls.is_partial) {
  670. throw common_chat_msg_partial_exception("incomplete tool call array");
  671. }
  672. } else {
  673. builder.add_content(builder.consume_rest());
  674. }
  675. }
  676. static void foreach_function(const json & tools, const std::function<void(const json &)> & fn) {
  677. for (const auto & tool : tools) {
  678. if (!tool.contains("type") || tool.at("type") != "function" || !tool.contains("function")) {
  679. LOG_INF("Skipping tool without function: %s", tool.dump(2).c_str());
  680. continue;
  681. }
  682. fn(tool);
  683. }
  684. }
  685. static std::string apply(
  686. const common_chat_template & tmpl,
  687. const struct templates_params & inputs,
  688. const std::optional<json> & messages_override = std::nullopt,
  689. const std::optional<json> & tools_override = std::nullopt,
  690. const std::optional<json> & additional_context = std::nullopt)
  691. {
  692. minja::chat_template_inputs tmpl_inputs;
  693. tmpl_inputs.messages = messages_override ? *messages_override : inputs.messages;
  694. if (tools_override) {
  695. tmpl_inputs.tools = *tools_override;
  696. } else {
  697. tmpl_inputs.tools = inputs.tools.empty() ? json() : inputs.tools;
  698. }
  699. tmpl_inputs.add_generation_prompt = inputs.add_generation_prompt;
  700. tmpl_inputs.extra_context = inputs.extra_context;
  701. if (additional_context) {
  702. tmpl_inputs.extra_context.merge_patch(*additional_context);
  703. }
  704. // TODO: add flag to control date/time, if only for testing purposes.
  705. // tmpl_inputs.now = std::chrono::system_clock::now();
  706. minja::chat_template_options tmpl_opts;
  707. // To avoid double BOS / EOS tokens, we're manually removing begining / trailing tokens
  708. // instead of using `chat_template_options.use_bos_token = false`, since these tokens
  709. // may be needed inside the template / between messages too.
  710. auto result = tmpl.apply(tmpl_inputs, tmpl_opts);
  711. if (inputs.add_bos && string_starts_with(result, tmpl.bos_token())) {
  712. result = result.substr(tmpl.bos_token().size());
  713. }
  714. if (inputs.add_eos && string_ends_with(result, tmpl.eos_token())) {
  715. result = result.substr(0, result.size() - tmpl.eos_token().size());
  716. }
  717. return result;
  718. }
  719. static common_chat_params common_chat_params_init_generic(const common_chat_template & tmpl, const struct templates_params & inputs) {
  720. common_chat_params data;
  721. auto tool_call_schemas = json::array();
  722. foreach_function(inputs.tools, [&](const json & tool) {
  723. const auto & function = tool.at("function");
  724. auto tool_schema = json {
  725. {"type", "object"},
  726. {"properties", {
  727. {"name", {
  728. {"type", "string"},
  729. {"const", function.at("name")},
  730. }},
  731. {"arguments", function.at("parameters")},
  732. }},
  733. {"required", json::array({"name", "arguments"})},
  734. };
  735. if (function.contains("description")) {
  736. tool_schema["description"] = function.at("description");
  737. }
  738. if (inputs.parallel_tool_calls) {
  739. tool_schema.at("properties")["id"] = {
  740. {"type", "string"},
  741. {"minLength", 4},
  742. };
  743. tool_schema.at("required").push_back("id");
  744. }
  745. tool_call_schemas.emplace_back(tool_schema);
  746. });
  747. const auto tool_call =
  748. inputs.parallel_tool_calls
  749. ? json {
  750. {"type", "object"},
  751. {"properties", {
  752. {"tool_calls", {
  753. {"type", "array"},
  754. {"items", tool_call_schemas.size() == 1 ? tool_call_schemas[0] : json {
  755. {"anyOf", tool_call_schemas},
  756. }},
  757. {"minItems", 1},
  758. }},
  759. }},
  760. {"required", json::array({"tool_calls"})},
  761. }
  762. : json {
  763. {"type", "object"},
  764. {"properties", {
  765. {"tool_call", tool_call_schemas.size() == 1 ? tool_call_schemas[0] : json {
  766. {"anyOf", tool_call_schemas},
  767. }},
  768. }},
  769. {"required", json::array({"tool_call"})},
  770. };
  771. const auto schema =
  772. inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED
  773. ? json {
  774. {"anyOf", json::array({
  775. tool_call,
  776. {
  777. {"type", "object"},
  778. {"properties", {
  779. {"response", inputs.json_schema.is_null()
  780. ? json {{"type", "string"}}
  781. : inputs.json_schema
  782. },
  783. }},
  784. {"required", json::array({"response"})},
  785. },
  786. })}
  787. }
  788. : tool_call;
  789. data.grammar_lazy = false;
  790. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  791. builder.add_schema("root", schema);
  792. });
  793. auto tweaked_messages = common_chat_template::add_system(
  794. inputs.messages,
  795. "Respond in JSON format, either with `tool_call` (a request to call tools) or with `response` reply to the user's request");
  796. data.prompt = apply(tmpl, inputs, /* messages_override= */ tweaked_messages);
  797. data.format = COMMON_CHAT_FORMAT_GENERIC;
  798. return data;
  799. }
  800. static void common_chat_parse_generic(common_chat_msg_parser & builder) {
  801. if (!builder.syntax().parse_tool_calls) {
  802. builder.add_content(builder.consume_rest());
  803. return;
  804. }
  805. static const std::vector<std::vector<std::string>> content_paths = {
  806. {"response"},
  807. };
  808. static const std::vector<std::vector<std::string>> args_paths = {
  809. {"tool_call", "arguments"},
  810. {"tool_calls", "arguments"},
  811. };
  812. auto data = builder.consume_json_with_dumped_args(args_paths, content_paths);
  813. if (data.value.contains("tool_calls")) {
  814. if (!builder.add_tool_calls(data.value.at("tool_calls")) || data.is_partial) {
  815. throw common_chat_msg_partial_exception("incomplete tool calls");
  816. }
  817. } else if (data.value.contains("tool_call")) {
  818. if (!builder.add_tool_call(data.value.at("tool_call")) || data.is_partial) {
  819. throw common_chat_msg_partial_exception("incomplete tool call");
  820. }
  821. } else if (data.value.contains("response")) {
  822. const auto & response = data.value.at("response");
  823. builder.add_content(response.is_string() ? response.template get<std::string>() : response.dump(2));
  824. if (data.is_partial) {
  825. throw common_chat_msg_partial_exception("incomplete response");
  826. }
  827. } else {
  828. throw common_chat_msg_partial_exception("Expected 'tool_call', 'tool_calls' or 'response' in JSON");
  829. }
  830. }
  831. static common_chat_params common_chat_params_init_mistral_nemo(const common_chat_template & tmpl, const struct templates_params & inputs) {
  832. common_chat_params data;
  833. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  834. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  835. auto schemas = json::array();
  836. foreach_function(inputs.tools, [&](const json & tool) {
  837. const auto & function = tool.at("function");
  838. schemas.push_back({
  839. {"type", "object"},
  840. {"properties", {
  841. // Important note: the model is probably trained to take a JSON stringified arguments value.
  842. // It's hard to constrain that for now (while reusing the JSON schema conversion), so we're just expecting a plain object.
  843. {"name", {
  844. {"type", "string"},
  845. {"const", function.at("name")},
  846. }},
  847. {"arguments", function.at("parameters")},
  848. {"id", {
  849. {"type", "string"},
  850. // Nemo's template expects a 9-character alphanumeric ID.
  851. {"pattern", "^[a-zA-Z0-9]{9}$"},
  852. }},
  853. }},
  854. {"required", json::array({"name", "arguments", "id"})},
  855. });
  856. });
  857. auto schema = json {
  858. {"type", "array"},
  859. {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}},
  860. {"minItems", 1},
  861. };
  862. if (!inputs.parallel_tool_calls) {
  863. schema["maxItems"] = 1;
  864. }
  865. builder.add_rule("root", "\"[TOOL_CALLS]\" " + builder.add_schema("tool_calls", schema));
  866. });
  867. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "[TOOL_CALLS]"});
  868. data.preserved_tokens = {
  869. "[TOOL_CALLS]",
  870. };
  871. data.prompt = apply(tmpl, inputs);
  872. data.format = COMMON_CHAT_FORMAT_MISTRAL_NEMO;
  873. return data;
  874. }
  875. static void common_chat_parse_mistral_nemo(common_chat_msg_parser & builder) {
  876. if (!builder.syntax().parse_tool_calls) {
  877. builder.add_content(builder.consume_rest());
  878. return;
  879. }
  880. static const common_regex prefix(regex_escape("[TOOL_CALLS]"));
  881. parse_prefixed_json_tool_call_array(builder, prefix);
  882. }
  883. static common_chat_params common_chat_params_init_command_r7b(const common_chat_template & tmpl, const struct templates_params & inputs) {
  884. common_chat_params data;
  885. auto adjusted_messages = json::array();
  886. for (const auto & msg : inputs.messages) {
  887. auto has_reasoning_content = msg.contains("reasoning_content") && msg.at("reasoning_content").is_string();
  888. auto has_tool_calls = msg.contains("tool_calls") && msg.at("tool_calls").is_array();
  889. if (has_reasoning_content && has_tool_calls) {
  890. auto adjusted_message = msg;
  891. adjusted_message["tool_plan"] = msg.at("reasoning_content");
  892. adjusted_message.erase("reasoning_content");
  893. adjusted_messages.push_back(adjusted_message);
  894. } else {
  895. adjusted_messages.push_back(msg);
  896. }
  897. }
  898. data.prompt = apply(tmpl, inputs, /* messages_override= */ adjusted_messages);
  899. data.format = COMMON_CHAT_FORMAT_COMMAND_R7B;
  900. if (string_ends_with(data.prompt, "<|START_THINKING|>")) {
  901. if (!inputs.enable_thinking) {
  902. data.prompt += "<|END_THINKING|>";
  903. } else {
  904. data.thinking_forced_open = true;
  905. }
  906. } else if (!inputs.enable_thinking && string_ends_with(data.prompt, "<|CHATBOT_TOKEN|>")) {
  907. data.prompt += "<|START_THINKING|><|END_THINKING|>";
  908. }
  909. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  910. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  911. auto schemas = json::array();
  912. foreach_function(inputs.tools, [&](const json & tool) {
  913. const auto & function = tool.at("function");
  914. schemas.push_back({
  915. {"type", "object"},
  916. {"properties", {
  917. {"tool_call_id", {
  918. {"type", "string"},
  919. // Command-R's template expects an integer string.
  920. {"pattern", "^[0-9]{1,10}$"},
  921. }},
  922. {"tool_name", {
  923. {"type", "string"},
  924. {"const", function.at("name")},
  925. }},
  926. {"parameters", function.at("parameters")},
  927. }},
  928. {"required", json::array({"tool_call_id", "tool_name", "parameters"})},
  929. });
  930. });
  931. auto schema = json {
  932. {"type", "array"},
  933. {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}},
  934. {"minItems", 1},
  935. };
  936. if (!inputs.parallel_tool_calls) {
  937. schema["maxItems"] = 1;
  938. }
  939. builder.add_rule("root",
  940. std::string(data.thinking_forced_open ? "( \"<|END_THINKING|>\" space )? " : "") +
  941. "\"<|START_ACTION|>\" " + builder.add_schema("tool_calls", schema) + " \"<|END_ACTION|>\"");
  942. });
  943. data.grammar_triggers.push_back({
  944. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  945. // If thinking_forced_open, then we capture the </think> tag in the grammar,
  946. // (important for required tool choice) and in the trigger's first capture (decides what is sent to the grammar)
  947. std::string(data.thinking_forced_open ? "[\\s\\S]*?(<\\|END_THINKING\\|>\\s*)" : "(?:<\\|START_THINKING\\|>[\\s\\S]*?<\\|END_THINKING\\|>\\s*)?") +
  948. "(<\\|START_ACTION\\|>)[\\s\\S]*"
  949. });
  950. data.preserved_tokens = {
  951. "<|START_ACTION|>",
  952. "<|END_ACTION|>",
  953. "<|START_RESPONSE|>",
  954. "<|END_RESPONSE|>",
  955. "<|START_THINKING|>",
  956. "<|END_THINKING|>",
  957. };
  958. return data;
  959. }
  960. static void common_chat_parse_command_r7b(common_chat_msg_parser & builder) {
  961. builder.try_parse_reasoning("<|START_THINKING|>", "<|END_THINKING|>");
  962. static const common_regex start_action_regex("<\\|START_ACTION\\|>");
  963. static const common_regex end_action_regex("<\\|END_ACTION\\|>");
  964. static const common_regex start_response_regex("<\\|START_RESPONSE\\|>");
  965. static const common_regex end_response_regex("<\\|END_RESPONSE\\|>");
  966. if (auto res = builder.try_find_regex(start_action_regex)) {
  967. // If we didn't extract thoughts, prelude includes them.
  968. auto tool_calls = builder.consume_json_with_dumped_args({{"parameters"}});
  969. for (const auto & tool_call : tool_calls.value) {
  970. std::string name = tool_call.contains("tool_name") ? tool_call.at("tool_name") : "";
  971. std::string id = tool_call.contains("tool_call_id") ? tool_call.at("tool_call_id") : "";
  972. std::string arguments = tool_call.contains("parameters") ? tool_call.at("parameters") : "";
  973. if (!builder.add_tool_call(name, id, arguments) || tool_calls.is_partial) {
  974. throw common_chat_msg_partial_exception("incomplete tool call");
  975. }
  976. }
  977. if (tool_calls.is_partial) {
  978. throw common_chat_msg_partial_exception("incomplete tool call");
  979. }
  980. builder.consume_regex(end_action_regex);
  981. } else if (auto res = builder.try_find_regex(start_response_regex)) {
  982. if (!builder.try_find_regex(end_response_regex)) {
  983. builder.add_content(builder.consume_rest());
  984. throw common_chat_msg_partial_exception(end_response_regex.str());
  985. }
  986. } else {
  987. builder.add_content(builder.consume_rest());
  988. }
  989. }
  990. static void expect_tool_parameters(const std::string & name, const json & parameters, const std::vector<std::string> & expected_properties) {
  991. if (!parameters.is_object() || !parameters.contains("type") || parameters.at("type") != "object" || !parameters.contains("properties") || !parameters.contains("required")) {
  992. throw std::runtime_error("Parameters of tool " + name + " must be an object w/ required properties");
  993. }
  994. const auto & parameters_properties = parameters.at("properties");
  995. const auto & parameters_required = parameters.at("required");
  996. for (const auto & prop : expected_properties) {
  997. if (!parameters_properties.contains(prop)) {
  998. throw std::runtime_error("Parameters of tool " + name + " is missing property: " + prop); // NOLINT
  999. }
  1000. if (std::find(parameters_required.begin(), parameters_required.end(), json(prop)) == parameters_required.end()) {
  1001. throw std::runtime_error("Parameters of tool " + name + " must have property marked as required: " + prop); // NOLINT
  1002. }
  1003. }
  1004. if (parameters_properties.size() != expected_properties.size()) {
  1005. throw std::runtime_error("Parameters of tool " + name + " must only have these properties:" + string_join(expected_properties, ", "));
  1006. }
  1007. }
  1008. 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) {
  1009. auto builtin_tools = json::array();
  1010. common_chat_params data;
  1011. if (!inputs.tools.is_null()) {
  1012. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1013. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1014. std::vector<std::string> tool_rules;
  1015. auto handle_builtin_tool = [&](const std::string & name, const json & parameters) {
  1016. if (name == "wolfram_alpha" || name == "web_search" || name == "brave_search") {
  1017. // https://github.com/meta-llama/llama-stack/blob/main/llama_stack/providers/remote/tool_runtime/wolfram_alpha/wolfram_alpha.py
  1018. // https://github.com/meta-llama/llama-stack/blob/main/llama_stack/providers/remote/tool_runtime/brave_search/brave_search.py
  1019. expect_tool_parameters(name, parameters, {"query"});
  1020. } else if (name == "python" || name == "code_interpreter") {
  1021. // https://github.com/meta-llama/llama-stack/blob/main/llama_stack/providers/inline/tool_runtime/code_interpreter/code_interpreter.py
  1022. expect_tool_parameters(name, parameters, {"code"});
  1023. } else {
  1024. return false;
  1025. }
  1026. std::vector<std::string> kvs;
  1027. for (const auto & [key, value] : parameters.at("properties").items()) {
  1028. kvs.push_back("\"" + key + "=\" " + builder.add_schema(name + "-args-" + key, value)); // NOLINT
  1029. }
  1030. tool_rules.push_back(
  1031. builder.add_rule(
  1032. name + "-call",
  1033. "\"<|python_tag|>" + name + ".call(\" " + string_join(kvs, " \", \" ") + " \")\""));
  1034. builtin_tools.push_back(name);
  1035. return true;
  1036. };
  1037. foreach_function(inputs.tools, [&](const json & tool) {
  1038. const auto & function = tool.at("function");
  1039. std::string name = function.at("name");
  1040. auto parameters = function.at("parameters");
  1041. builder.resolve_refs(parameters);
  1042. // https://github.com/meta-llama/llama-stack/tree/main/llama_stack/providers/remote/tool_runtime
  1043. if (allow_python_tag_builtin_tools) {
  1044. handle_builtin_tool(name, parameters);
  1045. }
  1046. tool_rules.push_back(
  1047. builder.add_rule(
  1048. name + "-call",
  1049. "\"{\" space "
  1050. "( \"\\\"type\\\"\" space \":\" space \"\\\"function\\\"\" space \",\" space )? "
  1051. " \"\\\"name\\\"\" space \":\" space \"\\\"" + name + "\\\"\" space \",\" space "
  1052. " \"\\\"parameters\\\"\" space \":\" space " + builder.add_schema(name + "-args", parameters) + " "
  1053. "\"}\" space"));
  1054. });
  1055. // 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.
  1056. data.grammar_triggers.push_back({
  1057. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1058. "(\\{\\s*(?:\"type\"\\s*:\\s*\"function\"\\s*,\\s*)?\"name\"\\s*:\\s*\")[\\s\\S]*", // + name + "\"[\\s\\S]*",
  1059. });
  1060. if (!builtin_tools.empty()) {
  1061. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<|python_tag|>"});
  1062. data.preserved_tokens.push_back("<|python_tag|>");
  1063. }
  1064. // Allow a few empty lines on top of the usual constrained json schema space rule.
  1065. builder.add_rule("root", string_join(tool_rules, " | "));
  1066. data.additional_stops.push_back("<|eom_id|>");
  1067. });
  1068. data.format = allow_python_tag_builtin_tools && !builtin_tools.empty()
  1069. ? COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS
  1070. : COMMON_CHAT_FORMAT_LLAMA_3_X;
  1071. } else {
  1072. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1073. }
  1074. data.prompt = apply(tmpl, inputs, /* messages_override =*/ std::nullopt, /* tools_override= */ std::nullopt, json {
  1075. {"date_string", format_time(inputs.now, "%d %b %Y")},
  1076. {"tools_in_user_message", false},
  1077. {"builtin_tools", builtin_tools.empty() ? json() : builtin_tools},
  1078. });
  1079. return data;
  1080. }
  1081. static void common_chat_parse_llama_3_1(common_chat_msg_parser & builder, bool with_builtin_tools = false) {
  1082. if (!builder.syntax().parse_tool_calls) {
  1083. builder.add_content(builder.consume_rest());
  1084. return;
  1085. }
  1086. static const common_regex function_regex(
  1087. "\\s*\\{\\s*(?:\"type\"\\s*:\\s*\"function\"\\s*,\\s*)?\"name\"\\s*:\\s*\"([^\"]+)\"\\s*,\\s*\"parameters\"\\s*: ");
  1088. static const common_regex close_regex("\\}\\s*");
  1089. static const common_regex function_name_regex("\\s*(\\w+)\\s*\\.\\s*call\\(");
  1090. static const common_regex arg_name_regex("\\s*(\\w+)\\s*=\\s*");
  1091. if (with_builtin_tools) {
  1092. static const common_regex builtin_call_regex("<\\|python_tag\\|>");
  1093. if (auto res = builder.try_find_regex(builtin_call_regex)) {
  1094. auto fun_res = builder.consume_regex(function_name_regex);
  1095. auto function_name = builder.str(fun_res.groups[1]);
  1096. common_healing_marker healing_marker;
  1097. json args = json::object();
  1098. while (true) {
  1099. if (auto arg_res = builder.try_consume_regex(arg_name_regex)) {
  1100. auto arg_name = builder.str(arg_res->groups[1]);
  1101. auto partial = builder.consume_json();
  1102. args[arg_name] = partial.json;
  1103. healing_marker.marker = partial.healing_marker.marker;
  1104. healing_marker.json_dump_marker = partial.healing_marker.json_dump_marker;
  1105. builder.consume_spaces();
  1106. if (!builder.try_consume_literal(",")) {
  1107. break;
  1108. }
  1109. } else {
  1110. break;
  1111. }
  1112. }
  1113. builder.consume_literal(")");
  1114. builder.consume_spaces();
  1115. auto arguments = args.dump();
  1116. if (!builder.add_tool_call(function_name, "", arguments)) {
  1117. throw common_chat_msg_partial_exception("Incomplete tool call");
  1118. }
  1119. return;
  1120. }
  1121. }
  1122. parse_json_tool_calls(
  1123. builder,
  1124. /* block_open= */ std::nullopt,
  1125. /* function_regex_start_only= */ function_regex,
  1126. /* function_regex= */ std::nullopt,
  1127. close_regex,
  1128. std::nullopt);
  1129. }
  1130. static common_chat_params common_chat_params_init_deepseek_r1(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1131. common_chat_params data;
  1132. auto prompt = apply(tmpl, inputs);
  1133. // Hacks to fix the official (broken) prompt.
  1134. // It is advisable to use --chat-template-file models/templates/llama-cpp-deepseek-r1.jinja instead,
  1135. // until the official template is fixed.
  1136. if (tmpl.source().find("{% if ns.is_tool %}{{'<|tool▁outputs▁end|>'}}") != std::string::npos) {
  1137. // Don't leave the chat dangling after tool results
  1138. if (string_ends_with(prompt, "<|tool▁outputs▁end|>")) {
  1139. prompt += "<|end▁of▁sentence|>";
  1140. if (inputs.add_generation_prompt) {
  1141. prompt += "<|Assistant|>";
  1142. }
  1143. }
  1144. // Fix up tool call delta example added by Minja
  1145. prompt = std::regex_replace(
  1146. prompt,
  1147. std::regex("(<|tool▁call▁end|>)[\\s\\r\\n]*(<|tool▁outputs▁begin|>|<|User|>)"),
  1148. "$1<|tool▁calls▁end|><|end▁of▁sentence|>$2");
  1149. }
  1150. data.prompt = prompt;
  1151. data.format = COMMON_CHAT_FORMAT_DEEPSEEK_R1;
  1152. if (string_ends_with(data.prompt, "<think>\n")) {
  1153. if (!inputs.enable_thinking) {
  1154. data.prompt += "</think>";
  1155. } else {
  1156. data.thinking_forced_open = true;
  1157. }
  1158. }
  1159. if (inputs.tools.is_array() && !inputs.tools.empty()) {
  1160. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED && inputs.json_schema.is_null();
  1161. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1162. std::vector<std::string> tool_rules;
  1163. foreach_function(inputs.tools, [&](const json & tool) {
  1164. const auto & function = tool.at("function");
  1165. std::string name = function.at("name");
  1166. auto parameters = function.at("parameters");
  1167. builder.resolve_refs(parameters);
  1168. tool_rules.push_back(builder.add_rule(name + "-call",
  1169. "( \"<|tool▁call▁begin|>\" )? \"function<|tool▁sep|>" + name + "\\n"
  1170. "```json\\n\" " + builder.add_schema(name + "-args", parameters) + " "
  1171. "\"```<|tool▁call▁end|>\""));
  1172. });
  1173. // Distill Qwen 7B & 32B models seem confused re/ syntax of their tool call opening tag,
  1174. // so we accept common variants (then it's all constrained)
  1175. builder.add_rule("root",
  1176. std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") +
  1177. "( \"<|tool▁calls▁begin|>\" | \"<|tool_calls_begin|>\" | \"<|tool calls begin|>\" | \"<|tool\\\\_calls\\\\_begin|>\" | \"<|tool▁calls|>\" ) "
  1178. "(" + string_join(tool_rules, " | ") + ")" + (inputs.parallel_tool_calls ? "*" : "") + " "
  1179. "\"<|tool▁calls▁end|>\""
  1180. " space");
  1181. data.grammar_triggers.push_back({
  1182. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1183. // If thinking_forced_open, then we capture the </think> tag in the grammar,
  1184. // (important for required tool choice) and in the trigger's first capture (decides what is sent to the grammar)
  1185. std::string(data.thinking_forced_open ? "[\\s\\S]*?(</think>\\s*)" : "(?:<think>[\\s\\S]*?</think>\\s*)?") +
  1186. "(<|tool▁calls▁begin|>|<|tool_calls_begin|>|<|tool calls begin|>|<|tool\\\\_calls\\\\_begin|>|<|tool▁calls|>)[\\s\\S]*"
  1187. });
  1188. data.preserved_tokens = {
  1189. "<think>",
  1190. "</think>",
  1191. "<|tool▁calls▁begin|>",
  1192. "<|tool▁call▁begin|>",
  1193. "<|tool▁sep|>",
  1194. "<|tool▁call▁end|>",
  1195. "<|tool▁calls▁end|",
  1196. };
  1197. });
  1198. }
  1199. return data;
  1200. }
  1201. static void common_chat_parse_deepseek_r1(common_chat_msg_parser & builder) {
  1202. builder.try_parse_reasoning("<think>", "</think>");
  1203. if (!builder.syntax().parse_tool_calls) {
  1204. builder.add_content(builder.consume_rest());
  1205. return;
  1206. }
  1207. static const common_regex tool_calls_begin("(?:<|tool▁calls▁begin|>|<|tool_calls_begin|>|<|tool calls begin|>|<|tool\\\\_calls\\\\_begin|>|<|tool▁calls|>)");
  1208. static const common_regex tool_calls_end("<|tool▁calls▁end|>");
  1209. static const common_regex function_regex("(?:<|tool▁call▁begin|>)?function<|tool▁sep|>([^\n]+)\n```json\n");
  1210. static const common_regex close_regex("```[\\s\\r\\n]*<|tool▁call▁end|>");
  1211. parse_json_tool_calls(
  1212. builder,
  1213. /* block_open= */ tool_calls_begin,
  1214. /* function_regex_start_only= */ std::nullopt,
  1215. function_regex,
  1216. close_regex,
  1217. tool_calls_end);
  1218. }
  1219. static common_chat_params common_chat_params_init_gpt_oss(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1220. common_chat_params data;
  1221. auto prompt = apply(tmpl, inputs);
  1222. data.prompt = prompt;
  1223. data.format = COMMON_CHAT_FORMAT_GPT_OSS;
  1224. // TODO: support tool calls in GPT-OSS?
  1225. return data;
  1226. }
  1227. static void common_chat_parse_gpt_oss(common_chat_msg_parser & builder) {
  1228. // TODO @ngxson : this won't work with --special enabled, we should fix that
  1229. builder.try_parse_reasoning("<|channel|>analysis<|message|>", "<|start|>assistant<|channel|>final<|message|>");
  1230. if (!builder.syntax().parse_tool_calls) {
  1231. builder.add_content(builder.consume_rest());
  1232. return;
  1233. }
  1234. }
  1235. static common_chat_params common_chat_params_init_firefunction_v2(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1236. LOG_DBG("%s\n", __func__);
  1237. common_chat_params data;
  1238. data.prompt = apply(tmpl, inputs, /* messages_override =*/ std::nullopt, /* tools_override= */ json(), json {
  1239. {"datetime", format_time(inputs.now, "%b %d %Y %H:%M:%S GMT")},
  1240. {"functions", json(inputs.tools.empty() ? "" : inputs.tools.dump(2))},
  1241. });
  1242. if (inputs.tools.is_array() && !inputs.tools.empty()) {
  1243. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1244. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1245. auto schemas = json::array();
  1246. foreach_function(inputs.tools, [&](const json & tool) {
  1247. const auto & function = tool.at("function");
  1248. schemas.push_back({
  1249. {"type", "object"},
  1250. {"properties", {
  1251. {"name", {
  1252. {"type", "string"},
  1253. {"const", function.at("name")},
  1254. }},
  1255. {"arguments", function.at("parameters")},
  1256. }},
  1257. {"required", json::array({"name", "arguments", "id"})},
  1258. });
  1259. });
  1260. auto schema = json {
  1261. {"type", "array"},
  1262. {"items", schemas.size() == 1 ? schemas[0] : json {{"anyOf", schemas}}},
  1263. {"minItems", 1},
  1264. };
  1265. if (!inputs.parallel_tool_calls) {
  1266. schema["maxItems"] = 1;
  1267. }
  1268. builder.add_rule("root", "\" functools\"? " + builder.add_schema("tool_calls", schema));
  1269. });
  1270. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, " functools["});
  1271. data.preserved_tokens = {
  1272. " functools[",
  1273. };
  1274. data.format = COMMON_CHAT_FORMAT_FIREFUNCTION_V2;
  1275. } else {
  1276. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1277. }
  1278. return data;
  1279. }
  1280. static void common_chat_parse_firefunction_v2(common_chat_msg_parser & builder) {
  1281. if (!builder.syntax().parse_tool_calls) {
  1282. builder.add_content(builder.consume_rest());
  1283. return;
  1284. }
  1285. static const common_regex prefix(regex_escape(" functools["));
  1286. parse_prefixed_json_tool_call_array(builder, prefix, /* rstrip_prefix= */ 1);
  1287. }
  1288. static common_chat_params common_chat_params_init_functionary_v3_2(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1289. // >>>all\nlet's call functions>>>fn1\n{"arg1": 1...}\n>>>fn2\n{"arg1": 1...}...
  1290. // Using ">>>f1\n", ">>>f2\n"... as trigger words for the grammar
  1291. // 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.
  1292. common_chat_params data;
  1293. data.prompt = apply(tmpl, inputs);
  1294. data.format = COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2;
  1295. if (inputs.tools.is_array() && !inputs.tools.empty()) {
  1296. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1297. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1298. std::vector<std::string> first_tool_rules;
  1299. std::vector<std::string> subsequent_tool_rules;
  1300. foreach_function(inputs.tools, [&](const json & tool) {
  1301. const auto & function = tool.at("function");
  1302. std::string name = function.at("name");
  1303. auto parameters = function.at("parameters");
  1304. builder.resolve_refs(parameters);
  1305. std::string args_pattern = "[\\s\\S]*";
  1306. auto args_rule = builder.add_schema(name + "-args", parameters);
  1307. if (name == "python") {
  1308. args_rule = builder.add_rule(name + "-maybe-raw-args", args_rule + " | [^{] .*");
  1309. } else {
  1310. args_pattern = "\\{" + args_pattern;
  1311. }
  1312. auto call_rule = builder.add_rule(name + "-call", "\"" + name + "\\n\" " + args_rule);
  1313. first_tool_rules.push_back(call_rule);
  1314. if (inputs.parallel_tool_calls) {
  1315. subsequent_tool_rules.push_back(builder.add_rule(name + "-call2", "\">>>\" " + call_rule));
  1316. }
  1317. data.grammar_triggers.push_back({
  1318. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1319. "((?:[\\s\\S]+?>>>)?" + regex_escape(name) + "\n)" + args_pattern,
  1320. });
  1321. });
  1322. data.preserved_tokens = {
  1323. "<|end_header_id|>",
  1324. };
  1325. auto first_rule = first_tool_rules.empty() ? "" : builder.add_rule("first_tool_call", string_join(first_tool_rules, " | ")) + " space";
  1326. if (inputs.parallel_tool_calls) {
  1327. auto subsequent_rule = builder.add_rule("subsequent_tool_call", string_join(subsequent_tool_rules, " | ")) + " space";
  1328. builder.add_rule("root", first_rule + " (" + subsequent_rule + ")*");
  1329. } else {
  1330. builder.add_rule("root", first_rule);
  1331. }
  1332. });
  1333. }
  1334. return data;
  1335. }
  1336. static void common_chat_parse_functionary_v3_2(common_chat_msg_parser & builder) {
  1337. static const common_regex function_regex_start_only(R"((\w+\n\{|python\n|all\n))");
  1338. static const common_regex function_regex(R"(>>>(\w+\n\{|python\n|all\n))");
  1339. static const common_regex close_regex(R"(\s*)");
  1340. parse_json_tool_calls(
  1341. builder,
  1342. std::nullopt,
  1343. function_regex_start_only,
  1344. function_regex,
  1345. close_regex,
  1346. std::nullopt,
  1347. /* allow_raw_python= */ true,
  1348. /* get_function_name= */ [&](const auto & res) -> std::string {
  1349. auto at_start = res.groups[0].begin == 0;
  1350. auto name = builder.str(res.groups[1]);
  1351. if (!name.empty() && name.back() == '{') {
  1352. // Unconsume the opening brace '{' to ensure the JSON parsing goes well.
  1353. builder.move_back(1);
  1354. }
  1355. auto idx = name.find_last_not_of("\n{");
  1356. name = name.substr(0, idx + 1);
  1357. if (at_start && name == "all") {
  1358. return "";
  1359. }
  1360. return name;
  1361. });
  1362. }
  1363. static common_chat_params common_chat_params_init_functionary_v3_1_llama_3_1(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1364. // https://github.com/MeetKai/functionary/blob/main/tests/prompt_test_v3-llama3.1.txt
  1365. common_chat_params data;
  1366. if (!inputs.tools.is_null()) {
  1367. std::string python_code_argument_name;
  1368. auto has_raw_python = false;
  1369. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1370. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1371. std::vector<std::string> tool_rules;
  1372. foreach_function(inputs.tools, [&](const json & tool) {
  1373. const auto & function = tool.at("function");
  1374. const auto & parameters = function.at("parameters");
  1375. std::string name = function.at("name");
  1376. if (name == "python" || name == "ipython") {
  1377. if (!parameters.contains("type")) {
  1378. throw std::runtime_error("Missing type in python tool");
  1379. }
  1380. has_raw_python = true;
  1381. const auto & type = parameters.at("type");
  1382. if (type == "object") {
  1383. auto properties = parameters.at("properties");
  1384. for (auto it = properties.begin(); it != properties.end(); ++it) {
  1385. if (it.value().at("type") == "string") {
  1386. if (!python_code_argument_name.empty()) {
  1387. throw std::runtime_error("Multiple string arguments found in python tool");
  1388. }
  1389. python_code_argument_name = it.key();
  1390. }
  1391. }
  1392. if (python_code_argument_name.empty()) {
  1393. throw std::runtime_error("No string argument found in python tool");
  1394. }
  1395. } else if (type != "string") {
  1396. throw std::runtime_error("Invalid type in python tool: " + type.dump());
  1397. }
  1398. }
  1399. tool_rules.push_back(builder.add_rule(name + "-call", "\"<function=" + name + ">\" " + builder.add_schema(name + "-args", parameters) + " \"</function>\" space"));
  1400. });
  1401. if (has_raw_python) {
  1402. tool_rules.push_back(builder.add_rule("python-call", "\"<|python_tag|>\" .*"));
  1403. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<|python_tag|>"});
  1404. data.preserved_tokens.push_back("<|python_tag|>");
  1405. }
  1406. auto tool_call = builder.add_rule("tool_call", string_join(tool_rules, " | ")) + " space";
  1407. builder.add_rule("root", inputs.parallel_tool_calls ? "(" + tool_call + ")+" : tool_call);
  1408. data.grammar_triggers.push_back({COMMON_GRAMMAR_TRIGGER_TYPE_WORD, "<function="});
  1409. });
  1410. data.format = COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1;
  1411. } else {
  1412. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1413. }
  1414. data.prompt = apply(tmpl, inputs);
  1415. // TODO: if (has_raw_python)
  1416. return data;
  1417. }
  1418. static void common_chat_parse_functionary_v3_1_llama_3_1(common_chat_msg_parser & builder) {
  1419. if (!builder.syntax().parse_tool_calls) {
  1420. builder.add_content(builder.consume_rest());
  1421. return;
  1422. }
  1423. // This version of Functionary still supports the llama 3.1 tool call format for the python tool.
  1424. static const common_regex python_tag_regex(regex_escape("<|python_tag|>"));
  1425. static const common_regex function_regex(R"(<function=(\w+)>)");
  1426. static const common_regex close_regex(R"(</function>)");
  1427. parse_json_tool_calls(
  1428. builder,
  1429. /* block_open= */ std::nullopt,
  1430. /* function_regex_start_only= */ std::nullopt,
  1431. function_regex,
  1432. close_regex,
  1433. std::nullopt);
  1434. if (auto res = builder.try_find_regex(python_tag_regex)) {
  1435. auto arguments = wrap_code_as_arguments(builder, builder.consume_rest());
  1436. builder.add_tool_call("python", "", arguments);
  1437. return;
  1438. }
  1439. }
  1440. static common_chat_params common_chat_params_init_hermes_2_pro(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1441. common_chat_params data;
  1442. json extra_context = json {
  1443. {"enable_thinking", inputs.enable_thinking},
  1444. };
  1445. extra_context.update(inputs.extra_context);
  1446. data.prompt = apply(tmpl, inputs, /* messages_override =*/ std::nullopt, /* tools_override= */ std::nullopt, extra_context);
  1447. data.format = COMMON_CHAT_FORMAT_HERMES_2_PRO;
  1448. if (string_ends_with(data.prompt, "<think>\n")) {
  1449. if (!extra_context["enable_thinking"]) {
  1450. data.prompt += "</think>";
  1451. } else {
  1452. data.thinking_forced_open = true;
  1453. }
  1454. }
  1455. if (!inputs.tools.is_null()) {
  1456. // (content)?(<tool_call>{"name": "foo", "arguments": {"a": 1}}</tool_call>)*
  1457. data.grammar_lazy = inputs.tool_choice != COMMON_CHAT_TOOL_CHOICE_REQUIRED;
  1458. data.grammar = build_grammar([&](const common_grammar_builder & builder) {
  1459. std::vector<std::string> tool_rules;
  1460. std::vector<std::string> tool_call_alts;
  1461. std::vector<std::string> escaped_names;
  1462. foreach_function(inputs.tools, [&](const json & tool) {
  1463. const auto & function = tool.at("function");
  1464. std::string name = function.at("name");
  1465. auto parameters = function.at("parameters");
  1466. builder.resolve_refs(parameters);
  1467. tool_rules.push_back(builder.add_schema(name + "-call", {
  1468. {"type", "object"},
  1469. {"properties", json {
  1470. {"name", json {{"const", name}}},
  1471. {"arguments", parameters},
  1472. }},
  1473. {"required", json::array({"name", "arguments"})},
  1474. }));
  1475. tool_call_alts.push_back(builder.add_rule(
  1476. name + "-function-tag",
  1477. "\"<function\" ( \"=" + name + "\" | \" name=\\\"" + name + "\\\"\" ) \">\" space " +
  1478. builder.add_schema(name + "-args", parameters) + " "
  1479. "\"</function>\" space"));
  1480. data.grammar_triggers.push_back({
  1481. COMMON_GRAMMAR_TRIGGER_TYPE_WORD,
  1482. "<function=" + name + ">",
  1483. });
  1484. auto escaped_name = regex_escape(name);
  1485. data.grammar_triggers.push_back({
  1486. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN,
  1487. "<function\\s+name\\s*=\\s*\"" + escaped_name + "\"",
  1488. });
  1489. escaped_names.push_back(escaped_name);
  1490. });
  1491. auto any_tool_call = builder.add_rule("any_tool_call", "( " + string_join(tool_rules, " | ") + " ) space");
  1492. std::vector<std::string> alt_tags {
  1493. any_tool_call,
  1494. "\"<tool_call>\" space " + any_tool_call + " \"</tool_call>\"",
  1495. // The rest is just to accommodate common "good bad" outputs.
  1496. "\"<function_call>\" space " + any_tool_call + " \"</function_call>\"",
  1497. "\"<response>\" space " + any_tool_call + " \"</response>\"",
  1498. "\"<tools>\" space " + any_tool_call + " \"</tools>\"",
  1499. "\"<json>\" space " + any_tool_call + " \"</json>\"",
  1500. "\"<xml>\" space " + any_tool_call + " \"</xml>\"",
  1501. "\"<JSON>\" space " + any_tool_call + " \"</JSON>\"",
  1502. };
  1503. auto wrappable_tool_call = builder.add_rule("wrappable_tool_call", "( " + string_join(alt_tags, " | ") + " ) space");
  1504. tool_call_alts.push_back(wrappable_tool_call);
  1505. tool_call_alts.push_back(
  1506. "( \"```\\n\" | \"```json\\n\" | \"```xml\\n\" ) space " + wrappable_tool_call + " space \"```\" space ");
  1507. auto tool_call = builder.add_rule("tool_call", string_join(tool_call_alts, " | "));
  1508. builder.add_rule("root",
  1509. std::string(data.thinking_forced_open ? "( \"</think>\" space )? " : "") +
  1510. (inputs.parallel_tool_calls ? "(" + tool_call + ")+" : tool_call));
  1511. // 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)
  1512. data.grammar_triggers.push_back({
  1513. COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL,
  1514. // If thinking_forced_open, then we capture the </think> tag in the grammar,
  1515. // (important for required tool choice) and in the trigger's first capture (decides what is sent to the grammar)
  1516. std::string(data.thinking_forced_open ? "[\\s\\S]*?(</think>\\s*)" : "(?:<think>[\\s\\S]*?</think>\\s*)?") + (
  1517. "(\\s*"
  1518. "(?:<tool_call>"
  1519. "|<function"
  1520. "|(?:```(?:json|xml)?\n\\s*)?(?:<function_call>|<tools>|<xml><json>|<response>)?"
  1521. "\\s*\\{\\s*\"name\"\\s*:\\s*\"(?:" + string_join(escaped_names, "|") + ")\""
  1522. ")"
  1523. ")[\\s\\S]*"
  1524. ),
  1525. });
  1526. data.preserved_tokens = {
  1527. "<think>",
  1528. "</think>",
  1529. "<tool_call>",
  1530. "</tool_call>",
  1531. "<function",
  1532. "<tools>",
  1533. "</tools>",
  1534. "<response>",
  1535. "</response>",
  1536. "<function_call>",
  1537. "</function_call>",
  1538. "<json>",
  1539. "</json>",
  1540. "<JSON>",
  1541. "</JSON>",
  1542. "```",
  1543. "```json",
  1544. "```xml",
  1545. };
  1546. });
  1547. }
  1548. return data;
  1549. }
  1550. static void common_chat_parse_hermes_2_pro(common_chat_msg_parser & builder) {
  1551. builder.try_parse_reasoning("<think>", "</think>");
  1552. if (!builder.syntax().parse_tool_calls) {
  1553. builder.add_content(builder.consume_rest());
  1554. return;
  1555. }
  1556. static const common_regex open_regex(
  1557. "(?:"
  1558. "(```(?:xml|json)?\\n\\s*)?" // match 1 (block_start)
  1559. "(" // match 2 (open_tag)
  1560. "<tool_call>"
  1561. "|<function_call>"
  1562. "|<tool>"
  1563. "|<tools>"
  1564. "|<response>"
  1565. "|<json>"
  1566. "|<xml>"
  1567. "|<JSON>"
  1568. ")?"
  1569. "(\\s*\\{\\s*\"name\")" // match 3 (named tool call)
  1570. ")"
  1571. "|<function=([^>]+)>" // match 4 (function name)
  1572. "|<function name=\"([^\"]+)\">" // match 5 (function name again)
  1573. );
  1574. while (auto res = builder.try_find_regex(open_regex)) {
  1575. const auto & block_start = res->groups[1];
  1576. std::string block_end = block_start.empty() ? "" : "```";
  1577. const auto & open_tag = res->groups[2];
  1578. std::string close_tag;
  1579. if (!res->groups[3].empty()) {
  1580. builder.move_to(res->groups[3].begin);
  1581. close_tag = open_tag.empty() ? "" : "</" + builder.str(open_tag).substr(1);
  1582. if (auto tool_call = builder.try_consume_json_with_dumped_args({{"arguments"}})) {
  1583. if (!builder.add_tool_call(tool_call->value) || tool_call->is_partial) {
  1584. throw common_chat_msg_partial_exception("incomplete tool call");
  1585. }
  1586. builder.consume_spaces();
  1587. builder.consume_literal(close_tag);
  1588. builder.consume_spaces();
  1589. if (!block_end.empty()) {
  1590. builder.consume_literal(block_end);
  1591. builder.consume_spaces();
  1592. }
  1593. } else {
  1594. throw common_chat_msg_partial_exception("failed to parse tool call");
  1595. }
  1596. } else {
  1597. auto function_name = builder.str(res->groups[4]);
  1598. if (function_name.empty()) {
  1599. function_name = builder.str(res->groups[5]);
  1600. }
  1601. GGML_ASSERT(!function_name.empty());
  1602. close_tag = "</function>";
  1603. if (auto arguments = builder.try_consume_json_with_dumped_args({{}})) {
  1604. if (!builder.add_tool_call(function_name, "", arguments->value) || arguments->is_partial) {
  1605. throw common_chat_msg_partial_exception("incomplete tool call");
  1606. }
  1607. builder.consume_spaces();
  1608. builder.consume_literal(close_tag);
  1609. builder.consume_spaces();
  1610. if (!block_end.empty()) {
  1611. builder.consume_literal(block_end);
  1612. builder.consume_spaces();
  1613. }
  1614. }
  1615. }
  1616. }
  1617. builder.add_content(builder.consume_rest());
  1618. }
  1619. static common_chat_params common_chat_params_init_without_tools(const common_chat_template & tmpl, const struct templates_params & inputs) {
  1620. common_chat_params data;
  1621. data.prompt = apply(tmpl, inputs);
  1622. data.format = COMMON_CHAT_FORMAT_CONTENT_ONLY;
  1623. data.grammar_lazy = false;
  1624. if (!inputs.json_schema.is_null()) {
  1625. if (!inputs.grammar.empty()) {
  1626. throw std::runtime_error("Either \"json_schema\" or \"grammar\" can be specified, but not both");
  1627. }
  1628. data.grammar = json_schema_to_grammar(inputs.json_schema);
  1629. } else {
  1630. data.grammar = inputs.grammar;
  1631. }
  1632. return data;
  1633. }
  1634. static common_chat_params common_chat_templates_apply_jinja(
  1635. const struct common_chat_templates * tmpls,
  1636. const struct common_chat_templates_inputs & inputs)
  1637. {
  1638. templates_params params;
  1639. params.tools = common_chat_tools_to_json_oaicompat<json>(inputs.tools);
  1640. const auto & tmpl = params.tools.is_array() && tmpls->template_tool_use
  1641. ? *tmpls->template_tool_use
  1642. : *tmpls->template_default;
  1643. const auto & src = tmpl.source();
  1644. const auto & caps = tmpl.original_caps();
  1645. params.messages = common_chat_msgs_to_json_oaicompat<json>(inputs.messages, /* concat_text= */ !tmpl.original_caps().requires_typed_content);
  1646. params.add_generation_prompt = inputs.add_generation_prompt;
  1647. params.tool_choice = inputs.tool_choice;
  1648. params.enable_thinking = inputs.enable_thinking;
  1649. params.grammar = inputs.grammar;
  1650. params.now = inputs.now;
  1651. params.add_bos = inputs.add_bos;
  1652. params.add_eos = inputs.add_eos;
  1653. params.extra_context = json::object();
  1654. for (auto el : inputs.chat_template_kwargs) {
  1655. params.extra_context[el.first] = json::parse(el.second);
  1656. }
  1657. if (!inputs.json_schema.empty()) {
  1658. params.json_schema = json::parse(inputs.json_schema);
  1659. }
  1660. if (inputs.parallel_tool_calls && !tmpl.original_caps().supports_parallel_tool_calls) {
  1661. LOG_DBG("Disabling parallel_tool_calls because the template does not support it\n");
  1662. params.parallel_tool_calls = false;
  1663. } else {
  1664. params.parallel_tool_calls = inputs.parallel_tool_calls;
  1665. }
  1666. if (params.tools.is_array()) {
  1667. if (params.tool_choice != COMMON_CHAT_TOOL_CHOICE_NONE && !params.grammar.empty()) {
  1668. throw std::runtime_error("Cannot specify grammar with tools");
  1669. }
  1670. if (caps.supports_tool_calls && !caps.supports_tools) {
  1671. 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");
  1672. }
  1673. }
  1674. // DeepSeek R1: use handler in all cases except json schema (thinking / tools).
  1675. if (src.find("<|tool▁calls▁begin|>") != std::string::npos && params.json_schema.is_null()) {
  1676. return common_chat_params_init_deepseek_r1(tmpl, params);
  1677. }
  1678. // Command R7B: : use handler in all cases except json schema (thinking / tools).
  1679. if (src.find("<|END_THINKING|><|START_ACTION|>") != std::string::npos && params.json_schema.is_null()) {
  1680. return common_chat_params_init_command_r7b(tmpl, params);
  1681. }
  1682. // Hermes 2/3 Pro, Qwen 2.5 Instruct (w/ tools)
  1683. if (src.find("<tool_call>") != std::string::npos && params.json_schema.is_null()) {
  1684. return common_chat_params_init_hermes_2_pro(tmpl, params);
  1685. }
  1686. // GPT-OSS
  1687. if (src.find("<|channel|>") != std::string::npos && params.json_schema.is_null()) {
  1688. return common_chat_params_init_gpt_oss(tmpl, params);
  1689. }
  1690. // Use generic handler when mixing tools + JSON schema.
  1691. // TODO: support that mix in handlers below.
  1692. if ((params.tools.is_array() && params.json_schema.is_object())) {
  1693. return common_chat_params_init_generic(tmpl, params);
  1694. }
  1695. // Functionary prepends "all\n" to plain content outputs, so we use its handler in all cases.
  1696. if (src.find(">>>all") != std::string::npos) {
  1697. return common_chat_params_init_functionary_v3_2(tmpl, params);
  1698. }
  1699. // Firefunction v2 requires datetime and functions in the context even w/o tools, so we also use its handler in all cases.
  1700. if (src.find(" functools[") != std::string::npos) {
  1701. return common_chat_params_init_firefunction_v2(tmpl, params);
  1702. }
  1703. // Functionary v3.1 (w/ tools)
  1704. if (src.find("<|start_header_id|>") != std::string::npos
  1705. && src.find("<function=") != std::string::npos) {
  1706. return common_chat_params_init_functionary_v3_1_llama_3_1(tmpl, params);
  1707. }
  1708. // Llama 3.1, 3.2, 3.3 (also requires date_string so using it even w/o tools)
  1709. if (src.find("<|start_header_id|>ipython<|end_header_id|>") != std::string::npos) {
  1710. auto allow_python_tag_builtin_tools = src.find("<|python_tag|>") != std::string::npos;
  1711. return common_chat_params_init_llama_3_x(tmpl, params, allow_python_tag_builtin_tools);
  1712. }
  1713. // Plain handler (no tools)
  1714. if (params.tools.is_null() || inputs.tool_choice == COMMON_CHAT_TOOL_CHOICE_NONE) {
  1715. return common_chat_params_init_without_tools(tmpl, params);
  1716. }
  1717. // Mistral Nemo (w/ tools)
  1718. if (src.find("[TOOL_CALLS]") != std::string::npos) {
  1719. return common_chat_params_init_mistral_nemo(tmpl, params);
  1720. }
  1721. // Generic fallback
  1722. return common_chat_params_init_generic(tmpl, params);
  1723. }
  1724. // Legacy template route (adhoc C++ implementation of known templates), forward to llama_chat_apply_template.
  1725. static common_chat_params common_chat_templates_apply_legacy(
  1726. const struct common_chat_templates * tmpls,
  1727. const struct common_chat_templates_inputs & inputs)
  1728. {
  1729. int alloc_size = 0;
  1730. std::vector<llama_chat_message> chat;
  1731. std::vector<std::string> contents;
  1732. for (const auto & msg : inputs.messages) {
  1733. auto content = msg.content;
  1734. for (const auto & part : msg.content_parts) {
  1735. if (part.type != "text") {
  1736. LOG_WRN("Ignoring non-text content part: %s\n", part.type.c_str());
  1737. continue;
  1738. }
  1739. if (!content.empty()) {
  1740. content += "\n";;
  1741. }
  1742. content += part.text;
  1743. }
  1744. contents.emplace_back(std::move(content));
  1745. }
  1746. for (size_t i = 0; i < contents.size(); ++i) {
  1747. const auto & msg = inputs.messages[i];
  1748. const auto & content = contents[i];
  1749. chat.push_back({msg.role.c_str(), content.c_str()});
  1750. alloc_size += (msg.role.size() + content.size()) * 1.25;
  1751. }
  1752. std::vector<char> buf(alloc_size);
  1753. // run the first time to get the total output length
  1754. const auto & src = tmpls->template_default->source();
  1755. int32_t res = llama_chat_apply_template(src.c_str(), chat.data(), chat.size(), inputs.add_generation_prompt, buf.data(), buf.size());
  1756. // error: chat template is not supported
  1757. if (res < 0) {
  1758. // if the custom "tmpl" is not supported, we throw an error
  1759. // this is a bit redundant (for good), since we're not sure if user validated the custom template with llama_chat_verify_template()
  1760. throw std::runtime_error("this custom template is not supported, try using --jinja");
  1761. }
  1762. // if it turns out that our buffer is too small, we resize it
  1763. if ((size_t) res > buf.size()) {
  1764. buf.resize(res);
  1765. res = llama_chat_apply_template(src.c_str(), chat.data(), chat.size(), inputs.add_generation_prompt, buf.data(), buf.size());
  1766. }
  1767. common_chat_params params;
  1768. params.prompt = std::string(buf.data(), res);
  1769. if (!inputs.json_schema.empty()) {
  1770. params.grammar = json_schema_to_grammar(json::parse(inputs.json_schema));
  1771. } else {
  1772. params.grammar = inputs.grammar;
  1773. }
  1774. return params;
  1775. }
  1776. common_chat_params common_chat_templates_apply(
  1777. const struct common_chat_templates * tmpls,
  1778. const struct common_chat_templates_inputs & inputs)
  1779. {
  1780. GGML_ASSERT(tmpls != nullptr);
  1781. return inputs.use_jinja
  1782. ? common_chat_templates_apply_jinja(tmpls, inputs)
  1783. : common_chat_templates_apply_legacy(tmpls, inputs);
  1784. }
  1785. static void common_chat_parse_content_only(common_chat_msg_parser & builder) {
  1786. builder.add_content(builder.consume_rest());
  1787. }
  1788. static void common_chat_parse(common_chat_msg_parser & builder) {
  1789. LOG_DBG("Parsing input with format %s: %s\n", common_chat_format_name(builder.syntax().format), builder.input().c_str());
  1790. switch (builder.syntax().format) {
  1791. case COMMON_CHAT_FORMAT_CONTENT_ONLY:
  1792. common_chat_parse_content_only(builder);
  1793. break;
  1794. case COMMON_CHAT_FORMAT_GENERIC:
  1795. common_chat_parse_generic(builder);
  1796. break;
  1797. case COMMON_CHAT_FORMAT_MISTRAL_NEMO:
  1798. common_chat_parse_mistral_nemo(builder);
  1799. break;
  1800. case COMMON_CHAT_FORMAT_LLAMA_3_X:
  1801. common_chat_parse_llama_3_1(builder);
  1802. break;
  1803. case COMMON_CHAT_FORMAT_LLAMA_3_X_WITH_BUILTIN_TOOLS:
  1804. common_chat_parse_llama_3_1(builder, /* with_builtin_tools= */ true);
  1805. break;
  1806. case COMMON_CHAT_FORMAT_DEEPSEEK_R1:
  1807. common_chat_parse_deepseek_r1(builder);
  1808. break;
  1809. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_2:
  1810. common_chat_parse_functionary_v3_2(builder);
  1811. break;
  1812. case COMMON_CHAT_FORMAT_FUNCTIONARY_V3_1_LLAMA_3_1:
  1813. common_chat_parse_functionary_v3_1_llama_3_1(builder);
  1814. break;
  1815. case COMMON_CHAT_FORMAT_HERMES_2_PRO:
  1816. common_chat_parse_hermes_2_pro(builder);
  1817. break;
  1818. case COMMON_CHAT_FORMAT_FIREFUNCTION_V2:
  1819. common_chat_parse_firefunction_v2(builder);
  1820. break;
  1821. case COMMON_CHAT_FORMAT_COMMAND_R7B:
  1822. common_chat_parse_command_r7b(builder);
  1823. break;
  1824. case COMMON_CHAT_FORMAT_GPT_OSS:
  1825. common_chat_parse_gpt_oss(builder);
  1826. break;
  1827. default:
  1828. throw std::runtime_error(std::string("Unsupported format: ") + common_chat_format_name(builder.syntax().format));
  1829. }
  1830. builder.finish();
  1831. }
  1832. common_chat_msg common_chat_parse(const std::string & input, bool is_partial, const common_chat_syntax & syntax) {
  1833. common_chat_msg_parser builder(input, is_partial, syntax);
  1834. try {
  1835. common_chat_parse(builder);
  1836. } catch (const common_chat_msg_partial_exception & ex) {
  1837. LOG_DBG("Partial parse: %s\n", ex.what());
  1838. if (!is_partial) {
  1839. builder.clear_tools();
  1840. builder.move_to(0);
  1841. common_chat_parse_content_only(builder);
  1842. }
  1843. }
  1844. auto msg = builder.result();
  1845. if (!is_partial) {
  1846. LOG_DBG("Parsed message: %s\n", common_chat_msgs_to_json_oaicompat<json>({msg}).at(0).dump().c_str());
  1847. }
  1848. return msg;
  1849. }