RequiredToolCall Class

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Source:

RequiredToolCall.cs

An abstract, base representation for a tool call that an Assistants API run requires outputs from in order to continue.

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

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

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

Inheritance

Object

RequiredAction

RequiredToolCall

Derived

Azure.AI.Projects.RequiredFunctionToolCall

Attributes

PersistableModelProxyAttribute

Implements

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

Remarks

RequiredToolCall is the abstract base type for all required tool calls. Its concrete type can be one of:

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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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