chat.cpp 83 KB

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