Share via

StreamingToolCallUpdate.Id Property

  • Reference

Definition

Namespace:
Azure.AI.OpenAI
Assembly:
Azure.AI.OpenAI.dll
Package:
Azure.AI.OpenAI v1.0.0-beta.17
Source:
StreamingToolCallUpdate.cs

Gets the ID associated with with the streaming tool call.

public string Id { get; }
member this.Id : string
Public ReadOnly Property Id As String

Property Value

String

Remarks

Corresponds to e.g. $.choices[0].delta.tool_calls[0].id in the REST API schema.

This value appears once for each streaming tool call, typically on the first update message for each ToolCallIndex. Callers should retain the value when it arrives to accumulate the complete tool call information.

Tool call IDs must be provided in ChatRequestToolMessage instances that respond to tool calls.

Applies to