models Package

Classes

A2APreviewTool	An agent implementing the A2A protocol.
AISearchIndexResource	A AI Search Index resource.
AgentClusterInsightRequest	Insights on set of Agent Evaluation Results.
AgentClusterInsightResult	Insights from the agent cluster analysis.
AgentDefinition	AgentDefinition. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContainerAppAgentDefinition, HostedAgentDefinition, PromptAgentDefinition, WorkflowAgentDefinition
AgentDetails	AgentDetails.
AgentObjectVersions	AgentObjectVersions.
AgentTaxonomyInput	Input configuration for the evaluation taxonomy when the input type is agent.
AgentVersionDetails	AgentVersionDetails.
AgenticIdentityPreviewCredentials	Agentic identity credential definition.
ApiError	ApiError.
ApiErrorResponse	Error response for API failures.
ApiKeyCredentials	API Key Credential definition.
ApplyPatchToolParam	Apply patch tool.
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.
AzureAIModelTarget	Represents a target specifying an Azure AI model for operations requiring model selection.
AzureAISearchIndex	Azure AI Search Index Definition.
AzureAISearchTool	The input definition information for an Azure AI search tool as used to configure an agent.
AzureAISearchToolResource	A set of index resources used by the azure_ai_search tool.
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.
AzureFunctionTool	The input definition information for an Azure Function Tool, as used to configure an Agent.
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, AgenticIdentityPreviewCredentials, ApiKeyCredentials, CustomCredential, NoAuthenticationCredentials, SASCredentials
BingCustomSearchConfiguration	A bing custom search configuration.
BingCustomSearchPreviewTool	The input definition information for a Bing custom search tool as used to configure an agent.
BingCustomSearchToolParameters	The bing custom search tool parameters.
BingGroundingSearchConfiguration	Search configuration for Bing Grounding.
BingGroundingSearchToolParameters	The bing grounding search tool parameters.
BingGroundingTool	The input definition information for a bing grounding search tool as used to configure an agent.
BlobReference	Blob reference details.
BlobReferenceSasCredential	SAS Credential definition.
BrowserAutomationPreviewTool	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.
CodeInterpreterContainerAuto	CodeInterpreterToolAuto.
CodeInterpreterTool	Code interpreter.
ComparisonFilter	Comparison Filter.
CompoundFilter	Compound Filter.
ComputerUsePreviewTool	Computer use preview.
Connection	Response from the list and get connections operations.
ContainerAppAgentDefinition	The container app agent definition.
ContinuousEvaluationRuleAction	Evaluation rule action for continuous evaluation.
CosmosDBIndex	CosmosDB Vector Store Index Definition.
CronTrigger	Cron based trigger.
CustomCredential	Custom credential definition.
CustomGrammarFormatParam	Grammar format.
CustomTextFormatParam	Text format.
CustomToolParam	Custom tool.
CustomToolParamFormat	The input format for the custom tool. Default is unconstrained text. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CustomGrammarFormatParam, CustomTextFormatParam
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.
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.
EvaluationComparisonInsightRequest	Evaluation Comparison Request.
EvaluationComparisonInsightResult	Insights from the evaluation comparison.
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, HumanEvaluationPreviewRuleAction
EvaluationRuleFilter	Evaluation filter model.
EvaluationRunClusterInsightRequest	Insights on set of Evaluation Results.
EvaluationRunClusterInsightResult	Insights from the evaluation run cluster analysis.
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	File search.
FolderDatasetVersion	FileDatasetVersion Definition.
FunctionShellToolParam	Shell tool.
FunctionTool	Function.
HostedAgentDefinition	The hosted agent definition.
HourlyRecurrenceSchedule	Hourly recurrence schedule.
HumanEvaluationPreviewRuleAction	Evaluation rule action for human evaluation.
HybridSearchOptions	HybridSearchOptions.
ImageGenTool	Image generation tool.
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: AgentClusterInsightRequest, EvaluationComparisonInsightRequest, EvaluationRunClusterInsightRequest
InsightResult	The result of the insights. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentClusterInsightResult, EvaluationComparisonInsightResult, 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.
LocalShellToolParam	Local shell tool.
MCPTool	MCP tool.
MCPToolFilter	MCP tool filter.
MCPToolRequireApproval	MCPToolRequireApproval.
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.
MemorySearchPreviewTool	A tool for integrating memories into the agent.
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.
MemoryStoreDetails	A memory store that can store and retrieve user memories.
MemoryStoreOperationUsage	Usage statistics of a memory store operation.
MemoryStoreSearchResult	Memory search response.
MemoryStoreUpdateCompletedResult	Memory update result.
MemoryStoreUpdateResult	Provides the status of a memory store update operation.
MicrosoftFabricPreviewTool	The input definition information for a Microsoft Fabric tool as used to configure an agent.
ModelDeployment	Model Deployment Definition.
ModelDeploymentSku	Sku information.
ModelSamplingParams	Represents a set of parameters used to control the sampling behavior of a language model during text generation.
MonthlyRecurrenceSchedule	Monthly recurrence schedule.
NoAuthenticationCredentials	Credentials that do not require authentication.
OneTimeTrigger	One-time trigger.
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.
OpenApiTool	The input definition information for an OpenAPI tool as used to configure an agent.
PendingUploadRequest	Represents a request for a pending upload.
PendingUploadResponse	Represents the response for a pending upload request.
PromptAgentDefinition	The prompt agent definition.
PromptAgentDefinitionTextOptions	Configuration options for a text response from the model. Can be plain text or structured JSON data.
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	Reasoning.
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.
ResponseUsageInputTokensDetails	ResponseUsageInputTokensDetails.
ResponseUsageOutputTokensDetails	ResponseUsageOutputTokensDetails.
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
SharepointGroundingToolParameters	The sharepoint grounding tool parameters.
SharepointPreviewTool	The input definition information for a sharepoint tool as used to configure an agent.
SpecificApplyPatchParam	Specific apply patch tool choice.
SpecificFunctionShellParam	Specific shell tool choice.
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.
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, 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.
TextResponseFormatConfiguration	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. You probably want to use the sub-classes and not this class directly. Known sub-classes are: TextResponseFormatConfigurationResponseFormatJsonObject, TextResponseFormatJsonSchema, TextResponseFormatConfigurationResponseFormatText
TextResponseFormatConfigurationResponseFormatJsonObject	JSON object.
TextResponseFormatConfigurationResponseFormatText	Text.
TextResponseFormatJsonSchema	JSON schema.
Tool	A tool that can be used to generate a response. You probably want to use the sub-classes and not this class directly. Known sub-classes are: A2APreviewTool, ApplyPatchToolParam, AzureAISearchTool, AzureFunctionTool, BingCustomSearchPreviewTool, BingGroundingTool, BrowserAutomationPreviewTool, CaptureStructuredOutputsTool, CodeInterpreterTool, ComputerUsePreviewTool, CustomToolParam, MicrosoftFabricPreviewTool, FileSearchTool, FunctionTool, ImageGenTool, LocalShellToolParam, MCPTool, MemorySearchPreviewTool, OpenApiTool, SharepointPreviewTool, FunctionShellToolParam, WebSearchTool, WebSearchPreviewTool
ToolChoiceAllowed	Allowed tools.
ToolChoiceCodeInterpreter	Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
ToolChoiceComputerUsePreview	Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
ToolChoiceCustom	Custom tool.
ToolChoiceFileSearch	Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
ToolChoiceFunction	Function tool.
ToolChoiceImageGeneration	Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
ToolChoiceMCP	MCP tool.
ToolChoiceParam	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. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ToolChoiceAllowed, SpecificApplyPatchParam, ToolChoiceCodeInterpreter, ToolChoiceComputerUsePreview, ToolChoiceCustom, ToolChoiceFileSearch, ToolChoiceFunction, ToolChoiceImageGeneration, ToolChoiceMCP, SpecificFunctionShellParam, ToolChoiceWebSearchPreview, ToolChoiceWebSearchPreview20250311
ToolChoiceWebSearchPreview	Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
ToolChoiceWebSearchPreview20250311	Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
ToolDescription	Description of a tool that can be used by an agent.
ToolProjectConnection	A project connection resource.
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.
WebSearchApproximateLocation	Web search approximate location.
WebSearchConfiguration	A web search configuration for bing custom search.
WebSearchPreviewTool	Web search preview.
WebSearchTool	Web search.
WebSearchToolFilters	WebSearchToolFilters.
WeeklyRecurrenceSchedule	Weekly recurrence schedule.
WorkflowAgentDefinition	The workflow agent definition.

Enums

AgentKind	Type of AgentKind.
AgentObjectType	Type of AgentObjectType.
AgentProtocol	Type of AgentProtocol.
AttackStrategy	Strategies for attacks.
AzureAISearchQueryType	Available query types for Azure AI Search tool.
ComputerEnvironment	Type of ComputerEnvironment.
ConnectionType	The Type (or category) of the connection.
ContainerMemoryLimit	Type of ContainerMemoryLimit.
CredentialType	The credential type used by the connection.
CustomToolParamFormatType	Type of CustomToolParamFormatType.
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.
FoundryFeaturesOptInKeys	Type of FoundryFeaturesOptInKeys.
GrammarSyntax1	Type of GrammarSyntax1.
IndexType	Type of IndexType.
InputFidelity	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. Unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.
InsightType	The request of the insights.
MemoryItemKind	Memory item kind.
MemoryOperationKind	Memory operation kind.
MemoryStoreKind	The type of memory store implementation to use.
MemoryStoreObjectType	Type of MemoryStoreObjectType.
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.
PageOrder	Type of PageOrder.
PendingUploadType	The type of pending upload.
RankerVersionType	Type of RankerVersionType.
RecurrenceType	Recurrence type.
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.
SearchContextSize	Type of SearchContextSize.
TextResponseFormatConfigurationType	Type of TextResponseFormatConfigurationType.
ToolChoiceParamType	Type of ToolChoiceParamType.
ToolType	Type of ToolType.
TreatmentEffectType	Treatment Effect Type.
TriggerType	Type of the trigger.