ChatCompletionsToolCall Class

Reference

Definition

Namespace:: Azure.AI.OpenAI

Assembly:: Azure.AI.OpenAI.dll

Package:: Azure.AI.OpenAI v1.0.0-beta.17

Source:: ChatCompletionsToolCall.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.

An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested chat completion. Please note ChatCompletionsToolCall 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 ChatCompletionsFunctionToolCall.

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

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

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

Inheritance: Object
ChatCompletionsToolCall

Derived: Azure.AI.OpenAI.ChatCompletionsFunctionToolCall

Attributes: PersistableModelProxyAttribute

Implements: IJsonModel<ChatCompletionsToolCall> IPersistableModel<ChatCompletionsToolCall> IPersistableModel<T>

Constructors

ChatCompletionsToolCall(String)

Initializes a new instance of ChatCompletionsToolCall.

Properties

Id	The ID of the tool call.

Explicit Interface Implementations

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

Applies to