StructuredToolOutput 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.
The data provided during a tool outputs submission to resolve pending tool calls and allow the model to continue. Please note StructuredToolOutput is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ComputerToolOutput and ToolOutput.
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Agents.Persistent.UnknownStructuredToolOutput))]
public abstract class StructuredToolOutput : System.ClientModel.Primitives.IJsonModel<Azure.AI.Agents.Persistent.StructuredToolOutput>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Agents.Persistent.StructuredToolOutput>[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Agents.Persistent.UnknownStructuredToolOutput))>]
type StructuredToolOutput = class
interface IJsonModel<StructuredToolOutput>
interface IPersistableModel<StructuredToolOutput>Public MustInherit Class StructuredToolOutput
Implements IJsonModel(Of StructuredToolOutput), IPersistableModel(Of StructuredToolOutput)- Inheritance
-
StructuredToolOutput
- Derived
- Attributes
- Implements
Constructors
| Name | Description |
|---|---|
| StructuredToolOutput() |
Initializes a new instance of StructuredToolOutput. |
Properties
| Name | Description |
|---|---|
| ToolCallId |
The ID of the tool call being resolved, as provided in the tool calls of a required action from a run. |
Methods
| Name | Description |
|---|---|
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<StructuredToolOutput>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<StructuredToolOutput>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<StructuredToolOutput>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<StructuredToolOutput>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<StructuredToolOutput>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
