models Package

Classes

A2ATool	An agent implementing the A2A protocol.
AISearchIndexResource	A AI Search Index resource.
AgentClusterInsightResult	Insights from the agent cluster analysis.
AgentClusterInsightsRequest	Insights on set of Agent Evaluation Results.
AgentDefinition	AgentDefinition. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContainerAppAgentDefinition, HostedAgentDefinition, PromptAgentDefinition, WorkflowAgentDefinition
AgentId	AgentId.
AgentObject	AgentObject.
AgentObjectVersions	AgentObjectVersions.
AgentReference	AgentReference.
AgentTaxonomyInput	Input configuration for the evaluation taxonomy when the input type is agent.
AgentVersionObject	AgentVersionObject.
AgenticIdentityCredentials	Agentic identity credential definition.
Annotation	Annotation. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AnnotationFileCitation, AnnotationFilePath, AnnotationUrlCitation
AnnotationFileCitation	A citation to a file.
AnnotationFilePath	A path to a file.
AnnotationUrlCitation	A citation for a web resource used to generate a model response.
ApiErrorResponse	Error response for API failures.
ApiKeyCredentials	API Key Credential definition.
ApproximateLocation	ApproximateLocation.
AsyncUpdateMemoriesLROPoller	Custom AsyncLROPoller for Memory Store update operations.
AsyncUpdateMemoriesLROPollingMethod	A custom polling method implementation for Memory Store updates.
AzureAIAgentTarget	Represents a target specifying an Azure AI agent.
AzureAISearchAgentTool	The input definition information for an Azure AI search tool as used to configure an agent.
AzureAISearchIndex	Azure AI Search Index Definition.
AzureAISearchToolResource	A set of index resources used by the azure_ai_search tool.
AzureFunctionAgentTool	The input definition information for an Azure Function Tool, as used to configure an Agent.
AzureFunctionBinding	The structure for keeping storage queue name and URI.
AzureFunctionDefinition	The definition of Azure function.
AzureFunctionDefinitionFunction	AzureFunctionDefinitionFunction.
AzureFunctionStorageQueue	The structure for keeping storage queue name and URI.
AzureOpenAIModelConfiguration	Azure OpenAI model configuration. The API version would be selected by the service for querying the model.
BaseCredentials	A base class for connection credentials. You probably want to use the sub-classes and not this class directly. Known sub-classes are: EntraIDCredentials, AgenticIdentityCredentials, ApiKeyCredentials, CustomCredential, NoAuthenticationCredentials, SASCredentials
BingCustomSearchAgentTool	The input definition information for a Bing custom search tool as used to configure an agent.
BingCustomSearchConfiguration	A bing custom search configuration.
BingCustomSearchToolParameters	The bing custom search tool parameters.
BingGroundingAgentTool	The input definition information for a bing grounding search tool as used to configure an agent.
BingGroundingSearchConfiguration	Search configuration for Bing Grounding.
BingGroundingSearchToolParameters	The bing grounding search tool parameters.
BlobReference	Blob reference details.
BlobReferenceSasCredential	SAS Credential definition.
BrowserAutomationAgentTool	The input definition information for a Browser Automation Tool, as used to configure an Agent.
BrowserAutomationToolConnectionParameters	Definition of input parameters for the connection used by the Browser Automation Tool.
BrowserAutomationToolParameters	Definition of input parameters for the Browser Automation Tool.
CaptureStructuredOutputsTool	A tool for capturing structured outputs.
ChartCoordinate	Coordinates for the analysis chart.
ChatSummaryMemoryItem	A memory item containing a summary extracted from conversations.
ClusterInsightResult	Insights from the cluster analysis.
ClusterTokenUsage	Token usage for cluster analysis.
CodeBasedEvaluatorDefinition	Code-based evaluator definition using python code.
CodeInterpreterOutput	CodeInterpreterOutput. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CodeInterpreterOutputImage, CodeInterpreterOutputLogs
CodeInterpreterOutputImage	The image output from the code interpreter.
CodeInterpreterOutputLogs	The logs output from the code interpreter.
CodeInterpreterTool	A tool that runs Python code to help generate a response to a prompt.
CodeInterpreterToolAuto	Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
CodeInterpreterToolCallItemParam	A tool call to run code.
CodeInterpreterToolCallItemResource	A tool call to run code.
ComparisonFilter	A filter used to compare a specified attribute key to a given value using a defined comparison operation.
CompoundFilter	Combine multiple filters using and or or.
ComputerAction	ComputerAction. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ComputerActionClick, ComputerActionDoubleClick, ComputerActionDrag, ComputerActionKeyPress, ComputerActionMove, ComputerActionScreenshot, ComputerActionScroll, ComputerActionTypeKeys, ComputerActionWait
ComputerActionClick	A click action.
ComputerActionDoubleClick	A double click action.
ComputerActionDrag	A drag action.
ComputerActionKeyPress	A collection of keypresses the model would like to perform.
ComputerActionMove	A mouse move action.
ComputerActionScreenshot	A screenshot action.
ComputerActionScroll	A scroll action.
ComputerActionTypeKeys	An action to type in text.
ComputerActionWait	A wait action.
ComputerToolCallItemParam	A tool call to a computer use tool. See the computer use guide for more information.
ComputerToolCallItemResource	A tool call to a computer use tool. See the computer use guide for more information.
ComputerToolCallOutputItemOutput	ComputerToolCallOutputItemOutput. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ComputerToolCallOutputItemOutputComputerScreenshot
ComputerToolCallOutputItemOutputComputerScreenshot	ComputerToolCallOutputItemOutputComputerScreenshot.
ComputerToolCallOutputItemParam	The output of a computer tool call.
ComputerToolCallOutputItemResource	The output of a computer tool call.
ComputerToolCallSafetyCheck	A pending safety check for the computer call.
ComputerUsePreviewTool	A tool that controls a virtual computer. Learn more about the computer tool.
Connection	Response from the list and get connections operations.
ContainerAppAgentDefinition	The container app agent definition.
ContinuousEvaluationRuleAction	Evaluation rule action for continuous evaluation.
Coordinate	An x/y coordinate pair, e.g. { x: 100, y: 200 }.
CosmosDBIndex	CosmosDB Vector Store Index Definition.
CreatedBy	CreatedBy.
CronTrigger	Cron based trigger.
CustomCredential	Custom credential definition.
DailyRecurrenceSchedule	Daily recurrence schedule.
DatasetCredential	Represents a reference to a blob for consumption.
DatasetVersion	DatasetVersion Definition. You probably want to use the sub-classes and not this class directly. Known sub-classes are: FileDatasetVersion, FolderDatasetVersion
DeleteAgentResponse	A deleted agent Object.
DeleteAgentVersionResponse	A deleted agent version Object.
DeleteMemoryStoreResult	DeleteMemoryStoreResult.
Deployment	Model Deployment Definition. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ModelDeployment
EmbeddingConfiguration	Embedding configuration class.
EntraIDCredentials	Entra ID credential definition.
Error	Error.
EvalCompareReport	Insights from the evaluation comparison.
EvalResult	Result of the evaluation.
EvalRunResultCompareItem	Metric comparison for a treatment against the baseline.
EvalRunResultComparison	Comparison results for treatment runs against the baseline.
EvalRunResultSummary	Summary statistics of a metric in an evaluation run.
EvaluationComparisonRequest	Evaluation Comparison Request.
EvaluationResultSample	A sample from the evaluation result.
EvaluationRule	Evaluation rule model.
EvaluationRuleAction	Evaluation action model. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContinuousEvaluationRuleAction, HumanEvaluationRuleAction
EvaluationRuleFilter	Evaluation filter model.
EvaluationRunClusterInsightResult	Insights from the evaluation run cluster analysis.
EvaluationRunClusterInsightsRequest	Insights on set of Evaluation Results.
EvaluationScheduleTask	Evaluation task for the schedule.
EvaluationTaxonomy	Evaluation Taxonomy Definition.
EvaluationTaxonomyInput	Input configuration for the evaluation taxonomy. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentTaxonomyInput
EvaluatorDefinition	Base evaluator configuration with discriminator. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CodeBasedEvaluatorDefinition, PromptBasedEvaluatorDefinition
EvaluatorMetric	Evaluator Metric.
EvaluatorVersion	Evaluator Definition.
FabricDataAgentToolParameters	The fabric data agent tool parameters.
FieldMapping	Field mapping configuration class.
FileDatasetVersion	FileDatasetVersion Definition.
FileSearchTool	A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
FileSearchToolCallItemParam	The results of a file search tool call. See the file search guide for more information.
FileSearchToolCallItemParamResult	FileSearchToolCallItemParamResult.
FileSearchToolCallItemResource	The results of a file search tool call. See the file search guide for more information.
FolderDatasetVersion	FileDatasetVersion Definition.
FunctionTool	Defines a function in your own code the model can choose to call. Learn more about function calling.
FunctionToolCallItemParam	A tool call to run a function. See the function calling guide for more information.
FunctionToolCallItemResource	A tool call to run a function. See the function calling guide for more information.
FunctionToolCallOutputItemParam	The output of a function tool call.
FunctionToolCallOutputItemResource	The output of a function tool call.
HostedAgentDefinition	The hosted agent definition. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageBasedHostedAgentDefinition
HourlyRecurrenceSchedule	Hourly recurrence schedule.
HumanEvaluationRuleAction	Evaluation rule action for human evaluation.
ImageBasedHostedAgentDefinition	The image-based deployment definition for a hosted agent.
ImageGenTool	A tool that generates images using a model like gpt-image-1.
ImageGenToolCallItemParam	An image generation request made by the model.
ImageGenToolCallItemResource	An image generation request made by the model.
ImageGenToolInputImageMask	ImageGenToolInputImageMask.
Index	Index resource Definition. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureAISearchIndex, CosmosDBIndex, ManagedAzureAISearchIndex
Insight	The response body for cluster insights.
InsightCluster	A cluster of analysis samples.
InsightModelConfiguration	Configuration of the model used in the insight generation.
InsightRequest	The request of the insights report. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentClusterInsightsRequest, EvaluationComparisonRequest, EvaluationRunClusterInsightsRequest
InsightResult	The result of the insights. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentClusterInsightResult, EvalCompareReport, EvaluationRunClusterInsightResult
InsightSample	A sample from the analysis. You probably want to use the sub-classes and not this class directly. Known sub-classes are: EvaluationResultSample
InsightScheduleTask	Insight task for the schedule.
InsightSummary	Summary of the error cluster analysis.
InsightsMetadata	Metadata about the insights.
ItemContent	ItemContent. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ItemContentInputAudio, ItemContentInputFile, ItemContentInputImage, ItemContentInputText, ItemContentOutputAudio, ItemContentOutputText, ItemContentRefusal
ItemContentInputAudio	An audio input to the model.
ItemContentInputFile	A file input to the model.
ItemContentInputImage	An image input to the model. Learn about image inputs.
ItemContentInputText	A text input to the model.
ItemContentOutputAudio	An audio output from the model.
ItemContentOutputText	A text output from the model.
ItemContentRefusal	A refusal from the model.
ItemParam	Content item used to generate a response. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CodeInterpreterToolCallItemParam, ComputerToolCallItemParam, ComputerToolCallOutputItemParam, FileSearchToolCallItemParam, FunctionToolCallItemParam, FunctionToolCallOutputItemParam, ImageGenToolCallItemParam, ItemReferenceItemParam, LocalShellToolCallItemParam, LocalShellToolCallOutputItemParam, MCPApprovalRequestItemParam, MCPApprovalResponseItemParam, MCPCallItemParam, MCPListToolsItemParam, MemorySearchToolCallItemParam, ResponsesMessageItemParam, ReasoningItemParam, WebSearchToolCallItemParam
ItemReferenceItemParam	An internal identifier for an item to reference.
ItemResource	Content item used to generate a response. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CodeInterpreterToolCallItemResource, ComputerToolCallItemResource, ComputerToolCallOutputItemResource, FileSearchToolCallItemResource, FunctionToolCallItemResource, FunctionToolCallOutputItemResource, ImageGenToolCallItemResource, LocalShellToolCallItemResource, LocalShellToolCallOutputItemResource, MCPApprovalRequestItemResource, MCPApprovalResponseItemResource, MCPCallItemResource, MCPListToolsItemResource, MemorySearchToolCallItemResource, ResponsesMessageItemResource, OAuthConsentRequestItemResource, ReasoningItemResource, StructuredOutputsItemResource, WebSearchToolCallItemResource, WorkflowActionOutputItemResource
LocalShellExecAction	Execute a shell command on the server.
LocalShellTool	A tool that allows the model to execute shell commands in a local environment.
LocalShellToolCallItemParam	A tool call to run a command on the local shell.
LocalShellToolCallItemResource	A tool call to run a command on the local shell.
LocalShellToolCallOutputItemParam	The output of a local shell tool call.
LocalShellToolCallOutputItemResource	The output of a local shell tool call.
Location	Location. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ApproximateLocation
LogProb	The log probability of a token.
MCPApprovalRequestItemParam	A request for human approval of a tool invocation.
MCPApprovalRequestItemResource	A request for human approval of a tool invocation.
MCPApprovalResponseItemParam	A response to an MCP approval request.
MCPApprovalResponseItemResource	A response to an MCP approval request.
MCPCallItemParam	An invocation of a tool on an MCP server.
MCPCallItemResource	An invocation of a tool on an MCP server.
MCPListToolsItemParam	A list of tools available on an MCP server.
MCPListToolsItemResource	A list of tools available on an MCP server.
MCPListToolsTool	A tool available on an MCP server.
MCPTool	Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.
MCPToolAllowedTools1	MCPToolAllowedTools1.
MCPToolRequireApproval1	MCPToolRequireApproval1.
MCPToolRequireApprovalAlways	MCPToolRequireApprovalAlways.
MCPToolRequireApprovalNever	MCPToolRequireApprovalNever.
ManagedAzureAISearchIndex	Managed Azure AI Search Index Definition.
MemoryItem	A single memory item stored in the memory store, containing content and metadata. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ChatSummaryMemoryItem, UserProfileMemoryItem
MemoryOperation	Represents a single memory operation (create, update, or delete) performed on a memory item.
MemorySearchItem	A retrieved memory item from memory search.
MemorySearchOptions	Memory search options.
MemorySearchTool	A tool for integrating memories into the agent.
MemorySearchToolCallItemParam	MemorySearchToolCallItemParam.
MemorySearchToolCallItemResource	MemorySearchToolCallItemResource.
MemoryStoreDefaultDefinition	Default memory store implementation.
MemoryStoreDefaultOptions	Default memory store configurations.
MemoryStoreDefinition	Base definition for memory store configurations. You probably want to use the sub-classes and not this class directly. Known sub-classes are: MemoryStoreDefaultDefinition
MemoryStoreDeleteScopeResult	Response for deleting memories from a scope.
MemoryStoreObject	A memory store that can store and retrieve user memories.
MemoryStoreOperationUsage	Usage statistics of a memory store operation.
MemoryStoreOperationUsageInputTokensDetails	MemoryStoreOperationUsageInputTokensDetails.
MemoryStoreOperationUsageOutputTokensDetails	MemoryStoreOperationUsageOutputTokensDetails.
MemoryStoreSearchResult	Memory search response.
MemoryStoreUpdateCompletedResult	Memory update result.
MemoryStoreUpdateResult	Provides the status of a memory store update operation.
MicrosoftFabricAgentTool	The input definition information for a Microsoft Fabric tool as used to configure an agent.
ModelDeployment	Model Deployment Definition.
ModelDeploymentSku	Sku information.
MonthlyRecurrenceSchedule	Monthly recurrence schedule.
NoAuthenticationCredentials	Credentials that do not require authentication.
OAuthConsentRequestItemResource	Request from the service for the user to perform OAuth consent.
OneTimeTrigger	One-time trigger.
OpenApiAgentTool	The input definition information for an OpenAPI tool as used to configure an agent.
OpenApiAnonymousAuthDetails	Security details for OpenApi anonymous authentication.
OpenApiAuthDetails	authentication details for OpenApiFunctionDefinition. You probably want to use the sub-classes and not this class directly. Known sub-classes are: OpenApiAnonymousAuthDetails, OpenApiManagedAuthDetails, OpenApiProjectConnectionAuthDetails
OpenApiFunctionDefinition	The input definition information for an openapi function.
OpenApiFunctionDefinitionFunction	OpenApiFunctionDefinitionFunction.
OpenApiManagedAuthDetails	Security details for OpenApi managed_identity authentication.
OpenApiManagedSecurityScheme	Security scheme for OpenApi managed_identity authentication.
OpenApiProjectConnectionAuthDetails	Security details for OpenApi project connection authentication.
OpenApiProjectConnectionSecurityScheme	Security scheme for OpenApi managed_identity authentication.
PendingUploadRequest	Represents a request for a pending upload.
PendingUploadResponse	Represents the response for a pending upload request.
Prompt	Reference to a prompt template and its variables. Learn more.
PromptAgentDefinition	The prompt agent definition.
PromptAgentDefinitionText	PromptAgentDefinitionText.
PromptBasedEvaluatorDefinition	Prompt-based evaluator.
ProtocolVersionRecord	A record mapping for a single protocol and its version.
RaiConfig	Configuration for Responsible AI (RAI) content filtering and safety features.
RankingOptions	RankingOptions.
Reasoning	o-series models only Configuration options for reasoning models.
ReasoningItemParam	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 conversation state.
ReasoningItemResource	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 conversation state.
ReasoningItemSummaryPart	ReasoningItemSummaryPart. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ReasoningItemSummaryTextPart
ReasoningItemSummaryTextPart	ReasoningItemSummaryTextPart.
RecurrenceSchedule	Recurrence schedule model. You probably want to use the sub-classes and not this class directly. Known sub-classes are: DailyRecurrenceSchedule, HourlyRecurrenceSchedule, MonthlyRecurrenceSchedule, WeeklyRecurrenceSchedule
RecurrenceTrigger	Recurrence based trigger.
RedTeam	Red team details.
Response	Response.
ResponseCodeInterpreterCallCodeDeltaEvent	Emitted when a partial code snippet is streamed by the code interpreter.
ResponseCodeInterpreterCallCodeDoneEvent	Emitted when the code snippet is finalized by the code interpreter.
ResponseCodeInterpreterCallCompletedEvent	Emitted when the code interpreter call is completed.
ResponseCodeInterpreterCallInProgressEvent	Emitted when a code interpreter call is in progress.
ResponseCodeInterpreterCallInterpretingEvent	Emitted when the code interpreter is actively interpreting the code snippet.
ResponseCompletedEvent	Emitted when the model response is complete.
ResponseContentPartAddedEvent	Emitted when a new content part is added.
ResponseContentPartDoneEvent	Emitted when a content part is done.
ResponseConversation1	ResponseConversation1.
ResponseCreatedEvent	An event that is emitted when a response is created.
ResponseError	An error object returned when the model fails to generate a Response.
ResponseErrorEvent	Emitted when an error occurs.
ResponseFailedEvent	An event that is emitted when a response fails.
ResponseFileSearchCallCompletedEvent	Emitted when a file search call is completed (results found).
ResponseFileSearchCallInProgressEvent	Emitted when a file search call is initiated.
ResponseFileSearchCallSearchingEvent	Emitted when a file search is currently searching.
ResponseFunctionCallArgumentsDeltaEvent	Emitted when there is a partial function-call arguments delta.
ResponseFunctionCallArgumentsDoneEvent	Emitted when function-call arguments are finalized.
ResponseImageGenCallCompletedEvent	Emitted when an image generation tool call has completed and the final image is available.
ResponseImageGenCallGeneratingEvent	Emitted when an image generation tool call is actively generating an image (intermediate state).
ResponseImageGenCallInProgressEvent	Emitted when an image generation tool call is in progress.
ResponseImageGenCallPartialImageEvent	Emitted when a partial image is available during image generation streaming.
ResponseInProgressEvent	Emitted when the response is in progress.
ResponseIncompleteDetails1	ResponseIncompleteDetails1.
ResponseIncompleteEvent	An event that is emitted when a response finishes as incomplete.
ResponseMCPCallArgumentsDeltaEvent	Emitted when there is a delta (partial update) to the arguments of an MCP tool call.
ResponseMCPCallArgumentsDoneEvent	Emitted when the arguments for an MCP tool call are finalized.
ResponseMCPCallCompletedEvent	Emitted when an MCP tool call has completed successfully.
ResponseMCPCallFailedEvent	Emitted when an MCP tool call has failed.
ResponseMCPCallInProgressEvent	Emitted when an MCP tool call is in progress.
ResponseMCPListToolsCompletedEvent	Emitted when the list of available MCP tools has been successfully retrieved.
ResponseMCPListToolsFailedEvent	Emitted when the attempt to list available MCP tools has failed.
ResponseMCPListToolsInProgressEvent	Emitted when the system is in the process of retrieving the list of available MCP tools.
ResponseOutputItemAddedEvent	Emitted when a new output item is added.
ResponseOutputItemDoneEvent	Emitted when an output item is marked done.
ResponsePromptVariables	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.
ResponseQueuedEvent	Emitted when a response is queued and waiting to be processed.
ResponseReasoningDeltaEvent	Emitted when there is a delta (partial update) to the reasoning content.
ResponseReasoningDoneEvent	Emitted when the reasoning content is finalized for an item.
ResponseReasoningSummaryDeltaEvent	Emitted when there is a delta (partial update) to the reasoning summary content.
ResponseReasoningSummaryDoneEvent	Emitted when the reasoning summary content is finalized for an item.
ResponseReasoningSummaryPartAddedEvent	Emitted when a new reasoning summary part is added.
ResponseReasoningSummaryPartDoneEvent	Emitted when a reasoning summary part is completed.
ResponseReasoningSummaryTextDeltaEvent	Emitted when a delta is added to a reasoning summary text.
ResponseReasoningSummaryTextDoneEvent	Emitted when a reasoning summary text is completed.
ResponseRefusalDeltaEvent	Emitted when there is a partial refusal text.
ResponseRefusalDoneEvent	Emitted when refusal text is finalized.
ResponseStreamEvent	ResponseStreamEvent. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ResponseErrorEvent, ResponseCodeInterpreterCallCompletedEvent, ResponseCodeInterpreterCallInProgressEvent, ResponseCodeInterpreterCallInterpretingEvent, ResponseCodeInterpreterCallCodeDeltaEvent, ResponseCodeInterpreterCallCodeDoneEvent, 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, ResponseReasoningDeltaEvent, ResponseReasoningDoneEvent, ResponseReasoningSummaryDeltaEvent, ResponseReasoningSummaryDoneEvent, ResponseReasoningSummaryPartAddedEvent, ResponseReasoningSummaryPartDoneEvent, ResponseReasoningSummaryTextDeltaEvent, ResponseReasoningSummaryTextDoneEvent, ResponseRefusalDeltaEvent, ResponseRefusalDoneEvent, ResponseWebSearchCallCompletedEvent, ResponseWebSearchCallInProgressEvent, ResponseWebSearchCallSearchingEvent
ResponseText	ResponseText.
ResponseTextDeltaEvent	Emitted when there is an additional text delta.
ResponseTextDoneEvent	Emitted when text content is finalized.
ResponseTextFormatConfiguration	ResponseTextFormatConfiguration. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ResponseTextFormatConfigurationJsonObject, ResponseTextFormatConfigurationJsonSchema, ResponseTextFormatConfigurationText
ResponseTextFormatConfigurationJsonObject	ResponseTextFormatConfigurationJsonObject.
ResponseTextFormatConfigurationJsonSchema	JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.
ResponseTextFormatConfigurationText	ResponseTextFormatConfigurationText.
ResponseUsage	Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.
ResponseWebSearchCallCompletedEvent	Note: web_search is not yet available via Azure OpenAI.
ResponseWebSearchCallInProgressEvent	Note: web_search is not yet available via Azure OpenAI.
ResponseWebSearchCallSearchingEvent	Note: web_search is not yet available via Azure OpenAI.
ResponsesAssistantMessageItemParam	A message parameter item with the assistant role.
ResponsesAssistantMessageItemResource	A message resource item with the assistant role.
ResponsesDeveloperMessageItemParam	A message parameter item with the developer role.
ResponsesDeveloperMessageItemResource	A message resource item with the developer role.
ResponsesMessageItemParam	A response message item, representing a role and content, as provided as client request parameters. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ResponsesAssistantMessageItemParam, ResponsesDeveloperMessageItemParam, ResponsesSystemMessageItemParam, ResponsesUserMessageItemParam
ResponsesMessageItemResource	A response message resource item, representing a role and content, as provided on service responses. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ResponsesAssistantMessageItemResource, ResponsesDeveloperMessageItemResource, ResponsesSystemMessageItemResource, ResponsesUserMessageItemResource
ResponsesSystemMessageItemParam	A message parameter item with the system role.
ResponsesSystemMessageItemResource	A message resource item with the system role.
ResponsesUserMessageItemParam	A message parameter item with the user role.
ResponsesUserMessageItemResource	A message resource item with the user role.
SASCredentials	Shared Access Signature (SAS) credential definition.
Schedule	Schedule model.
ScheduleRun	Schedule run model.
ScheduleTask	Schedule task model. You probably want to use the sub-classes and not this class directly. Known sub-classes are: EvaluationScheduleTask, InsightScheduleTask
SharepointAgentTool	The input definition information for a sharepoint tool as used to configure an agent.
SharepointGroundingToolParameters	The sharepoint grounding tool parameters.
StructuredInputDefinition	An structured input that can participate in prompt template substitutions and tool argument binding.
StructuredOutputDefinition	A structured output that can be produced by the agent.
StructuredOutputsItemResource	StructuredOutputsItemResource.
Target	Base class for targets with discriminator support. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureAIAgentTarget, AzureAIAssistantTarget, AzureAIModelTarget
TargetConfig	Abstract class for target configuration. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureOpenAIModelConfiguration
TaxonomyCategory	Taxonomy category definition.
TaxonomySubCategory	Taxonomy sub-category definition.
Tool	Tool. You probably want to use the sub-classes and not this class directly. Known sub-classes are: A2ATool, AzureAISearchAgentTool, AzureFunctionAgentTool, BingCustomSearchAgentTool, BingGroundingAgentTool, BrowserAutomationAgentTool, CaptureStructuredOutputsTool, CodeInterpreterTool, ComputerUsePreviewTool, MicrosoftFabricAgentTool, FileSearchTool, FunctionTool, ImageGenTool, LocalShellTool, MCPTool, MemorySearchTool, OpenApiAgentTool, SharepointAgentTool, WebSearchPreviewTool
ToolChoiceObject	ToolChoiceObject. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ToolChoiceObjectCodeInterpreter, ToolChoiceObjectComputer, ToolChoiceObjectFileSearch, ToolChoiceObjectFunction, ToolChoiceObjectImageGen, ToolChoiceObjectMCP, ToolChoiceObjectWebSearch
ToolChoiceObjectCodeInterpreter	ToolChoiceObjectCodeInterpreter.
ToolChoiceObjectComputer	ToolChoiceObjectComputer.
ToolChoiceObjectFileSearch	ToolChoiceObjectFileSearch.
ToolChoiceObjectFunction	Use this option to force the model to call a specific function.
ToolChoiceObjectImageGen	ToolChoiceObjectImageGen.
ToolChoiceObjectMCP	Use this option to force the model to call a specific tool on a remote MCP server.
ToolChoiceObjectWebSearch	Note: web_search is not yet available via Azure OpenAI.
ToolDescription	Description of a tool that can be used by an agent.
ToolProjectConnection	A project connection resource.
TopLogProb	The top log probability of a token.
Trigger	Base model for Trigger of the schedule. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CronTrigger, OneTimeTrigger, RecurrenceTrigger
UpdateMemoriesLROPoller	Custom LROPoller for Memory Store update operations.
UpdateMemoriesLROPollingMethod	A custom polling method implementation for Memory Store updates.
UserProfileMemoryItem	A memory item specifically containing user profile information extracted from conversations, such as preferences, interests, and personal details.
VectorStoreFileAttributes	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.
WebSearchAction	WebSearchAction. You probably want to use the sub-classes and not this class directly. Known sub-classes are: WebSearchActionFind, WebSearchActionOpenPage, WebSearchActionSearch
WebSearchActionFind	Action type "find": Searches for a pattern within a loaded page.
WebSearchActionOpenPage	Action type "open_page" - Opens a specific URL from search results.
WebSearchActionSearch	Action type "search" - Performs a web search query.
WebSearchActionSearchSources	WebSearchActionSearchSources.
WebSearchPreviewTool	Note: web_search is not yet available via Azure OpenAI.
WebSearchToolCallItemParam	The results of a web search tool call. See the web search guide for more information.
WebSearchToolCallItemResource	The results of a web search tool call. See the web search guide for more information.
WeeklyRecurrenceSchedule	Weekly recurrence schedule.
WorkflowActionOutputItemResource	WorkflowActionOutputItemResource.
WorkflowAgentDefinition	The workflow agent definition.

Enums

AgentKind	Type of AgentKind.
AgentProtocol	Type of AgentProtocol.
AnnotationType	Type of AnnotationType.
AttackStrategy	Strategies for attacks.
AzureAISearchQueryType	Available query types for Azure AI Search tool.
CodeInterpreterOutputType	Type of CodeInterpreterOutputType.
ComputerActionType	Type of ComputerActionType.
ComputerToolCallOutputItemOutputType	A computer screenshot image used with the computer use tool.
ConnectionType	The Type (or category) of the connection.
CredentialType	The credential type used by the connection.
DatasetType	Enum to determine the type of data.
DayOfWeek	Days of the week for recurrence schedule.
DeploymentType	Type of DeploymentType.
EvaluationRuleActionType	Type of the evaluation action.
EvaluationRuleEventType	Type of the evaluation rule event.
EvaluationTaxonomyInputType	Type of the evaluation taxonomy input.
EvaluatorCategory	The category of the evaluator.
EvaluatorDefinitionType	The type of evaluator definition.
EvaluatorMetricDirection	The direction of the metric indicating whether a higher value is better, a lower value is better, or neutral.
EvaluatorMetricType	The type of the evaluator.
EvaluatorType	The type of the evaluator.
IndexType	Type of IndexType.
InsightType	The request of the insights.
ItemContentType	Multi-modal input and output contents.
ItemType	Type of ItemType.
LocationType	Type of LocationType.
MemoryItemKind	Memory item kind.
MemoryOperationKind	Memory operation kind.
MemoryStoreKind	The type of memory store implementation to use.
MemoryStoreUpdateStatus	Status of a memory store update operation.
OpenApiAuthType	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).
OperationState	Enum describing allowed operation states.
PendingUploadType	The type of pending upload.
ReasoningEffort	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.
ReasoningItemSummaryPartType	Type of ReasoningItemSummaryPartType.
RecurrenceType	Recurrence type.
ResponseErrorCode	The error code for the response.
ResponseStreamEventType	Type of ResponseStreamEventType.
ResponseTextFormatConfigurationType	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.
ResponsesMessageRole	The collection of valid roles for responses message items.
RiskCategory	Risk category for the attack objective.
SampleType	The type of sample used in the analysis.
ScheduleProvisioningStatus	Schedule provisioning status.
ScheduleTaskType	Type of the task.
ServiceTier	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.
ToolChoiceObjectType	Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
ToolChoiceOptions	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.
ToolType	A tool that can be used to generate a response.
TreatmentEffectType	Treatment Effect Type.
TriggerType	Type of the trigger.
WebSearchActionType	Type of WebSearchActionType.