Update README.md

README.md

@@ -209,7 +209,7 @@ ChatCompletionMessage(
 
 ## Tool Planning Examples <a name="examples"></a>
 
-The model is using *grounded system prompt* for tool planning. <u>We do not recommend changing it too much, as this may cause hallucinations!</u>
+The model is using ***grounded system prompt*** for tool planning. <u>We do not recommend changing it too much, as this may cause hallucinations!</u>
 
 ```
 <|im_start|>system
@@ -251,28 +251,464 @@ Each tool is represented as a JSON object with fields like "name", "description"
 ```
 *For corrected display used [\ \`] instead of [\`]*
 
+**About the structure of prompt:**
+- This model always will answer with new tokens: `<|start_response|>`...*text from model*...`<|end_response|>`. This content is the main one for user and it contains in `assistant` in `content` field.
+- This model always starts <u>*thinking*</u> before tool calls with new tokens: `<|start_thinking|>`...*thinking*...<|end_thinking|>. It contains in `assistant` in `tool_plan` field.
+- After <u>*thinking*</u> model starts generate tool calls (function calling) with Qwen2.5 tokens (it can be a multiple/parallel calling too):
+```
+<tool_call>[
+  {"tool_call_id": "...", "tool_name": "...", "parameters": {...}},
+  {"tool_call_id": "...", "tool_name": "...", "parameters": {...}},
+  ...
+]</tool_call><|im_end|> 
+```
+`tool_call_id` is local tool id.
+`tool_name` is name of tool(function) calling.
+It contains in `assistant` in 'tool_calls' field.
+
+- Responses from tools are located between `<tool_response>`...*all last locals tools*...`</tool_response>`. Every local tool contains separately in specific role `tool`:
+```python
+{
+    "role": "tool", 
+    "tool_call_id": "0",  # MUST BE matches with the corresponding call above.
+    "content": { "tool_name_1_returns": ... }  # MUST BE dict with key "tool_name" + "_returns"
+},
+{
+    "role": "tool", 
+    "tool_call_id": "1",  # MUST BE matches with the corresponding call above.
+    "content": { "tool_name_1_returns": ... }
+},
+{
+    "role": "tool", 
+    "tool_call_id": "2",  # MUST BE matches with the corresponding call above.
+    "content": { "tool_name_2_returns": ... },
+    "is_error_tool": True  # You can add it if your tool is corrupted. But then you must provide error description in content.
+}
+```
+Local tool ids mean that ids must match only in one pair *tool call* and *tool response*, next *tool call* must reset the counter and start from 0 again.
+
 ### Simple Function
 
+*history*
 ```python
+messages = [
+  {"role": "user", "content": "Hey dude, what can you do?"},
+  {"role": "assistant", "content": "I can retrieve a list of unpaid invoices and process payments for specific invoices."},
+  {"role": "user", "content": "Okey, then retrieve a list for me"},
+  {
+      "role": "assistant",
+      "tool_plan": "I will retrieve a list of unpaid invoices.",
+      "tool_calls": [ 
+          {
+              "id": "0",
+              "type": "function",
+              "function": {
+                  "name": "find_unpaid_invoices",
+                  "arguments": {}
+              }
+          }
+      ]
+  },
+  {
+      "role": "tool", 
+      "tool_call_id": "0",
+      "content": { "find_unpaid_invoices_returns": ["Utility Debts", "Housing and Utilities Arrears"]}
+  },
+  {"role": "assistant", "content": "Here is the list of unpaid invoices: Utility Debts and Housing and Utilities Arrears."},
+  {"role": "user", "content": "Ooh, I forget about this! Lets pay Utility Debts in the amount of $100 please"},
+  {
+      "role": "assistant",
+      "tool_plan": "I will process the payment for the Utility Debts invoice.",
+      "tool_calls": [
+          {
+              "id": "0",
+              "type": "function",
+              "function": {
+                  "name": "pay_invoice",
+                  "arguments": {"invoice_id": "Utility Debts", "amount": 100}
+              }
+          }
+      ]
+  },
+  {
+      "role": "tool", 
+      "tool_call_id": "0",
+      "content": { "pay_invoice_returns": "Success"}
+  },
+]
+```
+
+*prompt with generation*
+```
+<|im_start|>system
+...grounded_system_prompt...
 
+<|im_end|>
+<|im_start|>user
+Hey dude, what can you do?<|im_end|>
+<|im_start|>assistant
+<|start_response|>I can retrieve a list of unpaid invoices and process payments for specific invoices.<|end_response|><|im_end|>
+<|im_start|>user
+Okey, then retrieve a list for me<|im_end|>
+<|im_start|>assistant
+<|start_thinking|>I will retrieve a list of unpaid invoices.<|end_thinking|><tool_call>[
+    {"tool_call_id": "0", "tool_name": "find_unpaid_invoices", "parameters": {}}
+]</tool_call><|im_end|>
+<|im_start|>system
+<tool_response>[
+    {
+        "tool_call_id": "0",
+        "results": {
+            "0": {"find_unpaid_invoices_returns": ["Utility Debts", "Housing and Utilities Arrears"]}
+        },
+        "is_error_tool": False
+    }
+]</tool_response><|im_end|>
+<|im_start|>assistant
+<|start_response|>Here is the list of unpaid invoices: Utility Debts and Housing and Utilities Arrears.<|end_response|><|im_end|>
+<|im_start|>user
+Ooh, I forget about this! Lets pay Utility Debts in the amount of $100 please<|im_end|>
+<|im_start|>assistant
+<|start_thinking|>I will process the payment for the Utility Debts invoice.<|end_thinking|><tool_call>[
+    {"tool_call_id": "0", "tool_name": "pay_invoice", "parameters": {"invoice_id": "Utility Debts", "amount": 100}}
+]</tool_call><|im_end|>
+<|im_start|>system
+<tool_response>[
+    {
+        "tool_call_id": "0",
+        "results": {
+            "0": {"pay_invoice_returns": "Success"}
+        },
+        "is_error_tool": False
+    }
+]</tool_response><|im_end|>
+<|im_start|>assistant
+<|start_response|>The payment for the Utility Debts invoice has been processed successfully.<|end_response|><|im_end|>
 ```
 
 ### Multiple Function
 
+*history*
 ```python
+messages = [
+  {"role": "user", "content": "Hey dude, what can you do?"},
+  {"role": "assistant", "content": "I can provide weather information for a given city and also provide the sunrise and sunset times for a given city."},
+  {"role": "user", "content": "Thats great! Okey, can you provide weather in Krasnodar, Moscow and Krasnoyarsk for me please."},
+  {
+      "role": "assistant",
+      "tool_plan": "The user wants weather information for three cities: Krasnodar, Moscow, and Krasnoyarsk.",
+      "tool_calls": [ 
+          {
+              "id": "0",
+              "type": "function",
+              "function": {
+                  "name": "get_weather",
+                  "arguments": {
+                      "city": "Krasnodar"
+                  }
+              }
+          },
+          {
+              "id": "1",
+              "type": "function",
+              "function": {
+                  "name": "get_weather",
+                  "arguments": {
+                      "city": "Moscow"
+                  }
+              }
+          },
+          {
+              "id": "2",
+              "type": "function",
+              "function": {
+                  "name": "get_weather",
+                  "arguments": {
+                      "city": "Krasnoyarsk"
+                  }
+              }
+          },
+      ]
+  },
+  {
+      "role": "tool", 
+      "tool_call_id": "0",
+      "content": { "get_weather_returns": "sunny" }
+  },
+  {
+      "role": "tool", 
+      "tool_call_id": "1",
+      "content": { "get_weather_returns": "sunny" }
+  },
+  {
+      "role": "tool", 
+      "tool_call_id": "2",
+      "content": { "get_weather_returns": "rainy" }
+  },
+] 
+```
 
+*prompt with generation*
+```
+<|im_start|>system
+...grounded_system_prompt...
+
+<|im_end|>
+<|im_start|>user
+Hey dude, what can you do?<|im_end|>
+<|im_start|>assistant
+<|start_response|>I can provide weather information for a given city and also provide the sunrise and sunset times for a given city.<|end_response|><|im_end|>
+<|im_start|>user
+Thats great! Okey, can you provide weather in Krasnodar, Moscow and Krasnoyarsk for me please.<|im_end|>
+<|im_start|>assistant
+<|start_thinking|>The user wants weather information for three cities: Krasnodar, Moscow, and Krasnoyarsk.<|end_thinking|><tool_call>[
+    {"tool_call_id": "0", "tool_name": "get_weather", "parameters": {"city": "Krasnodar"}},
+    {"tool_call_id": "1", "tool_name": "get_weather", "parameters": {"city": "Moscow"}},
+    {"tool_call_id": "2", "tool_name": "get_weather", "parameters": {"city": "Krasnoyarsk"}}
+]</tool_call><|im_end|>
+<|im_start|>system
+<tool_response>[
+    {
+        "tool_call_id": "0",
+        "results": {
+            "0": {"get_weather_returns": "sunny"}
+        },
+        "is_error_tool": False
+    },
+    {
+        "tool_call_id": "1",
+        "results": {
+            "0": {"get_weather_returns": "sunny"}
+        },
+        "is_error_tool": False
+    },
+    {
+        "tool_call_id": "2",
+        "results": {
+            "0": {"get_weather_returns": "rainy"}
+        },
+        "is_error_tool": False
+    }
+]</tool_response><|im_end|>
+<|im_start|>assistant
+<|start_response|>The weather in Krasnodar is sunny, the weather in Moscow is sunny, and the weather in Krasnoyarsk is rainy.<|end_response|><|im_end|>
 ```
 
 ### Parallel Multiple Function
 
+*history*
 ```python
+messages = [
+  {"role": "user", "content": "Hey dude, what can you do?"},
+  {"role": "assistant", "content": "I can provide weather information for a given city and also provide the sunrise and sunset times for a given city."},
+  {"role": "user", "content": "Thats great! Okey, can you provide weather in Krasnodar, Moscow and only the sunrise time in Krasnoyarsk for me please."},
+  {
+      "role": "assistant",
+      "tool_plan": "The user has requested weather information for three cities and only the sunrise time for one city. I will first retrieve the weather information for Krasnodar and Moscow, and then retrieve the sunrise time for Krasnoyarsk.",
+      "tool_calls": [ 
+          {
+              "id": "0",
+              "type": "function",
+              "function": {
+                  "name": "get_weather",
+                  "arguments": {
+                      "city": "Krasnodar"
+                  }
+              }
+          },
+          {
+              "id": "1",
+              "type": "function",
+              "function": {
+                  "name": "get_weather",
+                  "arguments": {
+                      "city": "Moscow"
+                  }
+              }
+          },
+          {
+              "id": "2",
+              "type": "function",
+              "function": {
+                  "name": "get_sunrise_sunset_times",
+                  "arguments": {
+                      "city": "Krasnoyarsk"
+                  }
+              }
+          },
+      ]
+  },
+  {
+      "role": "tool", 
+      "tool_call_id": "0",
+      "content": { "get_weather_returns": "sunny" }
+  },
+  {
+      "role": "tool", 
+      "tool_call_id": "1",
+      "content": { "get_weather_returns": "sunny" }
+  },
+  {
+      "role": "tool", 
+      "tool_call_id": "2",
+      "content": { "get_sunrise_sunset_times_returns": ["6:00 AM", "6:00 PM"] }
+  },
+] 
+```
 
+*prompt with generation*
+```
+<|im_start|>system
+...grounded_system_prompt...
+
+<|im_end|>
+<|im_start|>user
+Hey dude, what can you do?<|im_end|>
+<|im_start|>assistant
+<|start_response|>I can provide weather information for a given city and also provide the sunrise and sunset times for a given city.<|end_response|><|im_end|>
+<|im_start|>user
+Thats great! Okey, can you provide weather in Krasnodar, Moscow and only the sunrise time in Krasnoyarsk for me please.<|im_end|>
+<|im_start|>assistant
+<|start_thinking|>The user has requested weather information for three cities and only the sunrise time for one city. I will first retrieve the weather information for Krasnodar and Moscow, and then retrieve the sunrise time for Krasnoyarsk.<|end_thinking|><tool_call>[
+    {"tool_call_id": "0", "tool_name": "get_weather", "parameters": {"city": "Krasnodar"}},
+    {"tool_call_id": "1", "tool_name": "get_weather", "parameters": {"city": "Moscow"}},
+    {"tool_call_id": "2", "tool_name": "get_sunrise_sunset_times", "parameters": {"city": "Krasnoyarsk"}}
+]</tool_call><|im_end|>
+<|im_start|>system
+<tool_response>[
+    {
+        "tool_call_id": "0",
+        "results": {
+            "0": {"get_weather_returns": "sunny"}
+        },
+        "is_error_tool": False
+    },
+    {
+        "tool_call_id": "1",
+        "results": {
+            "0": {"get_weather_returns": "sunny"}
+        },
+        "is_error_tool": False
+    },
+    {
+        "tool_call_id": "2",
+        "results": {
+            "0": {"get_sunrise_sunset_times_returns": ["6:00 AM", "6:00 PM"]}
+        },
+        "is_error_tool": False
+    }
+]</tool_response><|im_end|>
+<|im_start|>assistant
+<|start_response|>The weather in Krasnodar is sunny, the weather in Moscow is sunny, and the sunrise time in Krasnoyarsk is 6:00 AM.<|end_response|><|im_end|>
 ```
 
 ### Tool Error Handling
 
+*history*
 ```python
+messages = [
+  {"role": "user", "content": "Hey dude, what can you do?"},
+  {"role": "assistant", "content": "I can provide weather information for a given city and also provide the sunrise and sunset times for a given city."},
+  {"role": "user", "content": "Thats great! Okey, can you provide weather in Krasnodar, Moscow and only the sunrise time in Krasnoyarsk for me please."},
+  {
+      "role": "assistant",
+      "tool_plan": "The user has requested weather information for three cities and only the sunrise time for one city. I will first retrieve the weather information for Krasnodar and Moscow, and then retrieve the sunrise time for Krasnoyarsk.",
+      "tool_calls": [ 
+          {
+              "id": "0",
+              "type": "function",
+              "function": {
+                  "name": "get_weather",
+                  "arguments": {
+                      "city": "Krasnodar"
+                  }
+              }
+          },
+          {
+              "id": "1",
+              "type": "function",
+              "function": {
+                  "name": "get_weather",
+                  "arguments": {
+                      "city": "Moscow"
+                  }
+              }
+          },
+          {
+              "id": "2",
+              "type": "function",
+              "function": {
+                  "name": "get_sunrise_sunset_times",
+                  "arguments": {
+                      "city": "Krasnoyarsk"
+                  }
+              }
+          },
+      ]
+  },
+  {
+      "role": "tool", 
+      "tool_call_id": "0",
+      "content": { "get_weather_returns": "sunny" }
+  },
+  {
+      "role": "tool", 
+      "tool_call_id": "1",
+      "content": { "get_weather_returns": "sunny" }
+  },
+  {
+      "role": "tool", 
+      "tool_call_id": "2",
+      "content": { "get_sunrise_sunset_times_returns": {"error": True, "message": "Server is unavailable now"} },
+      "is_error_tool": True
+  },
+] 
+```
 
+*prompt with generation*
+```
+<|im_start|>system
+...grounded_system_prompt...
+
+<|im_end|>
+<|im_start|>user
+Hey dude, what can you do?<|im_end|>
+<|im_start|>assistant
+<|start_response|>I can provide weather information for a given city and also provide the sunrise and sunset times for a given city.<|end_response|><|im_end|>
+<|im_start|>user
+Thats great! Okey, can you provide weather in Krasnodar, Moscow and only the sunrise time in Krasnoyarsk for me please.<|im_end|>
+<|im_start|>assistant
+<|start_thinking|>The user has requested weather information for three cities and only the sunrise time for one city. I will first retrieve the weather information for Krasnodar and Moscow, and then retrieve the sunrise time for Krasnoyarsk.<|end_thinking|><tool_call>[
+    {"tool_call_id": "0", "tool_name": "get_weather", "parameters": {"city": "Krasnodar"}},
+    {"tool_call_id": "1", "tool_name": "get_weather", "parameters": {"city": "Moscow"}},
+    {"tool_call_id": "2", "tool_name": "get_sunrise_sunset_times", "parameters": {"city": "Krasnoyarsk"}}
+]</tool_call><|im_end|>
+<|im_start|>system
+<tool_response>[
+    {
+        "tool_call_id": "0",
+        "results": {
+            "0": {"get_weather_returns": "sunny"}
+        },
+        "is_error_tool": False
+    },
+    {
+        "tool_call_id": "1",
+        "results": {
+            "0": {"get_weather_returns": "sunny"}
+        },
+        "is_error_tool": False
+    },
+    {
+        "tool_call_id": "2",
+        "results": {
+            "0": {"get_sunrise_sunset_times_returns": {"error": true, "message": "Server is unavailable now"}}
+        },
+        "is_error_tool": True
+    }
+]</tool_response><|im_end|>
+<|im_start|>assistant
+<|start_response|>The weather in Krasnodar and Moscow is sunny. Unfortunately, the server is currently unavailable, so I cannot provide the sunrise time for Krasnoyarsk.<|end_response|><|im_end|>
 ```