StreamingToolCallUpdate Class

Definition

Namespace:

Azure.AI.Inference

Assembly:

Azure.AI.Inference.dll

Package:

Azure.AI.Inference v1.0.0-beta.2

Source:

StreamingToolCallUpdate.cs

Represents an incremental update to a streaming tool call that is part of a streaming chat completions choice.

public abstract class StreamingToolCallUpdate

type StreamingToolCallUpdate = class

Public MustInherit Class StreamingToolCallUpdate

Inheritance

Object

StreamingToolCallUpdate

Derived

Azure.AI.Inference.StreamingFunctionToolCallUpdate

Remarks

This type encapsulates the payload located in e.g. $.choices[0].delta.tool_calls[] in the REST API schema.

To differentiate between parallel streaming tool calls within a single streaming choice, use the value of the ToolCallIndex property.

Please note StreamingToolCallUpdate is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include: StreamingFunctionToolCallUpdate.

Properties

Id	Gets the ID associated with with the streaming tool call.
ToolCallIndex	Gets the tool call index associated with this StreamingToolCallUpdate.