update

docs/chat-template/DeepSeek-R1/json_output.py

@@ -0,0 +1,40 @@
+"""
+
+"""
+
+
+import json
+from openai import OpenAI
+
+client = OpenAI(
+    api_key="<your api key>",
+    base_url="https://api.deepseek.com",
+)
+
+system_prompt = """
+The user will provide some exam text. Please parse the "question" and "answer" and output them in JSON format. 
+
+EXAMPLE INPUT: 
+Which is the highest mountain in the world? Mount Everest.
+
+EXAMPLE JSON OUTPUT:
+{
+    "question": "Which is the highest mountain in the world?",
+    "answer": "Mount Everest"
+}
+"""
+
+user_prompt = "Which is the longest river in the world? The Nile River."
+
+messages = [{"role": "system", "content": system_prompt},
+            {"role": "user", "content": user_prompt}]
+
+response = client.chat.completions.create(
+    model="deepseek-chat",
+    messages=messages,
+    response_format={
+        'type': 'json_object'
+    }
+)
+
+print(json.loads(response.choices[0].message.content))

docs/chat-template/DeepSeek-R1/tool_demo.py

@@ -0,0 +1,59 @@
+"""
+https://github.com/deepseek-ai/DeepSeek-R1/issues/9
+
+
+## reference
+- https://api-docs.deepseek.com/guides/function_calling
+- s
+
+"""
+
+
+
+
+from openai import OpenAI
+
+def send_messages(messages):
+    response = client.chat.completions.create(
+        model="deepseek-chat",
+        messages=messages,
+        tools=tools
+    )
+    return response.choices[0].message
+
+client = OpenAI(
+    api_key="<your api key>",
+    base_url="https://api.deepseek.com",
+)
+
+tools = [
+    {
+        "type": "function",
+        "function": {
+            "name": "get_weather",
+            "description": "Get weather of a location, the user should supply a location first.",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "location": {
+                        "type": "string",
+                        "description": "The city and state, e.g. San Francisco, CA",
+                    }
+                },
+                "required": ["location"]
+            },
+        }
+    },
+]
+
+messages = [{"role": "user", "content": "How's the weather in Hangzhou?"}]
+message = send_messages(messages)
+print(f"User>\t {messages[0]['content']}")
+
+tool = message.tool_calls[0]
+messages.append(message)
+
+messages.append({"role": "tool", "tool_call_id": tool.id, "content": "24℃"})
+message = send_messages(messages)
+print(f"Model>\t {message.content}")
+

docs/chat-template/DeepSeek-V3.1/enable_thinking.py

@@ -0,0 +1,23 @@
+from transformers import AutoTokenizer
+
+MODEL_PATH = "deepseek-ai/DeepSeek-V3.1"
+
+
+tokenizer = AutoTokenizer.from_pretrained(MODEL_PATH)
+
+
+messages = [
+  {"role": "system", "content": "You are a bot that responds to weather queries."},
+  {"role": "user", "content": "Hey, what's the temperature in Paris right now?"},
+  {"role": "assistant", "content": "2"},
+  {"role": "user", "content": "3"},
+]
+
+prompt = tokenizer.apply_chat_template(
+    conversation=messages,
+    tokenize=False,
+    thinking=True,
+    add_generation_prompt=True,
+)
+
+print(prompt)

docs/chat-template/Qwen3-235B-A22B-Instruct-2507/chat_template.jinja

@@ -0,0 +1,86 @@
+{%- if tools %}
+    {{- '<|im_start|>system\n' }}
+    {%- if messages[0].role == 'system' %}
+        {{- messages[0].content + '\n\n' }}
+    {%- endif %}
+    {{- "# Tools\n\nYou may call one or more functions to assist with the user query.\n\nYou are provided with function signatures within <tools></tools> XML tags:\n<tools>" }}
+    {%- for tool in tools %}
+        {{- "\n" }}
+        {{- tool | tojson }}
+    {%- endfor %}
+    {{- "\n</tools>\n\nFor each function call, return a json object with function name and arguments within <tool_call></tool_call> XML tags:\n<tool_call>\n{\"name\": <function-name>, \"arguments\": <args-json-object>}\n</tool_call><|im_end|>\n" }}
+{%- else %}
+    {%- if messages[0].role == 'system' %}
+        {{- '<|im_start|>system\n' + messages[0].content + '<|im_end|>\n' }}
+    {%- endif %}
+{%- endif %}
+{%- set ns = namespace(multi_step_tool=true, last_query_index=messages|length - 1) %}
+{%- for message in messages[::-1] %}
+    {%- set index = (messages|length - 1) - loop.index0 %}
+    {%- if ns.multi_step_tool and message.role == "user" and message.content is string and not(message.content.startswith('<tool_response>') and message.content.endswith('</tool_response>')) %}
+        {%- set ns.multi_step_tool = false %}
+        {%- set ns.last_query_index = index %}
+    {%- endif %}
+{%- endfor %}
+{%- for message in messages %}
+    {%- if message.content is string %}
+        {%- set content = message.content %}
+    {%- else %}
+        {%- set content = '' %}
+    {%- endif %}
+    {%- if (message.role == "user") or (message.role == "system" and not loop.first) %}
+        {{- '<|im_start|>' + message.role + '\n' + content + '<|im_end|>' + '\n' }}
+    {%- elif message.role == "assistant" %}
+        {%- set reasoning_content = '' %}
+        {%- if message.reasoning_content is string %}
+            {%- set reasoning_content = message.reasoning_content %}
+        {%- else %}
+            {%- if '</think>' in content %}
+                {%- set reasoning_content = content.split('</think>')[0].rstrip('\n').split('<think>')[-1].lstrip('\n') %}
+                {%- set content = content.split('</think>')[-1].lstrip('\n') %}
+            {%- endif %}
+        {%- endif %}
+        {%- if loop.index0 > ns.last_query_index %}
+            {%- if loop.last or (not loop.last and reasoning_content) %}
+                {{- '<|im_start|>' + message.role + '\n<think>\n' + reasoning_content.strip('\n') + '\n</think>\n\n' + content.lstrip('\n') }}
+            {%- else %}
+                {{- '<|im_start|>' + message.role + '\n' + content }}
+            {%- endif %}
+        {%- else %}
+            {{- '<|im_start|>' + message.role + '\n' + content }}
+        {%- endif %}
+        {%- if message.tool_calls %}
+            {%- for tool_call in message.tool_calls %}
+                {%- if (loop.first and content) or (not loop.first) %}
+                    {{- '\n' }}
+                {%- endif %}
+                {%- if tool_call.function %}
+                    {%- set tool_call = tool_call.function %}
+                {%- endif %}
+                {{- '<tool_call>\n{"name": "' }}
+                {{- tool_call.name }}
+                {{- '", "arguments": ' }}
+                {%- if tool_call.arguments is string %}
+                    {{- tool_call.arguments }}
+                {%- else %}
+                    {{- tool_call.arguments | tojson }}
+                {%- endif %}
+                {{- '}\n</tool_call>' }}
+            {%- endfor %}
+        {%- endif %}
+        {{- '<|im_end|>\n' }}
+    {%- elif message.role == "tool" %}
+        {%- if loop.first or (messages[loop.index0 - 1].role != "tool") %}
+            {{- '<|im_start|>user' }}
+        {%- endif %}
+        {{- '\n<tool_response>\n' }}
+        {{- content }}
+        {{- '\n</tool_response>' }}
+        {%- if loop.last or (messages[loop.index0 + 1].role != "tool") %}
+            {{- '<|im_end|>\n' }}
+        {%- endif %}
+    {%- endif %}
+{%- endfor %}
+{%- if add_generation_prompt %}
+    {{- '<|im_start|>assistant\n' }}
+{%- endif %}

docs/chat-template/Qwen3-235B-A22B-Thinking-2507/chat_template.jinja

@@ -0,0 +1,86 @@
+{%- if tools %}
+    {{- '<|im_start|>system\n' }}
+    {%- if messages[0].role == 'system' %}
+        {{- messages[0].content + '\n\n' }}
+    {%- endif %}
+    {{- "# Tools\n\nYou may call one or more functions to assist with the user query.\n\nYou are provided with function signatures within <tools></tools> XML tags:\n<tools>" }}
+    {%- for tool in tools %}
+        {{- "\n" }}
+        {{- tool | tojson }}
+    {%- endfor %}
+    {{- "\n</tools>\n\nFor each function call, return a json object with function name and arguments within <tool_call></tool_call> XML tags:\n<tool_call>\n{\"name\": <function-name>, \"arguments\": <args-json-object>}\n</tool_call><|im_end|>\n" }}
+{%- else %}
+    {%- if messages[0].role == 'system' %}
+        {{- '<|im_start|>system\n' + messages[0].content + '<|im_end|>\n' }}
+    {%- endif %}
+{%- endif %}
+{%- set ns = namespace(multi_step_tool=true, last_query_index=messages|length - 1) %}
+{%- for message in messages[::-1] %}
+    {%- set index = (messages|length - 1) - loop.index0 %}
+    {%- if ns.multi_step_tool and message.role == "user" and message.content is string and not(message.content.startswith('<tool_response>') and message.content.endswith('</tool_response>')) %}
+        {%- set ns.multi_step_tool = false %}
+        {%- set ns.last_query_index = index %}
+    {%- endif %}
+{%- endfor %}
+{%- for message in messages %}
+    {%- if message.content is string %}
+        {%- set content = message.content %}
+    {%- else %}
+        {%- set content = '' %}
+    {%- endif %}
+    {%- if (message.role == "user") or (message.role == "system" and not loop.first) %}
+        {{- '<|im_start|>' + message.role + '\n' + content + '<|im_end|>' + '\n' }}
+    {%- elif message.role == "assistant" %}
+        {%- set reasoning_content = '' %}
+        {%- if message.reasoning_content is string %}
+            {%- set reasoning_content = message.reasoning_content %}
+        {%- else %}
+            {%- if '</think>' in content %}
+                {%- set reasoning_content = content.split('</think>')[0].rstrip('\n').split('<think>')[-1].lstrip('\n') %}
+                {%- set content = content.split('</think>')[-1].lstrip('\n') %}
+            {%- endif %}
+        {%- endif %}
+        {%- if loop.index0 > ns.last_query_index %}
+            {%- if loop.last or (not loop.last and reasoning_content) %}
+                {{- '<|im_start|>' + message.role + '\n<think>\n' + reasoning_content.strip('\n') + '\n</think>\n\n' + content.lstrip('\n') }}
+            {%- else %}
+                {{- '<|im_start|>' + message.role + '\n' + content }}
+            {%- endif %}
+        {%- else %}
+            {{- '<|im_start|>' + message.role + '\n' + content }}
+        {%- endif %}
+        {%- if message.tool_calls %}
+            {%- for tool_call in message.tool_calls %}
+                {%- if (loop.first and content) or (not loop.first) %}
+                    {{- '\n' }}
+                {%- endif %}
+                {%- if tool_call.function %}
+                    {%- set tool_call = tool_call.function %}
+                {%- endif %}
+                {{- '<tool_call>\n{"name": "' }}
+                {{- tool_call.name }}
+                {{- '", "arguments": ' }}
+                {%- if tool_call.arguments is string %}
+                    {{- tool_call.arguments }}
+                {%- else %}
+                    {{- tool_call.arguments | tojson }}
+                {%- endif %}
+                {{- '}\n</tool_call>' }}
+            {%- endfor %}
+        {%- endif %}
+        {{- '<|im_end|>\n' }}
+    {%- elif message.role == "tool" %}
+        {%- if loop.first or (messages[loop.index0 - 1].role != "tool") %}
+            {{- '<|im_start|>user' }}
+        {%- endif %}
+        {{- '\n<tool_response>\n' }}
+        {{- content }}
+        {{- '\n</tool_response>' }}
+        {%- if loop.last or (messages[loop.index0 + 1].role != "tool") %}
+            {{- '<|im_end|>\n' }}
+        {%- endif %}
+    {%- endif %}
+{%- endfor %}
+{%- if add_generation_prompt %}
+    {{- '<|im_start|>assistant\n<think>\n' }}
+{%- endif %}

docs/chat-template/Qwen3-235B-A22B/chat_template.jinja

@@ -0,0 +1,89 @@
+{%- if tools %}
+    {{- '<|im_start|>system\n' }}
+    {%- if messages[0].role == 'system' %}
+        {{- messages[0].content + '\n\n' }}
+    {%- endif %}
+    {{- "# Tools\n\nYou may call one or more functions to assist with the user query.\n\nYou are provided with function signatures within <tools></tools> XML tags:\n<tools>" }}
+    {%- for tool in tools %}
+        {{- "\n" }}
+        {{- tool | tojson }}
+    {%- endfor %}
+    {{- "\n</tools>\n\nFor each function call, return a json object with function name and arguments within <tool_call></tool_call> XML tags:\n<tool_call>\n{\"name\": <function-name>, \"arguments\": <args-json-object>}\n</tool_call><|im_end|>\n" }}
+{%- else %}
+    {%- if messages[0].role == 'system' %}
+        {{- '<|im_start|>system\n' + messages[0].content + '<|im_end|>\n' }}
+    {%- endif %}
+{%- endif %}
+{%- set ns = namespace(multi_step_tool=true, last_query_index=messages|length - 1) %}
+{%- for message in messages[::-1] %}
+    {%- set index = (messages|length - 1) - loop.index0 %}
+    {%- if ns.multi_step_tool and message.role == "user" and message.content is string and not(message.content.startswith('<tool_response>') and message.content.endswith('</tool_response>')) %}
+        {%- set ns.multi_step_tool = false %}
+        {%- set ns.last_query_index = index %}
+    {%- endif %}
+{%- endfor %}
+{%- for message in messages %}
+    {%- if message.content is string %}
+        {%- set content = message.content %}
+    {%- else %}
+        {%- set content = '' %}
+    {%- endif %}
+    {%- if (message.role == "user") or (message.role == "system" and not loop.first) %}
+        {{- '<|im_start|>' + message.role + '\n' + content + '<|im_end|>' + '\n' }}
+    {%- elif message.role == "assistant" %}
+        {%- set reasoning_content = '' %}
+        {%- if message.reasoning_content is string %}
+            {%- set reasoning_content = message.reasoning_content %}
+        {%- else %}
+            {%- if '</think>' in content %}
+                {%- set reasoning_content = content.split('</think>')[0].rstrip('\n').split('<think>')[-1].lstrip('\n') %}
+                {%- set content = content.split('</think>')[-1].lstrip('\n') %}
+            {%- endif %}
+        {%- endif %}
+        {%- if loop.index0 > ns.last_query_index %}
+            {%- if loop.last or (not loop.last and reasoning_content) %}
+                {{- '<|im_start|>' + message.role + '\n<think>\n' + reasoning_content.strip('\n') + '\n</think>\n\n' + content.lstrip('\n') }}
+            {%- else %}
+                {{- '<|im_start|>' + message.role + '\n' + content }}
+            {%- endif %}
+        {%- else %}
+            {{- '<|im_start|>' + message.role + '\n' + content }}
+        {%- endif %}
+        {%- if message.tool_calls %}
+            {%- for tool_call in message.tool_calls %}
+                {%- if (loop.first and content) or (not loop.first) %}
+                    {{- '\n' }}
+                {%- endif %}
+                {%- if tool_call.function %}
+                    {%- set tool_call = tool_call.function %}
+                {%- endif %}
+                {{- '<tool_call>\n{"name": "' }}
+                {{- tool_call.name }}
+                {{- '", "arguments": ' }}
+                {%- if tool_call.arguments is string %}
+                    {{- tool_call.arguments }}
+                {%- else %}
+                    {{- tool_call.arguments | tojson }}
+                {%- endif %}
+                {{- '}\n</tool_call>' }}
+            {%- endfor %}
+        {%- endif %}
+        {{- '<|im_end|>\n' }}
+    {%- elif message.role == "tool" %}
+        {%- if loop.first or (messages[loop.index0 - 1].role != "tool") %}
+            {{- '<|im_start|>user' }}
+        {%- endif %}
+        {{- '\n<tool_response>\n' }}
+        {{- content }}
+        {{- '\n</tool_response>' }}
+        {%- if loop.last or (messages[loop.index0 + 1].role != "tool") %}
+            {{- '<|im_end|>\n' }}
+        {%- endif %}
+    {%- endif %}
+{%- endfor %}
+{%- if add_generation_prompt %}
+    {{- '<|im_start|>assistant\n' }}
+    {%- if enable_thinking is defined and enable_thinking is false %}
+        {{- '<think>\n\n</think>\n\n' }}
+    {%- endif %}
+{%- endif %}

docs/chat-template/Qwen3-235B-A22B/enable_thinking.py

@@ -0,0 +1,24 @@
+from transformers import AutoTokenizer
+
+
+MODEL_PATH = "Qwen/Qwen3-235B-A22B"
+
+
+tokenizer = AutoTokenizer.from_pretrained(MODEL_PATH)
+
+
+messages = [
+  {"role": "system", "content": "You are a bot that responds to weather queries."},
+  {"role": "user", "content": "Hey, what's the temperature in Paris right now?"},
+  {"role": "assistant", "content": "2"},
+  {"role": "user", "content": "3"},
+]
+
+prompt = tokenizer.apply_chat_template(
+    conversation=messages,
+    tokenize=False,
+    enable_thinking=False,  # enable_thinking 默认是True
+    add_generation_prompt=True,
+)
+
+print(prompt)

docs/chat-template/export_chat_template.py

@@ -9,11 +9,13 @@ from transformers import AutoTokenizer
 # MODEL_PATH = "../../test/Llama-4-Maverick-17B-128E-Instruct"
 # MODEL_PATH = "meta-llama/Llama-4-Maverick-17B-128E-Instruct"
 # MODEL_PATH = "Qwen/Qwen3-235B-A22B-Instruct-2507"
+# MODEL_PATH = "Qwen/Qwen3-235B-A22B-Thinking-2507"
+MODEL_PATH = "Qwen/Qwen3-235B-A22B"
 # MODEL_PATH = "mistralai/Mistral-7B-Instruct-v0.1"  # messages里不支持tool_calls，不支持 role=tool，不支持 tools
 # MODEL_PATH = "mistralai/Ministral-8B-Instruct-2410" # 支持 tools, 支持tool_calls(必须要有id), 格式非主流
 # MODEL_PATH = "deepseek-ai/DeepSeek-R1"
 # MODEL_PATH = "deepseek-ai/DeepSeek-R1-0528"
-MODEL_PATH = 'deepseek-ai/DeepSeek-V3.1'
+# MODEL_PATH = 'deepseek-ai/DeepSeek-V3.1'
 # MODEL_PATH = "google/gemma-3-27b-it" 
 
 

docs/chat-template/{tool_call_and_tool_response.md → tool_call_and_tool_result.md}

@@ -1,9 +1,20 @@
+---
+title: 工具调用（tool_call） 与 工具结果 tool_response
+---
+
+- [简介](#简介)
+- [messages](#messages)
+- [llama3.1-405b](#llama31-405b)
+- [Hermes-3-Llama-3.1-405B](#hermes-3-llama-31-405b)
+- [Qwen3](#qwen3)
+- [参考](#参考)
+
 
 ## 简介
 
 
-- `tool_calls`:
-- `tool_response`:
+1. `tool_calls`: 调用工具的入参
+2. `tool_response`: 调用工具的结果，也叫 `tool_result`
 
 
 

docs/chat-template/tool_demo.py

@@ -17,15 +17,18 @@ from transformers.utils import get_json_schema
 
 
 # MODEL_PATH = "meta-llama/Llama-3.1-405B-Instruct"
-MODEL_PATH = "NousResearch/Hermes-3-Llama-3.1-405B"  # messages里的tool_calls必须要有content字段
+# MODEL_PATH = "NousResearch/Hermes-3-Llama-3.1-405B"  # messages里的tool_calls必须要有content字段
 # MODEL_PATH = "../../test/Llama-4-Maverick-17B-128E-Instruct/"
 # MODEL_PATH = "meta-llama/Llama-4-Maverick-17B-128E-Instruct"
 # MODEL_PATH = "Qwen/Qwen3-235B-A22B-Instruct-2507"
 # MODEL_PATH = "mistralai/Mistral-7B-Instruct-v0.1"  # messages里不支持tool_calls，不支持 role=tool，不支持 tools
 # MODEL_PATH = "mistralai/Ministral-8B-Instruct-2410" # 支持 tools, 支持tool_calls(必须要有id), 格式非主流
 # MODEL_PATH = "deepseek-ai/DeepSeek-R1"  # 不支持tools，tool_calls也有问题
+# MODEL_PATH = "deepseek-ai/DeepSeek-V3.1"
 # MODEL_PATH = "google/gemma-3-27b-it"  # 不支持任何tool
 # MODEL_PATH = "moonshotai/Kimi-K2-Instruct"
+MODEL_PATH = "xai-org/grok-2"
+
 tokenizer = AutoTokenizer.from_pretrained(MODEL_PATH)
 
 # First, define a tool

docs/chat-template/tools_and_llm_response.md

@@ -3,7 +3,8 @@ title: 支持的工具列表 & llm返回的工具调用
 ---
 
 
-- [LLM入参 = 工具列表](#llm入参--工具列表)
+- [tools调用](#tools调用)
+- [LLM入参 = messages + tools](#llm入参--messages--tools)
 - [LLM出参 = 工具名 + 参数](#llm出参--工具名--参数)
 - [LLM入参示例：messages and tools](#llm入参示例messages-and-tools)
 - [LLM入参示例：转化为 prompt 字符串](#llm入参示例转化为-prompt-字符串)
@@ -12,12 +13,30 @@ title: 支持的工具列表 & llm返回的工具调用
   - [llama4 ⭐️⭐️⭐️](#llama4-️️️)
   - [mistralai/Ministral-8B-Instruct-2410](#mistralaiministral-8b-instruct-2410)
   - [qwen3 ⭐️⭐️⭐️⭐️⭐️](#qwen3-️️️️️)
-  - [deepseek-r1](#deepseek-r1)
-  - [deepseek-v3.1](#deepseek-v31)
+  - [deepseek-r1 ⭐️⭐️](#deepseek-r1-️️)
+  - [deepseek-v3.1 ⭐️⭐️](#deepseek-v31-️️)
+  - [gemma-3-27b-it ⭐️](#gemma-3-27b-it-️)
+  - [grok-2 ⭐️](#grok-2-️)
 
+## tools调用
 
 
-## LLM入参 = 工具列表
+```py
+# openai chat api
+    completion = client.chat.completions.create(
+        model=model_name,
+        messages=messages,
+        tools=tools,          # tool list defined above
+        tool_choice="auto"
+    )
+# open response api
+
+```
+
+
+## LLM入参 = messages + tools
+
+tools是支持的工具列表
 
 一般都是json格式，也有非json格式
 
@@ -224,6 +243,7 @@ Hey, what's the temperature in Paris right now?<|eot|><|header_start|>assistant<
 
 跟 llama3.1差不多，只是少了`date`，并且换了`special_token`。(同样拼在第一个user轮)
 
+- **评价**: 同 llama3.1
 - **推荐指数**: ⭐️⭐️⭐️
 
 
@@ -273,7 +293,27 @@ Hey, what's the temperature in Paris right now?<|im_end|>
 - **推荐指数**: ⭐️⭐️⭐️⭐️⭐️
 
 
-### deepseek-r1
+### deepseek-r1 ⭐️⭐️
+
+
+```sh
+<｜begin▁of▁sentence｜>You are a bot that responds to weather queries.<｜User｜>Hey, what's the temperature in Paris right now?<｜Assistant｜><think>
+```
+
+- **评价**: 
+  - 扣分项: 不支持tools，tool_calls也有问题
+- **推荐指数**: ⭐️⭐️
+
+
+### deepseek-v3.1 ⭐️⭐️
+
+与 deepseek-r1 一样
+
+
+### gemma-3-27b-it ⭐️
+
+不支持任何tool
 
-### deepseek-v3.1
+### grok-2 ⭐️
 
+不支持任何tool