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

The OutputItem. Please note this is the abstract base class. The derived classes available for instantiation are: StructuredOutputsOutputItem, WorkflowActionOutputItem, OAuthConsentRequestOutputItem, MemorySearchToolCallItemResource, BingGroundingToolCall, BingGroundingToolCallOutput, SharepointGroundingToolCall, SharepointGroundingToolCallOutput, AzureAISearchToolCall, AzureAISearchToolCallOutput, BingCustomSearchToolCall, BingCustomSearchToolCallOutput, OpenApiToolCall, OpenApiToolCallOutput, BrowserAutomationToolCall, BrowserAutomationToolCallOutput, FabricDataAgentToolCall, FabricDataAgentToolCallOutput, AzureFunctionToolCall, AzureFunctionToolCallOutput, A2AToolCall, A2AToolCallOutput, OutputItemCustomToolCall, OutputItemCustomToolCallOutput, OutputItemFileSearchToolCall, OutputItemFunctionToolCall, OutputItemFunctionToolCallOutput, OutputItemWebSearchToolCall, OutputItemComputerToolCall, OutputItemComputerToolCallOutput, OutputItemReasoningItem, OutputItemToolSearchCall, OutputItemToolSearchOutput, OutputItemCompactionBody, OutputItemImageGenToolCall, OutputItemCodeInterpreterToolCall, OutputItemLocalShellToolCall, OutputItemLocalShellToolCallOutput, OutputItemFunctionShellCall, OutputItemFunctionShellCallOutput, OutputItemApplyPatchToolCall, OutputItemApplyPatchToolCallOutput, OutputItemMcpToolCall, OutputItemMcpListTools, OutputItemMcpApprovalRequest, OutputItemMcpApprovalResponseResource, and OutputItemMessage.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.AgentServer.Responses.Models.UnknownOutputItem))]
public abstract class OutputItem : System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.OutputItem>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.OutputItem>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.AgentServer.Responses.Models.UnknownOutputItem))>]
type OutputItem = class
    interface IJsonModel<OutputItem>
    interface IPersistableModel<OutputItem>
Public MustInherit Class OutputItem
Implements IJsonModel(Of OutputItem), IPersistableModel(Of OutputItem)
Inheritance
Object
OutputItem
Derived
Attributes
PersistableModelProxyAttribute
Implements
IJsonModel<OutputItem> IPersistableModel<OutputItem> IPersistableModel<T>

Properties

Name Description
AgentReference

The agent that created the item.
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" }.

ResponseId

The response on which the item is created.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<OutputItem>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<OutputItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<OutputItem>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OutputItem>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OutputItem>.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