chat.cpp 123 KB

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