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.
Inheritance
System.Object
ChatCompletionsToolDefinition
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.AI.OpenAI.dll
Syntax
[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>Constructors
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.
Declaration
Azure.AI.OpenAI.ChatCompletionsToolDefinition IJsonModel<ChatCompletionsToolDefinition>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);Parameters
| System.Text.Json.Utf8JsonReader reader The System.Text.Json.Utf8JsonReader to read. |
| System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use. |
Returns
Exceptions
| System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format. |
IJsonModel<ChatCompletionsToolDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
Writes the model to the provided System.Text.Json.Utf8JsonWriter.
Declaration
void IJsonModel<ChatCompletionsToolDefinition>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);Parameters
| System.Text.Json.Utf8JsonWriter writer The System.Text.Json.Utf8JsonWriter to write into. |
| System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use. |
Exceptions
| System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format. |
IPersistableModel<ChatCompletionsToolDefinition>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ChatCompletionsToolDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ChatCompletionsToolDefinition>.Write(ModelReaderWriterOptions)
ncG1vNJzZmiZqqq%2Fpr%2FDpJuom6Njr627wWeaqKqVY8SqusOorqxmnprBcHDWnplonJ%2Bpu6bAjnqxrqqVY46Keq6pnKd5eWR%2Bb3yNaWSbnaSWe3KBjpqnomdxr8KzsY16gGeHoJq7gpWOerGuqpVjjop6rqmcp3l5Y5CprdN8pqaonJrBqrvNrIuop5x5sqe1zaKroqeeY7W1ucs%3D