Share via


RunStepToolCall Class

Definition

An abstract representation of a detailed tool call as recorded within a run step for an existing run. Please note RunStepToolCall 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 RunStepAzureAISearchToolCall, RunStepBingGroundingToolCall, RunStepCodeInterpreterToolCall, RunStepFileSearchToolCall, RunStepFunctionToolCall, RunStepMicrosoftFabricToolCall and RunStepSharepointToolCall.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.UnknownRunStepToolCall))]
public abstract class RunStepToolCall : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.RunStepToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.RunStepToolCall>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.UnknownRunStepToolCall))>]
type RunStepToolCall = class
    interface IJsonModel<RunStepToolCall>
    interface IPersistableModel<RunStepToolCall>
Public MustInherit Class RunStepToolCall
Implements IJsonModel(Of RunStepToolCall), IPersistableModel(Of RunStepToolCall)
Inheritance
RunStepToolCall
Derived
Attributes
Implements

Constructors

RunStepToolCall(String)

Initializes a new instance of RunStepToolCall.

Properties

Id

The ID of the tool call. This ID must be referenced when you submit tool outputs.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<RunStepToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<RunStepToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<RunStepToolCall>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<RunStepToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<RunStepToolCall>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to