Azure.AI.AgentServer.Contracts.Generated.OpenAI Namespace

An agent implementing the A2A protocol.

A AI Search Index resource.

The Annotation. Please note Annotation is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AnnotationFileCitation, AnnotationFilePath and AnnotationUrlCitation.

A citation to a file.

A path to a file.

A citation for a web resource used to generate a model response.

The ApproximateLocation.

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

A set of index resources used by the azure_ai_search tool.

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

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 a Bing custom search tool as used to configure an agent.

A bing custom search configuration.

The bing custom search tool parameters.

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

Search configuration for Bing Grounding.

The bing grounding search tool parameters.

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

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.

The CodeInterpreterOutput. Please note CodeInterpreterOutput is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include CodeInterpreterOutputImage and CodeInterpreterOutputLogs.

The image output from the code interpreter.

The logs output from the code interpreter.

A tool that runs Python code to help generate a response to a prompt.

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

A tool call to run code.

A tool call to run code.

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

Combine multiple filters using and or or.

The ComputerAction. Please note ComputerAction is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ComputerActionClick, ComputerActionDoubleClick, ComputerActionDrag, ComputerActionKeyPress, ComputerActionMove, ComputerActionScreenshot, ComputerActionScroll, ComputerActionTypeKeys and ComputerActionWait.

A click action.

A double click action.

A drag action.

A collection of keypresses the model would like to perform.

A mouse move action.

A screenshot action.

A scroll action.

An action to type in text.

A wait action.

A tool call to a computer use tool. See the computer use guide for more information.

A tool call to a computer use tool. See the computer use guide for more information.

The ComputerToolCallOutputItemOutput. Please note ComputerToolCallOutputItemOutput is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ComputerToolCallOutputItemOutputComputerScreenshot.

The ComputerToolCallOutputItemOutputComputerScreenshot.

The output of a computer tool call.

The output of a computer tool call.

A pending safety check for the computer call.

A tool that controls a virtual computer. Learn more about the computer tool.

An x/y coordinate pair, e.g. { x: 100, y: 200 }.

The CreatedBy.

The DeleteScopeRequest.

The EasyInputMessage.

The fabric data agent tool parameters.

A tool that searches for relevant content from uploaded files. Learn more about the file search tool.

The results of a file search tool call. See the file search guide for more information.

The FileSearchToolCallItemParamResult.

The results of a file search tool call. See the file search guide for more information.

Defines a function in your own code the model can choose to call. Learn more about function calling.

A tool call to run a function. See the function calling guide for more information.

A tool call to run a function. See the function calling guide for more information.

The output of a function tool call.

The output of a function tool call.

A tool that generates images using a model like gpt-image-1.

An image generation request made by the model.

An image generation request made by the model.

The ImageGenToolInputImageMask.

The ItemContent. Please note ItemContent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ItemContentInputAudio, ItemContentInputFile, ItemContentInputImage, ItemContentInputText, ItemContentOutputAudio, ItemContentOutputText and ItemContentRefusal.

An audio input to the model.

A file input to the model.

An image input to the model. Learn about image inputs.

A text input to the model.

An audio output from the model.

A text output from the model.

A refusal from the model.

Content item used to generate a response. Please note ItemParam is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ResponsesAssistantMessageItemParam, CodeInterpreterToolCallItemParam, ComputerToolCallItemParam, ComputerToolCallOutputItemParam, ResponsesDeveloperMessageItemParam, FileSearchToolCallItemParam, FunctionToolCallItemParam, FunctionToolCallOutputItemParam, ImageGenToolCallItemParam, ItemReferenceItemParam, LocalShellToolCallItemParam, LocalShellToolCallOutputItemParam, MCPApprovalRequestItemParam, MCPApprovalResponseItemParam, MCPCallItemParam, MCPListToolsItemParam, MemorySearchToolCallItemParam, ResponsesMessageItemParam, ReasoningItemParam, ResponsesSystemMessageItemParam, ResponsesUserMessageItemParam and WebSearchToolCallItemParam.

An public identifier for an item to reference.

Content item used to generate a response. Please note ItemResource is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ResponsesAssistantMessageItemResource, CodeInterpreterToolCallItemResource, ComputerToolCallItemResource, ComputerToolCallOutputItemResource, ResponsesDeveloperMessageItemResource, FileSearchToolCallItemResource, FunctionToolCallItemResource, FunctionToolCallOutputItemResource, ImageGenToolCallItemResource, InvokeAzureAgentWorkflowActionOutputItemResource, LocalShellToolCallItemResource, LocalShellToolCallOutputItemResource, MCPApprovalRequestItemResource, MCPApprovalResponseItemResource, MCPCallItemResource, MCPListToolsItemResource, MemorySearchToolCallItemResource, ResponsesMessageItemResource, OAuthConsentRequestItemResource, ReasoningItemResource, StructuredOutputsItemResource, ResponsesSystemMessageItemResource, ResponsesUserMessageItemResource, WebSearchToolCallItemResource and WorkflowActionOutputItemResource.

Execute a shell command on the server.

A tool that allows the model to execute shell commands in a local environment.

A tool call to run a command on the local shell.

A tool call to run a command on the local shell.

The output of a local shell tool call.

The output of a local shell tool call.

The Location. Please note Location is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ApproximateLocation.

The log probability of a token.

A request for human approval of a tool invocation.

A request for human approval of a tool invocation.

A response to an MCP approval request.

A response to an MCP approval request.

An invocation of a tool on an MCP server.

An invocation of a tool on an MCP server.

A list of tools available on an MCP server.

A list of tools available on an MCP server.

A tool available on an MCP server.

Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.

The MCPToolAllowedTools1.

The MCPToolRequireApproval1.

The MCPToolRequireApprovalAlways.

The MCPToolRequireApprovalNever.

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

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

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

Security details for OpenApi anonymous authentication.

authentication details for OpenApiFunctionDefinition Please note OpenApiAuthDetails is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include OpenApiAnonymousAuthDetails, OpenApiManagedAuthDetails and OpenApiProjectConnectionAuthDetails.

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.

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

The RankingOptions.

o-series models only

Configuration options for reasoning models.

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

The ReasoningItemSummaryPart. Please note ReasoningItemSummaryPart is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ReasoningItemSummaryTextPart.

The ReasoningItemSummaryTextPart.

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.

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

Emitted when an error occurs.

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.

The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.

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

Emitted when function-call arguments are finalized.

Emitted when an image generation tool call has completed and the final image is available.

Emitted when an image generation tool call is actively generating an image (intermediate state).

Emitted when an image generation tool call is in progress.

Emitted when a partial image is available during image generation streaming.

The ResponseIncompleteDetails1.

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

Emitted when the response is in progress.

Emitted when there is a delta (partial update) to the arguments of an MCP tool call.

Emitted when the arguments for an MCP tool call are finalized.

Emitted when an MCP tool call has completed successfully.

Emitted when an MCP tool call has failed.

Emitted when an MCP tool call is in progress.

Emitted when the list of available MCP tools has been successfully retrieved.

Emitted when the attempt to list available MCP tools has failed.

Emitted when the system is in the process of retrieving the list of available MCP tools.

Emitted when a new output item is added.

Emitted when an output item is marked done.

Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files.

Emitted when a response is queued and waiting to be processed.

Emitted when there is a delta (partial update) to the reasoning content.

Emitted when the reasoning content is finalized for an item.

Emitted when there is a delta (partial update) to the reasoning summary content.

Emitted when the reasoning summary content is finalized for an item.

Emitted when a new reasoning summary part is added.

Emitted when a reasoning summary part is completed.

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

Emitted when a reasoning summary text is completed.

Emitted when there is a partial refusal text.

Emitted when refusal text is finalized.

A message parameter item with the assistant role.

A message resource item with the assistant role.

A message parameter item with the developer role.

A message resource item with the developer role.

A response message item, representing a role and content, as provided as client request parameters. Please note ResponsesMessageItemParam is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ResponsesAssistantMessageItemParam, ResponsesDeveloperMessageItemParam, ResponsesSystemMessageItemParam and ResponsesUserMessageItemParam.

A response message resource item, representing a role and content, as provided on service responses. Please note ResponsesMessageItemResource is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ResponsesAssistantMessageItemResource, ResponsesDeveloperMessageItemResource, ResponsesSystemMessageItemResource and ResponsesUserMessageItemResource.

A message parameter item with the system role.

A message resource item with the system role.

The ResponseStreamEvent. Please note ResponseStreamEvent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ResponseErrorEvent, ResponseCodeInterpreterCallCodeDeltaEvent, ResponseCodeInterpreterCallCodeDoneEvent, ResponseCodeInterpreterCallCompletedEvent, ResponseCodeInterpreterCallInProgressEvent, ResponseCodeInterpreterCallInterpretingEvent, ResponseCompletedEvent, ResponseContentPartAddedEvent, ResponseContentPartDoneEvent, ResponseCreatedEvent, ResponseFailedEvent, ResponseFileSearchCallCompletedEvent, ResponseFileSearchCallInProgressEvent, ResponseFileSearchCallSearchingEvent, ResponseFunctionCallArgumentsDeltaEvent, ResponseFunctionCallArgumentsDoneEvent, ResponseImageGenCallCompletedEvent, ResponseImageGenCallGeneratingEvent, ResponseImageGenCallInProgressEvent, ResponseImageGenCallPartialImageEvent, ResponseInProgressEvent, ResponseIncompleteEvent, ResponseMCPCallArgumentsDeltaEvent, ResponseMCPCallArgumentsDoneEvent, ResponseMCPCallCompletedEvent, ResponseMCPCallFailedEvent, ResponseMCPCallInProgressEvent, ResponseMCPListToolsCompletedEvent, ResponseMCPListToolsFailedEvent, ResponseMCPListToolsInProgressEvent, ResponseOutputItemAddedEvent, ResponseOutputItemDoneEvent, ResponseTextDeltaEvent, ResponseTextDoneEvent, ResponseQueuedEvent, ResponseReasoningSummaryPartAddedEvent, ResponseReasoningSummaryPartDoneEvent, ResponseReasoningSummaryTextDeltaEvent, ResponseReasoningSummaryTextDoneEvent, ResponseReasoningSummaryDeltaEvent, ResponseReasoningSummaryDoneEvent, ResponseReasoningDeltaEvent, ResponseReasoningDoneEvent, ResponseRefusalDeltaEvent, ResponseRefusalDoneEvent, ResponseWebSearchCallCompletedEvent, ResponseWebSearchCallInProgressEvent and ResponseWebSearchCallSearchingEvent.

A message parameter item with the user role.

A message resource item with the user role.

Emitted when there is an additional text delta.

Emitted when text content is finalized.

The ResponseTextFormatConfiguration. Please note ResponseTextFormatConfiguration is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ResponseTextFormatConfigurationJsonObject, ResponseTextFormatConfigurationJsonSchema and ResponseTextFormatConfigurationText.

The ResponseTextFormatConfigurationJsonObject.

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

The ResponseTextFormatConfigurationText.

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

The ResponseUsageInputTokensDetails.

The ResponseUsageOutputTokensDetails.

Note: web_search is not yet available via Azure OpenAI.

Note: web_search is not yet available via Azure OpenAI.

Note: web_search is not yet available via Azure OpenAI.

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

The sharepoint grounding tool parameters.

An structured input that can participate in prompt template substitutions and tool argument binding.

A structured output that can be produced by the agent.

The StructuredOutputsItemResource.

The Tool. Please note Tool is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include A2ATool, AzureAISearchAgentTool, AzureFunctionAgentTool, BingCustomSearchAgentTool, BingGroundingAgentTool, BrowserAutomationAgentTool, CaptureStructuredOutputsTool, CodeInterpreterTool, ComputerUsePreviewTool, MicrosoftFabricAgentTool, FileSearchTool, FunctionTool, ImageGenTool, LocalShellTool, MCPTool, MemorySearchTool, OpenApiAgentTool, SharepointAgentTool and WebSearchPreviewTool.

The ToolArgumentBinding.

The ToolChoiceObject. Please note ToolChoiceObject is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ToolChoiceObjectCodeInterpreter, ToolChoiceObjectComputer, ToolChoiceObjectFileSearch, ToolChoiceObjectFunction, ToolChoiceObjectImageGen, ToolChoiceObjectMCP and ToolChoiceObjectWebSearch.

The ToolChoiceObjectCodeInterpreter.

The ToolChoiceObjectComputer.

The ToolChoiceObjectFileSearch.

Use this option to force the model to call a specific function.

The ToolChoiceObjectImageGen.

Use this option to force the model to call a specific tool on a remote MCP server.

Note: web_search is not yet available via Azure OpenAI.

A project connection resource.

A set of project connection resources currently used by either the bing_grounding, fabric_dataagent, or sharepoint_grounding tools.

The top log probability of a token.

Unknown version of Annotation.

Unknown version of CodeInterpreterOutput.

Unknown version of ComputerAction.

Unknown version of ComputerToolCallOutputItemOutput.

Unknown version of ItemContent.

Unknown version of ItemParam.

Unknown version of ItemResource.

Unknown version of Location.

Unknown version of OpenApiAuthDetails.

Unknown version of ReasoningItemSummaryPart.

Unknown version of ResponseStreamEvent.

Unknown version of ResponseTextFormatConfiguration.

Unknown version of Tool.

Unknown version of ToolChoiceObject.

Unknown version of WebSearchAction.

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.

The WebSearchAction. Please note WebSearchAction is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WebSearchActionFind, WebSearchActionOpenPage and WebSearchActionSearch.

Action type "find": Searches for a pattern within a loaded page.

Action type "open_page" - Opens a specific URL from search results.

Action type "search" - Performs a web search query.

Note: web_search is not yet available via Azure OpenAI.

The results of a web search tool call. See the web search guide for more information.

The results of a web search tool call. See the web search guide for more information.

The AnnotationType.

Available query types for Azure AI Search tool.

The AzureFunctionBindingType.

The CodeInterpreterToolAutoType.

A computer screenshot image used with the computer use tool.

The ImageGenToolModel.

The ItemType.

The LocalShellExecActionType.

The LocationType.

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 ReasoningItemSummaryPartType.

The ResponseStreamEventType.

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.

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

A tool that can be used to generate a response.

The CodeInterpreterOutputType.

The CodeInterpreterToolCallItemResourceStatus.

The ComparisonFilterType.

The CompoundFilterType.

The ComputerActionClickButton.

The ComputerActionType.

The ComputerToolCallItemResourceStatus.

The ComputerToolCallOutputItemResourceStatus.

The ComputerUsePreviewToolEnvironment.

The FileSearchToolCallItemResourceStatus.

The FunctionToolCallItemResourceStatus.

The FunctionToolCallOutputItemResourceStatus.

The ImageGenToolBackground.

The ImageGenToolCallItemResourceStatus.

The ImageGenToolModeration.

The ImageGenToolOutputFormat.

The ImageGenToolQuality.

The ImageGenToolSize.

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

• 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).

The ItemContentInputAudioFormat.

The ItemContentInputImageDetail.

Multi-modal input and output contents.

The ListAgentsRequestOrder.

The LocalShellToolCallItemResourceStatus.

The LocalShellToolCallOutputItemResourceStatus.

The RankingOptionsRanker.

o-series models only

Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

The ReasoningGenerateSummary.

The ReasoningSummary.

The error code for the response.

The ResponseIncompleteDetailsReason.

The ResponsesMessageItemResourceStatus.

The collection of valid roles for responses message items.

The ResponseStatus.

Specifies the processing type used for serving the request.

• If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.
• If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.
• If set to 'flex' or 'priority', then the request will be processed with the corresponding service tier. Contact sales to learn more about Priority processing.
• When not set, the default behavior is 'auto'.

When the service_tier parameter is set, the response body will include the service_tier value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

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.

The WebSearchActionType.

The WebSearchPreviewToolSearchContextSize.

The WebSearchToolCallItemResourceStatus.