RequiredToolCall Class

Definition

Namespace:

Azure.AI.OpenAI.Assistants

Assembly:

Azure.AI.OpenAI.Assistants.dll

Package:

Azure.AI.OpenAI.Assistants v1.0.0-beta.4

Source:

RequiredToolCall.cs

An abstract representation a a tool invocation needed by the model to continue a run. Please note RequiredToolCall 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 RequiredFunctionToolCall.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall))]
public abstract class RequiredToolCall : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.RequiredToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.RequiredToolCall>

[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.Assistants.UnknownRequiredToolCall))>]
type RequiredToolCall = class
    interface IJsonModel<RequiredToolCall>
    interface IPersistableModel<RequiredToolCall>

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

Inheritance

Object

RequiredToolCall

Derived

Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall

Attributes

PersistableModelProxyAttribute

Implements

IJsonModel<RequiredToolCall> IPersistableModel<RequiredToolCall> IPersistableModel<T>

Constructors

RequiredToolCall(String)

Initializes a new instance of RequiredToolCall.

Properties

Id	The ID of the tool call. This ID must be referenced when submitting tool outputs.

Explicit Interface Implementations

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