#include <chat_template.h>

Collaboration diagram for microtorch::chat::Template:

Public Member Functions
std::string	id () const

json	to_json () const

Static Public Member Functions
template<class J >
static Template	from_json (const J &r)

Public Attributes
std::string	name

json	version

std::string	bos

std::string	content = "raw"

std::string	system_mode = "none"

std::string	system_join

std::string	system_open

std::string	system_close

std::string	user_open

std::string	user_close

std::string	assistant_open

std::string	assistant_close

std::string	generation_prompt

bool	has_nothink = false

std::string	generation_prompt_nothink

std::vector< std::string >	stop_eos

std::vector< std::string >	stop_turn

std::string	past_assistant = "keep"

bool	has_default_system = false

std::string	default_system

std::vector< std::string >	reserved

std::vector< std::string >	markers

std::vector< std::string >	match

std::vector< std::string >	architectures

bool	has_tool = false

bool	has_tools = false

std::string	tool_open

std::string	tool_close

std::string	tool_call_open

std::string	tool_call_join

std::string	tools_join

std::string	tools_sep

Detailed Description

Definition at line 89 of file chat_template.h.

Member Function Documentation

◆ from_json()

template<class J >

static Template microtorch::chat::Template::from_json ( const J & r )

inlinestatic

Definition at line 141 of file chat_template.h.

                                          {
        static const char* known[] = {"name", "version", "bos", "content", "system", "user", "assistant",
                                      "generation_prompt", "generation_prompt_nothink", "stop", "past_assistant",
                                      "default_system", "reserved", "markers", "match", "architectures",
                                      "tool", "tool_call", "tools"};
        if (!r.is_object()) throw Error("chat template: the record is not a JSON object");
        for (auto it = r.begin(); it != r.end(); ++it) {
            const std::string k = it.key();
            bool ok = !k.empty() && k[0] == '_';
            for (const char* q : known) ok = ok || k == q;
            if (!ok) throw Error("chat template field '" + k + "' is not implemented");
        }
        for (const char* k : {"name", "version", "user", "assistant", "generation_prompt", "stop"})
            if (!r.contains(k)) throw Error(std::string("chat template has no '") + k + "'");
        Template t;
        t.name = r["name"].template get<std::string>();
        if (!r["version"].is_string() && !r["version"].is_number_integer())
            throw Error("chat template version must be an integer or a string");
        t.version = json::parse(r["version"].dump());
        t.bos = r.value("bos", std::string());
        t.content = r.value("content", std::string("raw"));
        if (t.content != "raw" && t.content != "trim")
            throw Error("chat template content '" + t.content + "' is not implemented (raw, trim)");
        if (r.contains("system")) {
            const auto& s = r["system"];
            t.system_mode = s.value("mode", std::string("none"));
            if (t.system_mode != "fold" && t.system_mode != "turn" && t.system_mode != "none")
                throw Error("chat template system mode '" + t.system_mode + "' is not implemented (fold, turn, none)");
            t.system_join = s.value("join", std::string());
            t.system_open = s.value("open", std::string());
            t.system_close = s.value("close", std::string());
        }
        auto side = [&](const char* k, std::string& open, std::string& close) {
            const auto& s = r[k];
            for (auto it = s.begin(); it != s.end(); ++it)
                if (it.key() != "open" && it.key() != "close")
                    throw Error(std::string("chat template ") + k + " takes open and close only");
            open = s.value("open", std::string());
            close = s.value("close", std::string());
        };
        side("user", t.user_open, t.user_close);
        side("assistant", t.assistant_open, t.assistant_close);
        auto pair = [&](const char* k, const char* a, const char* b, std::string& x, std::string& y) {
            const auto& s = r[k];
            if (!s.is_object()) throw Error(std::string("chat template ") + k + " is an object");
            for (auto it = s.begin(); it != s.end(); ++it)
                if (it.key() != a && it.key() != b)
                    throw Error(std::string("chat template ") + k + " takes " + a + " and " + b + " only");
            x = s.value(a, std::string());
            y = s.value(b, std::string());
        };
        if (r.contains("tool") != r.contains("tool_call")) throw Error("chat template tool and tool_call come together");
        if (r.contains("tools") && !r.contains("tool")) throw Error("chat template tools needs tool and tool_call");
        if (r.contains("tool")) {
            if (t.system_mode != "turn") throw Error("chat template tool turns need system mode turn");
            t.has_tool = true;
            pair("tool", "open", "close", t.tool_open, t.tool_close);
            pair("tool_call", "open", "join", t.tool_call_open, t.tool_call_join);
        }
        if (r.contains("tools")) {
            t.has_tools = true;
            pair("tools", "join", "sep", t.tools_join, t.tools_sep);
        }
        t.generation_prompt = r["generation_prompt"].template get<std::string>();
        if (r.contains("generation_prompt_nothink")) {
            t.has_nothink = true;
            t.generation_prompt_nothink = r["generation_prompt_nothink"].template get<std::string>();
        }
        auto strs = [&](const J& a) {
            std::vector<std::string> v;
            for (const auto& x : a) v.push_back(x.template get<std::string>());
            return v;
        };
        t.stop_eos = strs(r["stop"].value("eos", J::array()));
        t.stop_turn = strs(r["stop"].value("turn", J::array()));
        t.past_assistant = r.value("past_assistant", std::string("keep"));
        if (t.past_assistant != "keep" && t.past_assistant != "strip_think")
            throw Error("chat template past_assistant '" + t.past_assistant + "' is not implemented");
        if (r.contains("default_system")) {
            t.has_default_system = true;
            t.default_system = r["default_system"].template get<std::string>();
        }
        if (r.contains("reserved")) t.reserved = strs(r["reserved"]);
        if (r.contains("markers")) t.markers = strs(r["markers"]);
        if (r.contains("match")) t.match = strs(r["match"]);
        if (r.contains("architectures")) t.architectures = strs(r["architectures"]);
        return t;
    }

References a, j, k, name, v, and value.

◆ id()

std::string microtorch::chat::Template::id ( ) const

inline

Definition at line 108 of file chat_template.h.

108{ return name + "/" + (version.is_string() ? version.get<std::string>() : version.dump()); }

microtorch::chat::Template::version

json version

Definition chat_template.h:91

microtorch::chat::Template::name

std::string name

Definition chat_template.h:90

References name, and version.

Referenced by microtorch::chat::get(), and tinyllama::TinyLlamaSession::TinyLlamaSession().

◆ to_json()

json microtorch::chat::Template::to_json ( ) const

inline

Definition at line 111 of file chat_template.h.

                         {
        json r = {{"name", name}, {"version", version}, {"bos", bos}, {"content", content}};
        json s = {{"mode", system_mode}};
        if (system_mode == "fold") s["join"] = system_join;
        if (system_mode == "turn") {
            s["open"] = system_open;
            s["close"] = system_close;
        }
        r["system"] = s;
        r["user"] = {{"open", user_open}, {"close", user_close}};
        r["assistant"] = {{"open", assistant_open}, {"close", assistant_close}};
        if (has_tool) {
            r["tool"] = {{"open", tool_open}, {"close", tool_close}};
            r["tool_call"] = {{"open", tool_call_open}, {"join", tool_call_join}};
        }
        if (has_tools) r["tools"] = {{"join", tools_join}, {"sep", tools_sep}};
        r["generation_prompt"] = generation_prompt;
        r["stop"] = {{"eos", stop_eos}, {"turn", stop_turn}};
        r["past_assistant"] = past_assistant;
        r["reserved"] = reserved;
        if (!markers.empty()) r["markers"] = markers;
        if (has_default_system) r["default_system"] = default_system;
        if (has_nothink) r["generation_prompt_nothink"] = generation_prompt_nothink;
        if (!match.empty()) r["match"] = match;
        if (!architectures.empty()) r["architectures"] = architectures;
        return r;
    }

References architectures, assistant_close, assistant_open, bos, content, default_system, generation_prompt, generation_prompt_nothink, has_default_system, has_nothink, has_tool, has_tools, j, markers, match, name, past_assistant, reserved, stop_eos, stop_turn, system_close, system_join, system_mode, system_open, tool_call_join, tool_call_open, tool_close, tool_open, tools_join, tools_sep, user_close, user_open, and version.

Member Data Documentation

◆ architectures

std::vector<std::string> microtorch::chat::Template::architectures

Definition at line 102 of file chat_template.h.

Referenced by to_json().

◆ assistant_close

std::string microtorch::chat::Template::assistant_close

Definition at line 94 of file chat_template.h.

Referenced by to_json(), and ember::ChatFormat::v1_markers().

◆ assistant_open

std::string microtorch::chat::Template::assistant_open

Definition at line 94 of file chat_template.h.

Referenced by to_json(), and ember::ChatFormat::v1_markers().

◆ bos

std::string microtorch::chat::Template::bos

Definition at line 92 of file chat_template.h.

Referenced by to_json(), and ember::ChatFormat::v1_markers().

◆ content

std::string microtorch::chat::Template::content = "raw"

Definition at line 92 of file chat_template.h.

Referenced by to_json(), and ember::ChatFormat::v1_markers().

◆ default_system

std::string microtorch::chat::Template::default_system

Definition at line 101 of file chat_template.h.

Referenced by to_json().

◆ generation_prompt

std::string microtorch::chat::Template::generation_prompt

Definition at line 95 of file chat_template.h.

Referenced by to_json(), and ember::ChatFormat::v1_markers().

◆ generation_prompt_nothink

std::string microtorch::chat::Template::generation_prompt_nothink

Definition at line 97 of file chat_template.h.

Referenced by to_json().

◆ has_default_system

bool microtorch::chat::Template::has_default_system = false

Definition at line 100 of file chat_template.h.

Referenced by to_json().

◆ has_nothink

bool microtorch::chat::Template::has_nothink = false

Definition at line 96 of file chat_template.h.

Referenced by to_json().

◆ has_tool

bool microtorch::chat::Template::has_tool = false

Definition at line 105 of file chat_template.h.

Referenced by main(), and to_json().

◆ has_tools

bool microtorch::chat::Template::has_tools = false

Definition at line 105 of file chat_template.h.

Referenced by to_json().

◆ markers

std::vector<std::string> microtorch::chat::Template::markers

Definition at line 102 of file chat_template.h.

Referenced by to_json().

◆ match

std::vector<std::string> microtorch::chat::Template::match

Definition at line 102 of file chat_template.h.

Referenced by to_json().

◆ name

std::string microtorch::chat::Template::name

Definition at line 90 of file chat_template.h.

Referenced by microtorch::chat::chatml(), from_json(), microtorch::chat::gemma3(), id(), microtorch::chat::legacy_word(), ember::ChatFormat::of(), to_json(), microtorch::chat::v1(), and ember::ChatFormat::v1_markers().

◆ past_assistant

std::string microtorch::chat::Template::past_assistant = "keep"

Definition at line 99 of file chat_template.h.

Referenced by to_json().

◆ reserved

std::vector<std::string> microtorch::chat::Template::reserved

Definition at line 102 of file chat_template.h.

Referenced by to_json().

◆ stop_eos

std::vector<std::string> microtorch::chat::Template::stop_eos

Definition at line 98 of file chat_template.h.

Referenced by to_json(), and ember::ChatFormat::v1_markers().

◆ stop_turn

std::vector<std::string> microtorch::chat::Template::stop_turn

Definition at line 98 of file chat_template.h.

Referenced by to_json(), and ember::ChatFormat::v1_markers().

◆ system_close

std::string microtorch::chat::Template::system_close

Definition at line 93 of file chat_template.h.

Referenced by to_json().

◆ system_join

std::string microtorch::chat::Template::system_join

Definition at line 93 of file chat_template.h.

Referenced by to_json().

◆ system_mode

std::string microtorch::chat::Template::system_mode = "none"

Definition at line 93 of file chat_template.h.

Referenced by to_json(), and ember::ChatFormat::v1_markers().

◆ system_open

std::string microtorch::chat::Template::system_open

Definition at line 93 of file chat_template.h.

Referenced by to_json().

◆ tool_call_join

std::string microtorch::chat::Template::tool_call_join

Definition at line 106 of file chat_template.h.

Referenced by to_json().

◆ tool_call_open

std::string microtorch::chat::Template::tool_call_open

Definition at line 106 of file chat_template.h.

Referenced by to_json().

◆ tool_close

std::string microtorch::chat::Template::tool_close

Definition at line 106 of file chat_template.h.

Referenced by to_json().

◆ tool_open

std::string microtorch::chat::Template::tool_open

Definition at line 106 of file chat_template.h.

Referenced by to_json().

◆ tools_join

std::string microtorch::chat::Template::tools_join

Definition at line 106 of file chat_template.h.

Referenced by to_json().

◆ tools_sep

std::string microtorch::chat::Template::tools_sep

Definition at line 106 of file chat_template.h.

Referenced by to_json().

◆ user_close

std::string microtorch::chat::Template::user_close

Definition at line 94 of file chat_template.h.

Referenced by to_json(), and ember::ChatFormat::v1_markers().

◆ user_open

std::string microtorch::chat::Template::user_open

Definition at line 94 of file chat_template.h.

Referenced by to_json(), and ember::ChatFormat::v1_markers().

◆ version

json microtorch::chat::Template::version

Definition at line 91 of file chat_template.h.

Referenced by id(), to_json(), and ember::ChatFormat::v1_markers().

The documentation for this struct was generated from the following file:

chat_template.h

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ from_json()

◆ id()

◆ to_json()

Member Data Documentation

◆ architectures

◆ assistant_close

◆ assistant_open

◆ bos

◆ content

◆ default_system

◆ generation_prompt

◆ generation_prompt_nothink

◆ has_default_system

◆ has_nothink

◆ has_tool

◆ has_tools

◆ markers

◆ match

◆ name

◆ past_assistant

◆ reserved

◆ stop_eos

◆ stop_turn

◆ system_close

◆ system_join

◆ system_mode

◆ system_open

◆ tool_call_join

◆ tool_call_open

◆ tool_close

◆ tool_open

◆ tools_join

◆ tools_sep

◆ user_close

◆ user_open

◆ version