1
0

chat.cpp 83 KB

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