Skip to content

Commit 9fc9bad

Browse files
Sync Haystack API reference on Docusaurus (#10020)
Co-authored-by: Amnah199 <[email protected]>
1 parent 071d2f1 commit 9fc9bad

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs-website/reference/haystack-api/data_classes_api.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,8 @@ Represents a Tool call prepared by the model, usually contained in an assistant
278278
- `id`: The ID of the Tool call.
279279
- `tool_name`: The name of the Tool to call.
280280
- `arguments`: The arguments to call the Tool with.
281+
- `extra`: Dictionary of extra information about the Tool call. Use to store provider-specific
282+
information. To avoid serialization issues, values should be JSON serializable.
281283

282284
<a id="chat_message.ToolCall.id"></a>
283285

@@ -297,7 +299,7 @@ Convert ToolCall into a dictionary.
297299

298300
**Returns**:
299301

300-
A dictionary with keys 'tool_name', 'arguments', and 'id'.
302+
A dictionary with keys 'tool_name', 'arguments', 'id', and 'extra'.
301303

302304
<a id="chat_message.ToolCall.from_dict"></a>
303305

@@ -1145,6 +1147,8 @@ Represents a Tool call prepared by the model, usually contained in an assistant
11451147
- `tool_name`: The name of the Tool to call.
11461148
- `arguments`: Either the full arguments in JSON format or a delta of the arguments.
11471149
- `id`: The ID of the Tool call.
1150+
- `extra`: Dictionary of extra information about the Tool call. Use to store provider-specific
1151+
information. To avoid serialization issues, values should be JSON serializable.
11481152

11491153
<a id="streaming_chunk.ToolCallDelta.id"></a>
11501154

@@ -1164,7 +1168,7 @@ Returns a dictionary representation of the ToolCallDelta.
11641168

11651169
**Returns**:
11661170

1167-
A dictionary with keys 'index', 'tool_name', 'arguments', and 'id'.
1171+
A dictionary with keys 'index', 'tool_name', 'arguments', 'id', and 'extra'.
11681172

11691173
<a id="streaming_chunk.ToolCallDelta.from_dict"></a>
11701174

0 commit comments

Comments
 (0)