OutputItemCustomToolCallOutput Class

Definition

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

ResponseCustomToolCallOutputItem.

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

Constructors

Name Description
OutputItemCustomToolCallOutput(String, BinaryData, FunctionCallOutputStatusEnum)

Initializes a new instance of OutputItemCustomToolCallOutput.

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from OutputItem)
CallId

The call ID, used to map this custom tool call output to a custom tool call.
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

The unique ID of the custom tool call output in the OpenAI platform.
Output

The output from the custom tool call generated by your code. Can be a string or an list of output content.

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 item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Methods

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

Explicit Interface Implementations

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

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