AgentResponseItem Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The AgentResponseItem. Please note this is the abstract base class. The derived classes available for instantiation are: AgentStructuredOutputsResponseItem, AgentWorkflowPreviewActionResponseItem, OAuthConsentRequestResponseItem, BingGroundingToolCall, BingGroundingToolCallOutput, Azure.AI.Extensions.OpenAI.SharepointGroundingToolCall, Azure.AI.Extensions.OpenAI.SharepointGroundingToolCallOutput, AzureAISearchToolCall, AzureAISearchToolCallOutput, BingCustomSearchToolCall, BingCustomSearchToolCallOutput, OpenApiToolCall, OpenApiToolCallOutput, BrowserAutomationToolCall, BrowserAutomationToolCallOutput, FabricDataAgentToolCall, FabricDataAgentToolCallOutput, AzureFunctionToolCall, AzureFunctionToolCallOutput, A2AToolCall, A2AToolCallOutput, MemorySearchToolCall, MemoryCommandToolCall, MemoryCommandToolCallOutput, Azure.AI.Extensions.OpenAI.OutputItemFunctionToolCallOutput, Azure.AI.Extensions.OpenAI.OutputItemComputerToolCallOutput, Azure.AI.Extensions.OpenAI.OutputItemToolSearchCall, Azure.AI.Extensions.OpenAI.OutputItemToolSearchOutput, Azure.AI.Extensions.OpenAI.OutputItemLocalShellToolCallOutput, Azure.AI.Extensions.OpenAI.OutputItemMcpApprovalResponseResource, and Azure.AI.Extensions.OpenAI.OutputItemCustomToolCallOutputResource.
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Extensions.OpenAI.UnknownAgentResponseItem))]
public abstract class AgentResponseItem : System.ClientModel.Primitives.IJsonModel<Azure.AI.Extensions.OpenAI.AgentResponseItem>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Extensions.OpenAI.AgentResponseItem>[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Extensions.OpenAI.UnknownAgentResponseItem))>]
type AgentResponseItem = class
interface IJsonModel<AgentResponseItem>
interface IPersistableModel<AgentResponseItem>Public MustInherit Class AgentResponseItem
Implements IJsonModel(Of AgentResponseItem), IPersistableModel(Of AgentResponseItem)- Inheritance
-
AgentResponseItem
- Derived
- Attributes
- Implements
Properties
| Name | Description |
|---|---|
| AgentReference |
The agent that created the item. |
| Id |
Gets the response item ID. |
| ResponseId |
The response on which the item is created. |
Methods
| Name | Description |
|---|---|
| AsResponseResultItem() |
Converts this agent response item into an OpenAI response item. |
| CreateStructuredOutputsItem(BinaryData) |
Creates a response item that contains structured output data. |
| CreateWorkflowPreviewActionItem(String, String) |
Creates a response item that represents a workflow preview action. |
| JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions) | |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions) | |
| PersistableModelWriteCore(ModelReaderWriterOptions) | |
Operators
| Name | Description |
|---|---|
| Implicit(AgentResponseItem to ResponseItem) |
Converts an AgentResponseItem into an OpenAI OpenAI.Responses.ResponseItem. |
| Implicit(ResponseItem to AgentResponseItem) |
Converts an OpenAI OpenAI.Responses.ResponseItem into an AgentResponseItem. |
