LiqunMa hanseungwook commited on
Commit
f3d9e54
·
1 Parent(s): 008d268

Document tool_call_format API options (#1)

Browse files

- Document tool_call_format API options (b1bcb1499ea9c030534310eeca8587b398a3bd8e)


Co-authored-by: Seungwook Han <hanseungwook@users.noreply.huggingface.co>

Files changed (1) hide show
  1. README.md +3 -1
README.md CHANGED
@@ -107,13 +107,15 @@ response = client.chat.completions.create(
107
  temperature=1.0,
108
  top_p=0.95,
109
  max_tokens=32768,
110
- extra_body={"chat_template_kwargs": {"reasoning_effort": "high"}},
111
  )
112
  message = response.choices[0].message
113
  print("Reasoning:", getattr(message, "reasoning_content", None))
114
  print("Answer:", message.content)
115
  ```
116
 
 
 
117
  ### Transformers
118
 
119
  Validated with Transformers 4.57.6, PyTorch 2.13.0, Safetensors 0.8.0.
 
107
  temperature=1.0,
108
  top_p=0.95,
109
  max_tokens=32768,
110
+ extra_body={"chat_template_kwargs": {"reasoning_effort": "high", "tool_call_format": "xml"}},
111
  )
112
  message = response.choices[0].message
113
  print("Reasoning:", getattr(message, "reasoning_content", None))
114
  print("Answer:", message.content)
115
  ```
116
 
117
+ 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.
118
+
119
  ### Transformers
120
 
121
  Validated with Transformers 4.57.6, PyTorch 2.13.0, Safetensors 0.8.0.