RequiredFunctionToolCall Class

  • Reference

Definition

Namespace:
Azure.AI.OpenAI.Assistants
Assembly:
Azure.AI.OpenAI.Assistants.dll
Package:
Azure.AI.OpenAI.Assistants v1.0.0-beta.4
Source:
RequiredFunctionToolCall.cs

A representation of a requested call to a function tool, needed by the model to continue evaluation of a run.

public class RequiredFunctionToolCall : Azure.AI.OpenAI.Assistants.RequiredToolCall, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.RequiredFunctionToolCall>
type RequiredFunctionToolCall = class
    inherit RequiredToolCall
    interface IJsonModel<RequiredFunctionToolCall>
    interface IPersistableModel<RequiredFunctionToolCall>
Public Class RequiredFunctionToolCall
Inherits RequiredToolCall
Implements IJsonModel(Of RequiredFunctionToolCall), IPersistableModel(Of RequiredFunctionToolCall)
Inheritance
Object
RequiredToolCall
RequiredFunctionToolCall
Implements
IJsonModel<RequiredFunctionToolCall> IPersistableModel<RequiredFunctionToolCall> IPersistableModel<T>

Properties

Arguments

The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation.
Id

The ID of the tool call. This ID must be referenced when submitting tool outputs.

(Inherited from RequiredToolCall)
Name

The name of the function.

Explicit Interface Implementations

IJsonModel<RequiredFunctionToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<RequiredFunctionToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IJsonModel<RequiredToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from RequiredToolCall)
IJsonModel<RequiredToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from RequiredToolCall)
IPersistableModel<RequiredFunctionToolCall>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<RequiredFunctionToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<RequiredFunctionToolCall>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.
IPersistableModel<RequiredToolCall>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from RequiredToolCall)
IPersistableModel<RequiredToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from RequiredToolCall)
IPersistableModel<RequiredToolCall>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from RequiredToolCall)

Applies to