models Package

An agent implementing the A2A protocol.

A AI Search Index resource.

AgentBlueprintReference.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ManagedAgentIdentityBlueprintReference

AgentCard.

AgentCardSkill.

Insights on set of Agent Evaluation Results.

Insights from the agent cluster analysis.

AgentDefinition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: HostedAgentDefinition, PromptAgentDefinition, WorkflowAgentDefinition

AgentDetails.

AgentEndpoint.

AgentEndpointAuthorizationScheme.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: BotServiceAuthorizationScheme, BotServiceRbacAuthorizationScheme, EntraAuthorizationScheme

AgentIdentity.

AgentObjectVersions.

An agent session providing a long-lived compute sandbox for hosted agent invocations.

Input configuration for the evaluation taxonomy when the input type is agent.

AgentVersionDetails.

Agentic identity credential definition.

ApiError.

Error response for API failures.

API Key Credential definition.

Apply patch tool.

ApproximateLocation.

Custom AsyncLROPoller for Memory Store update operations.

Automatic Code Interpreter Tool Parameters.

Represents a target specifying an Azure AI agent.

Represents a target specifying an Azure AI agent.

Represents a data source for benchmark evaluation runs.

AzureAIDataSourceConfig.

Represents a target specifying an Azure AI model for operations requiring model selection.

Represents a target specifying an Azure AI model for operations requiring model selection.

Represents a data source for evaluation runs that are specific to Continuous Evaluation scenarios.

Azure AI Search Index Definition.

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 structure for keeping storage queue name and URI.

The definition of Azure function.

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.

Azure OpenAI model configuration. The API version would be selected by the service for querying the model.

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

A bing custom search configuration.

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

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.

Blob reference details.

SAS Credential definition.

BotServiceAuthorizationScheme.

BotServiceRbacAuthorizationScheme.

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.

Coordinates for the analysis chart.

A memory item containing a summary extracted from conversations.

Insights from the cluster analysis.

Token usage for cluster analysis.

Code-based evaluator definition using python code.

Code-based deployment configuration for a hosted agent.

Code interpreter.

Comparison Filter.

Compound Filter.

Computer use preview.

Response from the list and get connections operations.

ContainerAutoParam.

Container-based deployment configuration for a hosted agent.

ContainerNetworkPolicyAllowlistParam.

ContainerNetworkPolicyDisabledParam.

ContainerNetworkPolicyDomainSecretParam.

Network access policy for the container.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContainerNetworkPolicyAllowlistParam, ContainerNetworkPolicyDisabledParam

ContainerSkill.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: InlineSkillParam, SkillReferenceParam

Evaluation rule action for continuous evaluation.

CosmosDB Vector Store Index Definition.

Cron based trigger.

Custom credential definition.

Grammar format.

Text format.

Custom tool.

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

Daily recurrence schedule.

Represents a reference to a blob for consumption.

DatasetVersion Definition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: FileDatasetVersion, FolderDatasetVersion

A deleted agent Object.

A deleted agent version Object.

DeleteMemoryStoreResult.

A deleted skill Object.

Model Deployment Definition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ModelDeployment

Embedding configuration class.

EntraAuthorizationScheme.

Entra ID credential definition.

EntraIsolationKeySource.

Represents a CSV data source by file ID.

Represents a CSV data source for evaluation runs.

Result of the evaluation.

Metric comparison for a treatment against the baseline.

Comparison results for treatment runs against the baseline.

Summary statistics of a metric in an evaluation run.

Evaluation Comparison Request.

Insights from the evaluation comparison.

A sample from the evaluation result.

Evaluation rule model.

Evaluation action model.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContinuousEvaluationRuleAction, HumanEvaluationPreviewRuleAction

Evaluation filter model.

Insights on set of Evaluation Results.

Insights from the evaluation run cluster analysis.

Evaluation task for the schedule.

Evaluation Taxonomy Definition.

Input configuration for the evaluation taxonomy.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentTaxonomyInput

Base evaluator configuration with discriminator.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CodeBasedEvaluatorDefinition, PromptBasedEvaluatorDefinition

Evaluator Metric.

Evaluator Definition.

The fabric data agent tool parameters.

Field mapping configuration class.

FileDatasetVersion Definition.

File search.

FixedRatioVersionSelectionRule.

FileDatasetVersion Definition.

Shell tool.

FunctionShellToolParamEnvironment.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContainerAutoParam, FunctionShellToolParamEnvironmentContainerReferenceParam, FunctionShellToolParamEnvironmentLocalEnvironmentParam

FunctionShellToolParamEnvironmentContainerReferenceParam.

FunctionShellToolParamEnvironmentLocalEnvironmentParam.

Function.

HeaderIsolationKeySource.

Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header.

The hosted agent definition.

Hourly recurrence schedule.

Evaluation rule action for human evaluation.

HybridSearchOptions.

Image generation tool.

ImageGenToolInputImageMask.

Index resource Definition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureAISearchIndex, CosmosDBIndex, ManagedAzureAISearchIndex

InlineSkillParam.

Inline skill payload.

The response body for cluster insights.

A cluster of analysis samples.

Configuration of the model used in the insight generation.

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

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

A sample from the analysis.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EvaluationResultSample

Insight task for the schedule.

Summary of the error cluster analysis.

Metadata about the insights.

IsolationKeySource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EntraIsolationKeySource, HeaderIsolationKeySource

Local shell tool.

LocalSkillParam.

MCP tool.

MCP tool filter.

MCPToolRequireApproval.

ManagedAgentIdentityBlueprintReference.

Managed Azure AI Search Index Definition.

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

Represents a single memory operation (create, update, or delete) performed on a memory item.

A retrieved memory item from memory search.

Memory search options.

A tool for integrating memories into the agent.

Default memory store implementation.

Default memory store configurations.

Base definition for memory store configurations.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MemoryStoreDefaultDefinition

Response for deleting memories from a scope.

A memory store that can store and retrieve user memories.

Usage statistics of a memory store operation.

Memory search response.

Memory update result.

Provides the status of a memory store update operation.

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

Model Deployment Definition.

Sku information.

Represents a set of parameters used to control the sampling behavior of a language model during text generation.

Represents a set of parameters used to control the sampling behavior of a language model during text generation.

Monthly recurrence schedule.

Credentials that do not require authentication.

One-time trigger.

Security details for OpenApi anonymous authentication.

authentication details for OpenApiFunctionDefinition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: OpenApiAnonymousAuthDetails, OpenApiManagedAuthDetails, OpenApiProjectConnectionAuthDetails

The input definition information for an openapi function.

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 OTLP (OpenTelemetry Protocol) telemetry export endpoint.

Represents a request for a pending upload.

Represents the response for a pending upload request.

The prompt agent definition.

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

Prompt-based evaluator.

A record mapping for a single protocol and its version.

Configuration for Responsible AI (RAI) content filtering and safety features.

RankingOptions.

Reasoning.

Recurrence schedule model.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DailyRecurrenceSchedule, HourlyRecurrenceSchedule, MonthlyRecurrenceSchedule, WeeklyRecurrenceSchedule

Recurrence based trigger.

Red team details.

RedTeamEvalRunDataSource.

Represents the parameters for response retrieval item generation.

ResponseUsageInputTokensDetails.

ResponseUsageOutputTokensDetails.

Shared Access Signature (SAS) credential definition.

Schedule model.

Schedule run model.

Schedule task model.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EvaluationScheduleTask, InsightScheduleTask

A single entry in a directory listing.

Response from listing a directory in a session sandbox.

Response from uploading a file to a session sandbox.

A single Server-Sent Event frame emitted by the hosted agent session log stream.

Each frame contains an event field identifying the event type and a data field carrying the payload as plain text. Although the current data payload is JSON-formatted, its schema is not contractual — additional keys may appear and the format may change over time. Clients should treat data as an opaque string and optionally attempt JSON parsing.

New event types may be added in the future. Clients should gracefully ignore unrecognized event types.

Wire format:

   event: log
   data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting server on port 18080"}

   event: log
   data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"}

The sharepoint grounding tool parameters.

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

A skill object.

SkillReferenceParam.

Specific apply patch tool choice.

Specific shell tool choice.

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

A structured output that can be produced by the agent.

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

Represents a data source for target-based completion evaluation configuration.

Abstract class for target configuration.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureOpenAIModelConfiguration

Taxonomy category definition.

Taxonomy sub-category definition.

Customer-supplied telemetry configuration for exporting container logs, traces, and metrics.

A telemetry export endpoint configuration.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: OtlpTelemetryEndpoint

Authentication configuration for a telemetry endpoint.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: HeaderTelemetryEndpointAuth

AzureAIEvaluatorGrader.

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: TextResponseFormatJsonObject, TextResponseFormatJsonSchema, TextResponseFormatText

JSON object.

JSON schema.

Text.

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, WorkIQPreviewTool

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.

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.

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

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.

Description of a tool that can be used by an agent.

Description of a tool that can be used by an agent.

A project connection resource.

A toolbox that stores reusable tool definitions for agents.

Policy configuration for a toolbox, including content safety and other governance settings.

A specific version of a toolbox.

Represents a data source for evaluation runs that operate over Agent traces stored in Application Insights.

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

Custom LROPoller for Memory Store update operations.

UpdateToolboxRequest.

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

Version indicator determining which agent version backs the session.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: VersionRefIndicator

Version indicator that references a specific agent version by name.

VersionSelectionRule.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: FixedRatioVersionSelectionRule

VersionSelector.

Web search approximate location.

A web search configuration for bing custom search.

Web search preview.

Web search.

WebSearchToolFilters.

Weekly recurrence schedule.

A WorkIQ server-side tool.

The WorkIQ tool parameters.

The workflow agent definition.

Type of AgentBlueprintReferenceType.

Type of AgentEndpointAuthorizationSchemeType.

Type of AgentEndpointProtocol.

Type of AgentKind.

Type of AgentObjectType.

Type of AgentProtocol.

The status of an agent session.

The provisioning status of an agent version.

Strategies for attacks.

Available query types for Azure AI Search tool.

Type of ComputerEnvironment.

The Type (or category) of the connection.

Type of ContainerMemoryLimit.

Type of ContainerNetworkPolicyParamType.

Type of ContainerSkillType.

The credential type used by the connection.

Type of CustomToolParamFormatType.

Enum to determine the type of data.

Days of the week for recurrence schedule.

Type of DeploymentType.

Type of the evaluation action.

Type of the evaluation rule event.

Type of the evaluation taxonomy input.

The category of the evaluator.

The type of evaluator definition.

The direction of the metric indicating whether a higher value is better, a lower value is better, or neutral.

The type of the evaluator.

The type of the evaluator.

Type of FunctionShellToolParamEnvironmentType.

Type of GrammarSyntax1.

Type of ImageGenAction.

Type of IndexType.

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.

The request of the insights.

Type of IsolationKeySourceKind.

Memory item kind.

Memory operation kind.

The type of memory store implementation to use.

Type of MemoryStoreObjectType.

Status of a memory store update operation.

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

Enum describing allowed operation states.

Type of PageOrder.

The type of pending upload.

Type of RankerVersionType.

Recurrence type.

Risk category for the attack objective.

The type of sample used in the analysis.

Schedule provisioning status.

Type of the task.

Type of SearchContextSize.

Known SSE event types emitted by the hosted agent session log stream. Additional event types may be introduced in future versions.

The type of telemetry data to export.

The type of authentication for a telemetry endpoint.

The kind of telemetry export endpoint.

The transport protocol for telemetry export.

Type of TextResponseFormatConfigurationType.

Type of ToolChoiceParamType.

Type of ToolType.

Treatment Effect Type.

Type of the trigger.

The type of version indicator used to determine the agent version backing a session.

Type of VersionSelectorType.