Azure.AI.AgentServer.Responses.Models Namespace

An agent implementing the A2A protocol.

An A2A (Agent-to-Agent) tool call.

The output of an A2A (Agent-to-Agent) tool call.

The AgentId.

The AgentReference.

The response data for a requested list of items.

The response data for a requested list of items.

A AI Search Index resource.

An annotation that applies to a span of output text. Please note this is the abstract base class. The derived classes available for instantiation are: FileCitationBody, UrlCitationBody, ContainerFileCitationBody, and FilePath.

Error response for API failures.

Apply patch create file operation.

Apply patch create file operation.

Apply patch delete file operation.

Apply patch delete file operation.

Apply patch operation Please note this is the abstract base class. The derived classes available for instantiation are: ApplyPatchCreateFileOperation, ApplyPatchDeleteFileOperation, and ApplyPatchUpdateFileOperation.

Apply patch operation Please note this is the abstract base class. The derived classes available for instantiation are: ApplyPatchCreateFileOperationParam, ApplyPatchDeleteFileOperationParam, and ApplyPatchUpdateFileOperationParam.

Apply patch tool call.

Apply patch tool call output.

Apply patch tool.

Apply patch update file operation.

Apply patch update file operation.

The ApproximateLocation.

Automatic Code Interpreter Tool Parameters.

The input definition information for an Azure AI search tool as used to configure an agent.

An Azure AI Search tool call.

The output of an Azure AI Search tool call.

A set of index resources used by the azure_ai_search tool.

The structure for keeping storage queue name and URI.

The definition of Azure function.

The AzureFunctionDefinitionFunction.

The structure for keeping storage queue name and URI.

The input definition information for an Azure Function Tool, as used to configure an Agent.

An Azure Function tool call.

The output of an Azure Function tool call.

A bing custom search configuration.

The input definition information for a Bing custom search tool as used to configure an agent.

A Bing custom search tool call.

The output of a Bing custom search tool call.

The bing custom search tool parameters.

Search configuration for Bing Grounding.

The bing grounding search tool parameters.

The input definition information for a bing grounding search tool as used to configure an agent.

A Bing grounding tool call.

The output of a Bing grounding tool call.

The input definition information for a Browser Automation Tool, as used to configure an Agent.

A browser automation tool call.

The output of a browser automation tool call.

Definition of input parameters for the connection used by the Browser Automation Tool.

Definition of input parameters for the Browser Automation Tool.

A tool for capturing structured outputs.

A memory item containing a summary extracted from conversations.

Click.

Code interpreter output image.

Code interpreter output logs.

Code interpreter.

Compaction item.

The compacted response object.

The CompactResponseMethodPublicBody.

Comparison Filter.

Compound Filter.

The ComputerAction. Please note this is the abstract base class. The derived classes available for instantiation are: ClickParam, DoubleClickAction, DragParam, KeyPressAction, MoveParam, ScreenshotParam, ScrollParam, TypeParam, and WaitParam.

Computer tool call output.

A pending safety check for the computer call.

Computer screenshot.

A computer screenshot image used with the computer use tool.

Computer.

Computer use preview.

The ContainerAutoParam.

Container file citation.

The ContainerNetworkPolicyAllowlistParam.

The ContainerNetworkPolicyDisabledParam.

The ContainerNetworkPolicyDomainSecretParam.

Network access policy for the container. Please note this is the abstract base class. The derived classes available for instantiation are: ContainerNetworkPolicyDisabledParam and ContainerNetworkPolicyAllowlistParam.

Container Reference.

The ContainerSkill. Please note this is the abstract base class. The derived classes available for instantiation are: SkillReferenceParam and InlineSkillParam.

The ContextManagementParam.

Conversation object.

Conversation.

Coordinate.

The CreatedBy.

The CreateResponse.

Extension methods for CreateResponse.

Grammar format.

Text format.

Custom tool.

The input format for the custom tool. Default is unconstrained text. Please note this is the abstract base class. The derived classes available for instantiation are: CustomTextFormatParam and CustomGrammarFormatParam.

The result of a delete response operation.

DoubleClick.

Drag.

The EmptyModelParam.

The Error.

A Fabric data agent tool call.

The output of a Fabric data agent tool call.

The fabric data agent tool parameters.

File citation.

File path.

File search.

The FileSearchToolCallResults.

The FunctionAndCustomToolCallOutput. Please note this is the abstract base class. The derived classes available for instantiation are: FunctionAndCustomToolCallOutputInputTextContent, FunctionAndCustomToolCallOutputInputImageContent, and FunctionAndCustomToolCallOutputInputFileContent.

Input file.

Input image.

Input text.

Function tool call output.

Shell exec action.

Shell action.

The FunctionShellCallEnvironment. Please note this is the abstract base class. The derived classes available for instantiation are: LocalEnvironmentResource and ContainerReferenceResource.

Shell tool call.

The environment to execute the shell commands in. Please note this is the abstract base class. The derived classes available for instantiation are: FunctionShellCallItemParamEnvironmentLocalEnvironmentParam and FunctionShellCallItemParamEnvironmentContainerReferenceParam.

The FunctionShellCallItemParamEnvironmentContainerReferenceParam.

The FunctionShellCallItemParamEnvironmentLocalEnvironmentParam.

Shell call output content.

Shell output content.

Shell call exit outcome.

Shell call exit outcome.

Shell tool call output.

Shell call outcome Please note this is the abstract base class. The derived classes available for instantiation are: FunctionShellCallOutputTimeoutOutcome and FunctionShellCallOutputExitOutcome.

Shell call outcome Please note this is the abstract base class. The derived classes available for instantiation are: FunctionShellCallOutputTimeoutOutcomeParam and FunctionShellCallOutputExitOutcomeParam.

Shell call timeout outcome.

Shell call timeout outcome.

Shell tool.

The FunctionShellToolParamEnvironment. Please note this is the abstract base class. The derived classes available for instantiation are: FunctionShellToolParamEnvironmentLocalEnvironmentParam, FunctionShellToolParamEnvironmentContainerReferenceParam, and ContainerAutoParam.

The FunctionShellToolParamEnvironmentContainerReferenceParam.

The FunctionShellToolParamEnvironmentLocalEnvironmentParam.

Function.

The FunctionToolParam.

The HybridSearchOptions.

Image generation tool.

The ImageGenToolInputImageMask.

The InlineSkillParam.

Inline skill payload.

Input file.

Input file.

Input image.

Input image.

Input text.

Input text.

Content item used to generate a response. Please note this is the abstract base class. The derived classes available for instantiation are: MemorySearchToolCallItemParam, ComputerCallOutputItemParam, FunctionCallOutputItemParam, CompactionSummaryItemParam, FunctionShellCallItemParam, FunctionShellCallOutputItemParam, ApplyPatchToolCallItemParam, ApplyPatchToolCallOutputItemParam, MCPApprovalResponse, ItemReferenceParam, ItemMessage, ItemFileSearchToolCall, ItemComputerToolCall, ItemWebSearchToolCall, ItemFunctionToolCall, ItemReasoningItem, ItemImageGenToolCall, ItemCodeInterpreterToolCall, ItemLocalShellToolCall, ItemLocalShellToolCallOutput, ItemMcpListTools, ItemMcpApprovalRequest, ItemMcpToolCall, ItemCustomToolCallOutput, ItemCustomToolCall, ToolSearchCallItemParam, and ToolSearchOutputItemParam.

Code interpreter tool call.

Computer tool call.

Custom tool call.

Custom tool call output.

Extension methods for sequences of Item instances.

An item representing a message, tool call, tool output, reasoning, or other response element. Please note this is the abstract base class. The derived classes available for instantiation are: ItemFieldMessage, ItemFieldFunctionToolCall, ItemFieldToolSearchCall, ItemFieldToolSearchOutput, ItemFieldFunctionToolCallOutput, ItemFieldFileSearchToolCall, ItemFieldWebSearchToolCall, ItemFieldImageGenToolCall, ItemFieldComputerToolCall, ItemFieldComputerToolCallOutput, ItemFieldReasoningItem, ItemFieldCompactionBody, ItemFieldCodeInterpreterToolCall, ItemFieldLocalShellToolCall, ItemFieldLocalShellToolCallOutput, ItemFieldFunctionShellCall, ItemFieldFunctionShellCallOutput, ItemFieldApplyPatchToolCall, ItemFieldApplyPatchToolCallOutput, ItemFieldMcpListTools, ItemFieldMcpApprovalRequest, ItemFieldMcpApprovalResponseResource, ItemFieldMcpToolCall, ItemFieldCustomToolCall, and ItemFieldCustomToolCallOutput.

Apply patch tool call.

Apply patch tool call output.

Code interpreter tool call.

Compaction item.

Computer tool call.

Computer tool call output.

Custom tool call.

Custom tool call output.

File search tool call.

Shell tool call.

Shell call output.

Function tool call.

Function tool call output.

Image generation call.

Local shell call.

Local shell call output.

MCP approval request.

MCP approval response.

MCP list tools.

MCP tool call.

Message.

Reasoning.

The ItemFieldToolSearchCall.

The ItemFieldToolSearchOutput.

Web search tool call.

File search tool call.

Function tool call.

Image generation call.

Local shell call.

Local shell call output.

MCP approval request.

MCP list tools.

MCP tool call.

Message.

Extension methods for ItemMessage that provide typed access to the Content BinaryData property.

Reasoning.

Item reference.

Web search tool call.

KeyPress.

Local Environment.

Local shell exec action.

Local shell tool.

The LocalSkillParam.

Log probability.

MCP approval response.

MCP list tools tool.

The MCPListToolsToolAnnotations.

The MCPListToolsToolInputSchema.

MCP tool.

MCP tool filter.

The MCPToolRequireApproval.

A single memory item stored in the memory store, containing content and metadata. Please note this is the abstract base class. The derived classes available for instantiation are: UserProfileMemoryItem and ChatSummaryMemoryItem.

A retrieved memory item from memory search.

Memory search options.

A tool for integrating memories into the agent.

A tool for integrating memories into the agent.

The MemorySearchToolCallItemParam.

The MemorySearchToolCallItemResource.

A content part that makes up an input or output item. Please note this is the abstract base class. The derived classes available for instantiation are: SummaryTextContent, TextContent, ComputerScreenshotContent, MessageContentInputTextContent, MessageContentOutputTextContent, MessageContentReasoningTextContent, MessageContentRefusalContent, MessageContentInputImageContent, and MessageContentInputFileContent.

Input file.

Input image.

Input text.

Output text.

Reasoning text.

Refusal.

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

The input definition information for a Microsoft Fabric tool as used to configure an agent.

Move.

Namespace.

Request from the service for the user to perform OAuth consent.

Security details for OpenApi anonymous authentication.

authentication details for OpenApiFunctionDefinition Please note this is the abstract base class. The derived classes available for instantiation are: OpenApiAnonymousAuthDetails, OpenApiProjectConnectionAuthDetails, and OpenApiManagedAuthDetails.

The input definition information for an openapi function.

The OpenApiFunctionDefinitionFunction.

Security details for OpenApi managed_identity authentication.

Security scheme for OpenApi managed_identity authentication.

Security details for OpenApi project connection authentication.

Security scheme for OpenApi managed_identity authentication.

The input definition information for an OpenAPI tool as used to configure an agent.

An OpenAPI tool call.

The output of an OpenAPI tool call.

The OutputContent. Please note this is the abstract base class. The derived classes available for instantiation are: OutputContentOutputTextContent, OutputContentRefusalContent, and OutputContentReasoningTextContent.

Output text.

Reasoning text.

Refusal.

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.

Apply patch tool call.

Apply patch tool call output.

Code interpreter tool call.

Compaction item.

Computer tool call.

Computer tool call output.

ResponseCustomToolCallItem.

ResponseCustomToolCallOutputItem.

Extension methods for OutputItem that provide efficient access to the Id property without reflection.

File search tool call.

Shell tool call.

Shell call output.

Function tool call.

Function tool call output.

Image generation call.

Local shell call.

Local shell call output.

MCP approval request.

MCP approval response.

MCP list tools.

MCP tool call.

Message.

Reasoning.

The OutputItemToolSearchCall.

The OutputItemToolSearchOutput.

Web search tool call.

Reference to a prompt template and its variables. Learn more.

The RankingOptions.

The RealtimeMCPError. Please note this is the abstract base class. The derived classes available for instantiation are: RealtimeMCPProtocolError, RealtimeMCPToolExecutionError, and RealtimeMCPHTTPError.

Realtime MCP HTTP error.

Realtime MCP protocol error.

Realtime MCP tool execution error.

Reasoning.

Reasoning text.

Emitted when there is a partial audio response.

Emitted when the audio response is complete.

Emitted when there is a partial transcript of audio.

Emitted when the full audio transcript is completed.

Emitted when a partial code snippet is streamed by the code interpreter.

Emitted when the code snippet is finalized by the code interpreter.

Emitted when the code interpreter call is completed.

Emitted when a code interpreter call is in progress.

Emitted when the code interpreter is actively interpreting the code snippet.

Emitted when the model response is complete.

Emitted when a new content part is added.

Emitted when a content part is done.

An event that is emitted when a response is created.

ResponseCustomToolCallInputDelta.

ResponseCustomToolCallInputDone.

Emitted when an error occurs.

An error object returned when the model fails to generate a Response.

Extension methods for ResponseObject that provide typed access to BinaryData properties like ToolChoice and Instructions.

An event that is emitted when a response fails.

Emitted when a file search call is completed (results found).

Emitted when a file search call is initiated.

Emitted when a file search is currently searching.

JSON schema.

Emitted when there is a partial function-call arguments delta.

Emitted when function-call arguments are finalized.

ResponseImageGenCallCompletedEvent.

ResponseImageGenCallGeneratingEvent.

ResponseImageGenCallInProgressEvent.

ResponseImageGenCallPartialImageEvent.

The ResponseIncompleteDetails.

An event that is emitted when a response finishes as incomplete.

Emitted when the response is in progress.

A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Less-negative (higher) logprob values indicate greater model confidence in that token choice.

The ResponseLogProbTopLogprobs.

ResponseMCPCallArgumentsDeltaEvent.

ResponseMCPCallArgumentsDoneEvent.

ResponseMCPCallCompletedEvent.

ResponseMCPCallFailedEvent.

ResponseMCPCallInProgressEvent.

ResponseMCPListToolsCompletedEvent.

ResponseMCPListToolsFailedEvent.

ResponseMCPListToolsInProgressEvent.

Layer 3 convenience extensions for ResponseObject.

Emitted when a new output item is added.

Emitted when an output item is marked done.

ResponseOutputTextAnnotationAddedEvent.

Prompt Variables.

ResponseQueuedEvent.

Emitted when a new reasoning summary part is added.

The ResponseReasoningSummaryPartAddedEventPart.

Emitted when a reasoning summary part is completed.

The ResponseReasoningSummaryPartDoneEventPart.

Emitted when a delta is added to a reasoning summary text.

Emitted when a reasoning summary text is completed.

Emitted when a delta is added to a reasoning text.

Emitted when a reasoning text is completed.

Emitted when there is a partial refusal text.

Emitted when refusal text is finalized.

Factory for creating model instances with specific values for testing and mocking. Provides a curated subset of factory methods with cleaner parameter names, delegating to the internal AgentServerResponsesModelFactory.

Extension methods for creating immutable snapshots of ResponseObject objects.

Customizations for ResponseStreamEvent.

Options for streaming responses. Only set this when you set stream: true.

Emitted when there is an additional text delta.

Emitted when text content is finalized.

Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more:

• [Text inputs and outputs](/docs/guides/text)
• [Structured Outputs](/docs/guides/structured-outputs)

Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.

The ResponseUsageInputTokensDetails.

The ResponseUsageOutputTokensDetails.

Emitted when a web search call is completed.

Emitted when a web search call is initiated.

Emitted when a web search call is executing.

Screenshot.

Scroll.

A SharePoint grounding tool call.

The output of a SharePoint grounding tool call.

The sharepoint grounding tool parameters.

The input definition information for a sharepoint tool as used to configure an agent.

The SkillReferenceParam.

Specific apply patch tool choice.

Specific shell tool choice.

A structured output that can be produced by the agent.

The StructuredOutputsOutputItem.

Summary text.

Text Content.

An object specifying the format that the model must output. Configuring { "type": "json_schema" } enables Structured Outputs, which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide. The default format is { "type": "text" } with no additional options. Not recommended for gpt-4o and newer models:* Setting to { "type": "json_object" } enables the older JSON mode, which ensures the message the model generates is valid JSON. Using json_schema is preferred for models that support it. Please note this is the abstract base class. The derived classes available for instantiation are: TextResponseFormatJsonSchema, TextResponseFormatConfigurationResponseFormatText, and TextResponseFormatConfigurationResponseFormatJsonObject.

JSON object.

Text.

JSON schema.

A tool that can be used to generate a response. Please note this is the abstract base class. The derived classes available for instantiation are: BingGroundingTool, MicrosoftFabricPreviewTool, SharepointPreviewTool, AzureAISearchTool, OpenApiTool, BingCustomSearchPreviewTool, BrowserAutomationPreviewTool, AzureFunctionTool, CaptureStructuredOutputsTool, A2APreviewTool, WorkIQPreviewTool, MemorySearchPreviewTool, MemorySearchTool, CodeInterpreterTool, FunctionTool, FileSearchTool, ComputerUsePreviewTool, WebSearchTool, MCPTool, ImageGenTool, LocalShellToolParam, FunctionShellToolParam, CustomToolParam, WebSearchPreviewTool, ApplyPatchToolParam, ComputerTool, NamespaceToolParam, and ToolSearchToolParam.

Allowed tools.

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Custom tool.

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Function tool.

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

MCP tool.

How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call. Please note this is the abstract base class. The derived classes available for instantiation are: ToolChoiceAllowed, ToolChoiceFunction, ToolChoiceMCP, ToolChoiceCustom, SpecificApplyPatchParam, SpecificFunctionShellParam, ToolChoiceFileSearch, ToolChoiceWebSearchPreview, ToolChoiceComputerUsePreview, ToolChoiceWebSearchPreview20250311, ToolChoiceImageGeneration, ToolChoiceCodeInterpreter, ToolChoiceComputer, and ToolChoiceComputerUse.

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

A project connection resource.

The ToolSearchCallItemParam.

The ToolSearchOutputItemParam.

Tool search tool.

Top log probability.

Type.

URL citation.

A memory item specifically containing user profile information extracted from conversations, such as preferences, interests, and personal details.

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.

Wait.

Find action.

Open page action.

Search action.

The WebSearchActionSearchSources.

Web search approximate location.

A web search configuration for bing custom search.

Web search preview.

Web search.

The WebSearchToolFilters.

The WorkflowActionOutputItem.

A WorkIQ server-side tool.

The WorkIQ tool parameters.

Available query types for Azure AI Search tool.

Specify additional output data to include in the model response. Currently supported values are:

• `web_search_call.action.sources`: Include the sources of the web search tool call.
• `code_interpreter_call.outputs`: Includes the outputs of python code execution in code interpreter tool call items.
• `computer_call_output.output.image_url`: Include image urls from the computer call output.
• `file_search_call.results`: Include the search results of the file search tool call.
• `message.input_image.image_url`: Include image urls from the input message.
• `message.output_text.logprobs`: Include logprobs with assistant messages.
• `reasoning.encrypted_content`: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the `store` parameter is set to `false`, or when an organization is enrolled in the zero data retention program).

Memory item kind.

Model ID used to generate the response, like gpt-5 or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

Authentication type for OpenApi endpoint. Allowed types are:

• Anonymous (no authentication required)
• Project Connection (requires project_connection_id to endpoint, as setup in AI Foundry)
• Managed_Identity (requires audience for identity based auth)

The error code for the response.

Outcome values reported for apply_patch tool call outputs.

Status values reported for apply_patch tool calls.

Status values reported for shell tool calls.

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

Labels an assistant message as intermediate commentary (commentary) or the final answer (final_answer). For models like gpt-5.3-codex and beyond, when sending follow-up requests, preserve and resend phase on all assistant messages — dropping it can degrade performance. Not used for user messages.

The status of a tool call.

Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools.