Document tool_call_format API options

#2
Files changed (1) hide show
  1. README.md +3 -1
README.md CHANGED
@@ -91,13 +91,15 @@ response = client.chat.completions.create(
91
  temperature=1.0,
92
  top_p=0.95,
93
  max_tokens=32768,
94
- extra_body={"chat_template_kwargs": {"reasoning_effort": "high"}},
95
  )
96
  message = response.choices[0].message
97
  print("Reasoning:", getattr(message, "reasoning_content", None))
98
  print("Answer:", message.content)
99
  ```
100
 
 
 
101
  ### Transformers
102
 
103
  Validated with Transformers 5.15.0, PyTorch 2.13.0, Safetensors 0.8.0.
 
91
  temperature=1.0,
92
  top_p=0.95,
93
  max_tokens=32768,
94
+ extra_body={"chat_template_kwargs": {"reasoning_effort": "high", "tool_call_format": "xml"}},
95
  )
96
  message = response.choices[0].message
97
  print("Reasoning:", getattr(message, "reasoning_content", None))
98
  print("Answer:", message.content)
99
  ```
100
 
101
+ Our model supports multiple tool calls formats, which can be changed with `chat_template_kwargs`. The supported values are `json`, `xml`, and `xml_typed` . The default is `xml`. Keep `--tool-call-parser k2_horizon` enabled to parse the selected format.
102
+
103
  ### Transformers
104
 
105
  Validated with Transformers 5.15.0, PyTorch 2.13.0, Safetensors 0.8.0.