chat.cpp 125 KB

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