OutputItemCustomToolCallOutputResource Class

Definition

ResponseCustomToolCallOutputItem.

public class OutputItemCustomToolCallOutputResource : Azure.AI.Extensions.OpenAI.AgentResponseItem, System.ClientModel.Primitives.IJsonModel<Azure.AI.Extensions.OpenAI.OutputItemCustomToolCallOutputResource>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Extensions.OpenAI.OutputItemCustomToolCallOutputResource>
type OutputItemCustomToolCallOutputResource = class
    inherit AgentResponseItem
    interface IJsonModel<OutputItemCustomToolCallOutputResource>
    interface IPersistableModel<OutputItemCustomToolCallOutputResource>
Public Class OutputItemCustomToolCallOutputResource
Inherits AgentResponseItem
Implements IJsonModel(Of OutputItemCustomToolCallOutputResource), IPersistableModel(Of OutputItemCustomToolCallOutputResource)
Inheritance
OutputItemCustomToolCallOutputResource
Implements

Constructors

Name Description
OutputItemCustomToolCallOutputResource(String, BinaryData, ResponsesFunctionCallOutputStatusEnum)

Initializes a new instance of OutputItemCustomToolCallOutputResource.

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from AgentResponseItem)
CallId

The call ID, used to map this custom tool call output to a custom tool call.

CreatedBy

The identifier of the actor that created the item.

Id (Inherited from AgentResponseItem)
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:

  • String.
  • IList<T> where T is of type Azure.AI.Extensions.OpenAI.InternalFunctionAndCustomToolCallOutput.
</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 AgentResponseItem)
Status

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Methods

Name Description
AsResponseResultItem() (Inherited from AgentResponseItem)
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to