chat.cpp 97 KB

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