OpenApiToolCallOutput Class

Definition

Namespace:
Azure.AI.AgentServer.Responses.Models
Assembly:
Azure.AI.AgentServer.Responses.dll
Package:
Azure.AI.AgentServer.Responses v1.0.0-beta.3
Source:
OpenApiToolCallOutput.cs

The output of an OpenAPI tool call.

public class OpenApiToolCallOutput : Azure.AI.AgentServer.Responses.Models.OutputItem, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.OpenApiToolCallOutput>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.OpenApiToolCallOutput>
type OpenApiToolCallOutput = class
    inherit OutputItem
    interface IJsonModel<OpenApiToolCallOutput>
    interface IPersistableModel<OpenApiToolCallOutput>
Public Class OpenApiToolCallOutput
Inherits OutputItem
Implements IJsonModel(Of OpenApiToolCallOutput), IPersistableModel(Of OpenApiToolCallOutput)
Inheritance
Object
OutputItem
OpenApiToolCallOutput
Implements
IJsonModel<OpenApiToolCallOutput> IPersistableModel<OpenApiToolCallOutput> IPersistableModel<T>

Constructors

Name Description
OpenApiToolCallOutput(String, String, ToolCallStatus, String)

Initializes a new instance of OpenApiToolCallOutput.

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from OutputItem)
CallId

The unique ID of the tool call generated by the model.
CreatedBy

The information about the creator of the item

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

<remarks> Supported types:

</remarks>

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

(Inherited from OutputItem)
Id

Gets or sets the Id.
Name

The name of the OpenAPI operation that was called.
Output

The output from the OpenAPI tool call.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

<remarks> Supported types:

</remarks>

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

ResponseId

The response on which the item is created.

(Inherited from OutputItem)
Status

The status of the tool call.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<OpenApiToolCallOutput>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<OpenApiToolCallOutput>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<OutputItem>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from OutputItem)
IJsonModel<OutputItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OpenApiToolCallOutput>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OpenApiToolCallOutput>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OpenApiToolCallOutput>.Write(ModelReaderWriterOptions)
IPersistableModel<OutputItem>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItem>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItem>.Write(ModelReaderWriterOptions) (Inherited from OutputItem)

Extension Methods

Name Description
GetId(OutputItem)

Gets the Id property from an OutputItem. Uses direct type checks for known subclasses; falls back to JSON serialization for unrecognized types.

Applies to