OutputItemCustomToolCall 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:
OutputItemCustomToolCall.cs

ResponseCustomToolCallItem.

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

Constructors

Name Description
OutputItemCustomToolCall(String, String, String, FunctionCallStatus)

Initializes a new instance of OutputItemCustomToolCall.

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from OutputItem)
CallId

An identifier used to map this custom tool call to a tool call output.
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 in the OpenAI platform.
Input

The input for the custom tool call generated by the model.
Name

The name of the custom tool being called.
Namespace

The namespace of the custom tool being called.
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<OutputItemCustomToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<OutputItemCustomToolCall>.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<OutputItemCustomToolCall>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OutputItemCustomToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OutputItemCustomToolCall>.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