RunStepDeltaToolCall Class

Reference

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

Package:: Azure.AI.Projects v1.0.0-beta.1

Source:: RunStepDeltaToolCall.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The abstract base representation of a single tool call within a streaming run step's delta tool call details. Please note RunStepDeltaToolCall 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 RunStepDeltaCodeInterpreterToolCall, RunStepDeltaFileSearchToolCall and RunStepDeltaFunctionToolCall.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.UnknownRunStepDeltaToolCall))]
public abstract class RunStepDeltaToolCall : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.RunStepDeltaToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.RunStepDeltaToolCall>

[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.UnknownRunStepDeltaToolCall))>]
type RunStepDeltaToolCall = class
    interface IJsonModel<RunStepDeltaToolCall>
    interface IPersistableModel<RunStepDeltaToolCall>

Public MustInherit Class RunStepDeltaToolCall
Implements IJsonModel(Of RunStepDeltaToolCall), IPersistableModel(Of RunStepDeltaToolCall)

Inheritance: Object
RunStepDeltaToolCall

Derived: Azure.AI.Projects.RunStepDeltaCodeInterpreterToolCall

Azure.AI.Projects.RunStepDeltaFileSearchToolCall

Azure.AI.Projects.RunStepDeltaFunctionToolCall

Attributes: PersistableModelProxyAttribute

Implements: IJsonModel<RunStepDeltaToolCall> IPersistableModel<RunStepDeltaToolCall> IPersistableModel<T>

Constructors

RunStepDeltaToolCall(Int32, String)

Initializes a new instance of RunStepDeltaToolCall.

Fields

SerializedAdditionalRawData

Keeps track of any properties unknown to the library.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
BinaryData.FromString("\"foo\""): Creates a payload of "foo".
BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

Properties

Id	The ID of the tool call, used when submitting outputs to the run.
Index	The index of the tool call detail in the run step's tool_calls array.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<RunStepDeltaToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<RunStepDeltaToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<RunStepDeltaToolCall>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<RunStepDeltaToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<RunStepDeltaToolCall>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Share via