Share via


RunStepFunctionToolCall Class

Definition

A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs and output consumed and emitted by the specified function.

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

Properties

Arguments

The arguments that the model requires are provided to the named function.

Id

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

(Inherited from RunStepToolCall)
Name

The name of the function.

Output

The output of the function, only populated for function calls that have already have had their outputs submitted.

Explicit Interface Implementations

IJsonModel<RunStepFunctionToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<RunStepFunctionToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<RunStepToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from RunStepToolCall)
IPersistableModel<RunStepFunctionToolCall>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<RunStepFunctionToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<RunStepFunctionToolCall>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<RunStepToolCall>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from RunStepToolCall)

Applies to