Share via


ToolOutput Class

Definition

The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue.

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

Constructors

Name Description
ToolOutput()

Initializes a new instance of ToolOutput.

ToolOutput(RequiredToolCall, String)

Initializes a new instance of ToolOutput.

ToolOutput(RequiredToolCall)

Initializes a new instance of ToolOutput.

ToolOutput(String, String)

Initializes a new instance of ToolOutput.

ToolOutput(String)

Initializes a new instance of ToolOutput.

Properties

Name Description
Output

The output from the tool to be submitted.

ToolCallId

The ID of the tool call being resolved, as provided in the tool calls of a required action from a run.

Explicit Interface Implementations

Name Description
IJsonModel<ToolOutput>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ToolOutput>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ToolOutput>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ToolOutput>.GetFormatFromOptions(ModelReaderWriterOptions)

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

<param name="options">The ModelReaderWriterOptions to use.</param>
IPersistableModel<ToolOutput>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to