ChatCompletionsToolDefinition Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

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

Source:

ChatCompletionsToolDefinition.cs

An abstract representation of a tool that can be used by the model to improve a chat completions response. Please note ChatCompletionsToolDefinition 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 ChatCompletionsFunctionToolDefinition.

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

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

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

Inheritance

Object

ChatCompletionsToolDefinition

Derived

Azure.AI.OpenAI.ChatCompletionsFunctionToolDefinition

Attributes

PersistableModelProxyAttribute

Implements

IJsonModel<ChatCompletionsToolDefinition> IPersistableModel<ChatCompletionsToolDefinition> IPersistableModel<T>

Constructors

ChatCompletionsToolDefinition()

Initializes a new instance of ChatCompletionsToolDefinition.

Explicit Interface Implementations

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