ChatCompletionsToolCall Class
Definition
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.
A function tool call requested by the AI model.
public class ChatCompletionsToolCall : System.ClientModel.Primitives.IJsonModel<Azure.AI.Inference.ChatCompletionsToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Inference.ChatCompletionsToolCall>type ChatCompletionsToolCall = class
interface IJsonModel<ChatCompletionsToolCall>
interface IPersistableModel<ChatCompletionsToolCall>Public Class ChatCompletionsToolCall
Implements IJsonModel(Of ChatCompletionsToolCall), IPersistableModel(Of ChatCompletionsToolCall)- Inheritance
-
ChatCompletionsToolCall
- Implements
Constructors
| ChatCompletionsToolCall(String, FunctionCall) |
Initializes a new instance of ChatCompletionsToolCall. |
Properties
| Arguments |
The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. |
| Function |
The details of the function call requested by the AI model. |
| Id |
The ID of the tool call. |
| Name |
The name of the function to call. |
| Type |
The type of tool call. Currently, only |
Methods
| CreateFunctionToolCall(String, String, String) |
Creates a new ChatCompletionsToolCall representing a function call made by the model. |
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. |
