chat.cpp 150 KB

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