1#pragma once
2
3#include "chat.h"
4
5#include <nlohmann/json.hpp>
6
7#include <optional>
8#include <string>
9#include <vector>
10
11
12// Sample config:
13// MiniMax-M2 (left): <minimax:tool_call>\n<invoke name="tool-name">\n<parameter name="key">value</parameter>\n...</invoke>\n...</minimax:tool_call>
14// GLM 4.5 (right): <tool_call>function_name\n<arg_key>key</arg_key>\n<arg_value>value</arg_value>\n</tool_call>
15struct xml_tool_call_format {
16 std::string scope_start; // <minimax:tool_call>\n // \n // can be empty
17 std::string tool_start; // <invoke name=\" // <tool_call>
18 std::string tool_sep; // \">\n // \n // can be empty only for parse_xml_tool_calls
19 std::string key_start; // <parameter name=\" // <arg_key>
20 std::string key_val_sep; // \"> // </arg_key>\n<arg_value>
21 std::string val_end; // </parameter>\n // </arg_value>\n
22 std::string tool_end; // </invoke>\n // </tool_call>\n
23 std::string scope_end; // </minimax:tool_call> // // can be empty
24 // Set this if there can be dynamic spaces inside key_val_sep.
25 // e.g. key_val_sep=</arg_key> key_val_sep2=<arg_value> for GLM4.5
26 std::optional<std::string> key_val_sep2 = std::nullopt;
27 // Set true if argval should only be raw string. e.g. Hello "world" hi
28 // Set false if argval should only be json string. e.g. "Hello \"world\" hi"
29 // Defaults to std::nullopt, both will be allowed.
30 std::optional<bool> raw_argval = std::nullopt;
31 std::optional<std::string> last_val_end = std::nullopt;
32 std::optional<std::string> last_tool_end = std::nullopt;
33 bool trim_raw_argval = false;
34 bool allow_toolcall_in_think = false;
35};
36
37// make a GBNF that accept any strings except those containing any of the forbidden strings.
38std::string make_gbnf_excluding(std::vector<std::string> forbids);
39
40/**
41 * Build grammar for xml-style tool call
42 * form.scope_start and form.scope_end can be empty.
43 * Requires data.format for model-specific hacks.
44 */
45void build_grammar_xml_tool_call(common_chat_params & data, const nlohmann::ordered_json & tools, const struct xml_tool_call_format & form);