ChatCompletionsFunctionToolCall Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

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

Source:

ChatCompletionsFunctionToolCall.cs

A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents a function invocation needed for a subsequent chat completions request to resolve.

public class ChatCompletionsFunctionToolCall : Azure.AI.OpenAI.ChatCompletionsToolCall, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.ChatCompletionsFunctionToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.ChatCompletionsFunctionToolCall>

type ChatCompletionsFunctionToolCall = class
    inherit ChatCompletionsToolCall
    interface IJsonModel<ChatCompletionsFunctionToolCall>
    interface IPersistableModel<ChatCompletionsFunctionToolCall>

Public Class ChatCompletionsFunctionToolCall
Inherits ChatCompletionsToolCall
Implements IJsonModel(Of ChatCompletionsFunctionToolCall), IPersistableModel(Of ChatCompletionsFunctionToolCall)

Inheritance

Object

ChatCompletionsToolCall

ChatCompletionsFunctionToolCall

Implements

IJsonModel<ChatCompletionsFunctionToolCall> IPersistableModel<ChatCompletionsFunctionToolCall> IPersistableModel<T>

Constructors

ChatCompletionsFunctionToolCall(String, FunctionCall)	Initializes a new instance of ChatCompletionsFunctionToolCall.
ChatCompletionsFunctionToolCall(String, String, String)	Initializes a new instance of ChatCompletionsFunctionToolCall.

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.
Id	The ID of the tool call. (Inherited from ChatCompletionsToolCall)
Name	The name of the function to call.

Explicit Interface Implementations

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