models Package

Classes

A2APreviewTool	An agent implementing the A2A protocol.
A2APreviewToolboxTool	An A2A tool stored in a toolbox.
A2AProtocolConfiguration	Configuration specific to the A2A protocol.
A2ATool	An agent implementing the A2A protocol.
A2AToolboxTool	An A2A tool stored in a toolbox.
AISearchIndexResource	A AI Search Index resource.
ActivityProtocolConfiguration	Configuration specific to the activity protocol.
AgentBlueprintReference	AgentBlueprintReference. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ManagedAgentIdentityBlueprintReference
AgentCard	AgentCard.
AgentCardSkill	AgentCardSkill.
AgentClusterInsightRequest	Insights on set of Agent Evaluation Results.
AgentClusterInsightResult	Insights from the agent cluster analysis.
AgentDataGenerationJobSource	Agent source for data generation jobs — references an agent to fetch instructions and metadata from.
AgentDefinition	AgentDefinition. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ExternalAgentDefinition, HostedAgentDefinition, PromptAgentDefinition, VoiceAgentDefinition, WorkflowAgentDefinition
AgentDetails	AgentDetails.
AgentEndpointAuthorizationScheme	AgentEndpointAuthorizationScheme. You probably want to use the sub-classes and not this class directly. Known sub-classes are: BotServiceAuthorizationScheme, BotServiceRbacAuthorizationScheme, BotServiceTenantAuthorizationScheme, EntraAuthorizationScheme
AgentEndpointConfig	AgentEndpointConfig.
AgentEvaluatorGenerationJobSource	Agent source for evaluator generation jobs — references an agent to fetch instructions and metadata from.
AgentHarness	A managed runtime and agent loop used to execute a prompt agent. You probably want to use the sub-classes and not this class directly. Known sub-classes are: GitHubCopilotHarness
AgentIdentity	AgentIdentity.
AgentInsight	A persisted issue discovered from an agent's traces.
AgentInsightDetails	Additional insight details. Omitted unless details are requested.
AgentInsightEstimatedCost	Estimated Agent Insights cost.
AgentInsightHighlightedTrace	A highlighted trace that provides evidence for an agent insight.
AgentInsightLinkedTrace	A lightweight trace reference linked to an agent insight as supporting evidence.
AgentInsightMonitor	A per-agent Agent Insights monitor that owns configuration, runs, and discovered insights.
AgentInsightMonitorCreate	Fields accepted when creating an Agent Insights monitor for an agent.
AgentInsightMonitorListItem	An Agent Insights monitor summary returned by list operations.
AgentInsightMonitorUpdate	Fields that can be updated on an Agent Insights monitor.
AgentInsightProposedFix	A recommended fix for an agent insight.
AgentInsightProposedFixChange	A customer-renderable change in a proposed fix.
AgentInsightRecommendedAction	The recommended remediation for an agent insight.
AgentInsightRun	A long-running run that analyzes one agent's traces and updates that agent's insights.
AgentInsightRunCreate	Inputs used when creating an agent insight run.
AgentInsightRunLROPoller	Custom LROPoller for Agent Insights run operations.
AgentInsightRunResult	Result statistics produced when an agent insight run succeeds.
AgentInsightSuspension	Structured reason why scheduled generation is suspended for a monitor.
AgentInsightTokenUsage	Token usage for an Agent Insights run.
AgentInsightUpdate	Fields that can be updated on an agent insight.
AgentInsightsOverview	The effective overview for an Agent Insights monitor.
AgentInsightsOverviewOverride	A user-provided overview that becomes effective immediately and seeds the next generation.
AgentObjectVersions	AgentObjectVersions.
AgentOptimizationCandidate	Aggregated evaluation result for a single candidate agent configuration across all tasks.
AgentOptimizationDatasetCriterion	Evaluation criterion: a name + instruction pair used for per-item scoring.
AgentOptimizationDatasetInput	Base discriminated model for dataset input. Either inline items or a registered reference. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentOptimizationInlineDatasetInput, AgentOptimizationReferenceDatasetInput
AgentOptimizationDatasetItem	A single item in an inline dataset.
AgentOptimizationEvaluatorRef	Reference to a named evaluator, optionally pinned to a version.
AgentOptimizationInlineDatasetInput	Inline dataset — items supplied directly in the request body.
AgentOptimizationJob	Agent optimization job resource — a long-running job that optimizes an agent's configuration (instructions, model, skills, tools) to maximize evaluation scores. On success, the result contains scored candidates.
AgentOptimizationJobInputs	Caller-supplied inputs for an optimization job.
AgentOptimizationJobListItem	Slim job representation returned by the LIST endpoint.
AgentOptimizationJobProgress	In-flight progress; only populated while status is queued or in_progress.
AgentOptimizationJobResult	Terminal-state result body. Populated when status is succeeded or failed.
AgentOptimizationLROPoller	Custom LROPoller for agent optimization job operations.
AgentOptimizationOptions	Tuning knobs and run-mode for an optimization job.
AgentOptimizationReferenceDatasetInput	Reference to a registered Foundry dataset.
AgentSessionResource	An agent session providing a long-lived compute sandbox for hosted agent invocations.
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.
ArtifactProfile	Artifact profile of the model.
AsyncAgentInsightRunLROPoller	Custom AsyncLROPoller for Agent Insights run operations.
AsyncAgentOptimizationLROPoller	Custom AsyncLROPoller for agent optimization job operations.
AsyncDatasetGenerationLROPoller	Custom AsyncLROPoller for data generation job operations.
AsyncEvaluatorGenerationLROPoller	Custom AsyncLROPoller for evaluator generation job operations.
AsyncUpdateMemoriesLROPoller	Custom AsyncLROPoller for Memory Store update operations.
AutoCodeInterpreterToolParam	Automatic Code Interpreter Tool Parameters.
AzureAIAgentTarget	Represents a target specifying an Azure AI agent.
AzureAIAgentTargetParam	Represents a target specifying an Azure AI agent.
AzureAIBenchmarkPreviewEvalRunDataSource	Represents a data source for benchmark evaluation runs.
AzureAIDataSourceConfig	AzureAIDataSourceConfig.
AzureAIModelTarget	Represents a target specifying an Azure AI model for operations requiring model selection.
AzureAIModelTargetParam	Represents a target specifying an Azure AI model for operations requiring model selection.
AzureAIResponsesEvalRunDataSource	Represents a data source for evaluation runs that are specific to Continuous Evaluation scenarios.
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.
AzureAISearchToolboxTool	An Azure AI Search tool stored in a toolbox.
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.
BotServiceAuthorizationScheme	BotServiceAuthorizationScheme.
BotServiceRbacAuthorizationScheme	BotServiceRbacAuthorizationScheme.
BotServiceTenantAuthorizationScheme	BotServiceTenantAuthorizationScheme.
BrowserAutomationPreviewTool	The input definition information for a Browser Automation Tool, as used to configure an Agent.
BrowserAutomationPreviewToolboxTool	A browser automation tool stored in a toolbox.
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.
CodeConfiguration	Code-based deployment configuration for a hosted agent.
CodeInterpreterTool	Code interpreter.
CodeInterpreterToolboxTool	A code interpreter tool stored in a toolbox.
ComparisonFilter	Comparison Filter.
CompoundFilter	Compound Filter.
ComputerTool	Computer.
ComputerUsePreviewTool	Computer use preview.
Connection	Response from the list and get connections operations.
ContainerAutoParam	ContainerAutoParam.
ContainerConfiguration	Container-based deployment configuration for a hosted agent.
ContainerNetworkPolicyAllowlistParam	ContainerNetworkPolicyAllowlistParam.
ContainerNetworkPolicyDisabledParam	ContainerNetworkPolicyDisabledParam.
ContainerNetworkPolicyDomainSecretParam	ContainerNetworkPolicyDomainSecretParam.
ContainerNetworkPolicyParam	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	ContainerSkill. You probably want to use the sub-classes and not this class directly. Known sub-classes are: InlineSkillParam, SkillReferenceParam
ContinuousEvaluationRuleAction	Evaluation rule action for continuous evaluation.
CosmosDBIndex	CosmosDB Vector Store Index Definition.
CreateAsyncResponse	CreateAsyncResponse.
CreateSkillVersionFromFilesBody	Multipart request body for creating a skill version from files. Accepts either a single zip file or multiple individual skill files (directory upload). For zip uploads, the server extracts and validates contents. For directory uploads, files are validated as-is.
CreateTeamsPhoneExtensionTelephonyBindingRequest	The request to create a Microsoft Teams Phone Extension binding.
CreateTelephonyBindingRequest	The request to create a telephony binding. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CreateTeamsPhoneExtensionTelephonyBindingRequest, CreateTwilioTelephonyBindingRequest
CreateTelephonyCallJobRequest	A request to create one durable direct outbound call job.
CreateTranscriptionResponseJsonUsage	Token usage statistics for the request. You probably want to use the sub-classes and not this class directly. Known sub-classes are: TranscriptTextUsageDuration, TranscriptTextUsageTokens
CreateTwilioTelephonyBindingRequest	The request to create a Twilio binding.
CronTrigger	Cron based trigger.
CustomCredential	Custom credential definition.
CustomGrammarFormatParam	Grammar format.
CustomRoutineTrigger	A custom event routine trigger.
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.
DataGenerationJob	Data Generation Job resource.
DataGenerationJobInputs	Caller-supplied inputs for a data generation job.
DataGenerationJobOptions	Options for managing data generation jobs. You probably want to use the sub-classes and not this class directly. Known sub-classes are: SimpleQnADataGenerationJobOptions, SimulationSeedDataGenerationJobOptions, ToolUseFineTuningDataGenerationJobOptions, TracesDataGenerationJobOptions
DataGenerationJobOutput	Output information for a data generation job. You probably want to use the sub-classes and not this class directly. Known sub-classes are: DatasetDataGenerationJobOutput, FileDataGenerationJobOutput
DataGenerationJobOutputOptions	Output options for data generation job.
DataGenerationJobResult	Result produced by a successful data generation job.
DataGenerationJobSource	The base source model for data generation jobs. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentDataGenerationJobSource, FileDataGenerationJobSource, PromptDataGenerationJobSource, TracesDataGenerationJobSource
DataGenerationModelOptions	LLM model options for data generation jobs.
DataGenerationTokenUsage	Token usage information for a data generation job.
DatasetCredential	Represents a reference to a blob for consumption.
DatasetDataGenerationJobOutput	Dataset output for a data generation job.
DatasetEvaluatorGenerationJobSource	Dataset source for evaluator generation jobs — reference to a dataset.
DatasetGenerationLROPoller	Custom LROPoller for data generation job operations.
DatasetReference	Reference to a versioned Foundry Dataset.
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.
DeleteMemoryResult	Response for deleting a memory item from a memory store.
DeleteMemoryStoreResult	DeleteMemoryStoreResult.
DeleteSkillResult	A deleted skill.
DeleteSkillVersionResult	A deleted skill version.
Deployment	Model Deployment Definition. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ModelDeployment
Dimension	A single dimension — one independent, measurable quality dimension within a rubric evaluator's scoring blueprint.
DispatchRoutineResult	Identifiers returned after a routine dispatch is queued.
EmbeddingConfiguration	Embedding configuration class.
EmptyModelParam	EmptyModelParam.
EndpointBasedEvaluatorDefinition	Endpoint-based evaluator definition. The customer owns and hosts an HTTP endpoint that implements the evaluation contract. The evaluator references a Project Connection by name; the connection stores the endpoint URL and credentials (API Key or Entra ID). At execution time, the service resolves the connection to obtain the endpoint URL and authentication details, then calls the endpoint for each evaluation row.
EntraAuthorizationScheme	EntraAuthorizationScheme.
EntraIDCredentials	Entra ID credential definition.
EvalCsvFileIdSource	Represents a CSV data source by file ID.
EvalCsvRunDataSource	Represents a CSV data source for evaluation runs.
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.
EvaluationTarget	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
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
EvaluatorCredentialRequest	Request body for getting evaluator credentials.
EvaluatorDefinition	Base evaluator configuration with discriminator. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CodeBasedEvaluatorDefinition, EndpointBasedEvaluatorDefinition, PromptBasedEvaluatorDefinition, RubricBasedEvaluatorDefinition
EvaluatorGenerationArtifacts	Service-managed provenance artifacts produced by an evaluator generation job. Present only on EvaluatorVersion resources created via the generation pipeline. The combined-JSONL Foundry Dataset is read-only and resolves to a versioned dataset in a service-reserved namespace.
EvaluatorGenerationInputs	Caller-supplied inputs for an evaluator generation job.
EvaluatorGenerationJob	Evaluator Generation Job resource — a long-running job that generates rubric-based evaluator definitions from source materials. On success, the result is the persisted EvaluatorVersion.
EvaluatorGenerationJobSource	The base source model for evaluator generation jobs. Polymorphic over type. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentEvaluatorGenerationJobSource, DatasetEvaluatorGenerationJobSource, PromptEvaluatorGenerationJobSource, TracesEvaluatorGenerationJobSource
EvaluatorGenerationLROPoller	Custom LROPoller for evaluator generation job operations.
EvaluatorGenerationTokenUsage	Token consumption summary for an evaluator generation job. Populated when the job reaches a terminal state.
EvaluatorMetric	Evaluator Metric.
EvaluatorVersion	Evaluator Definition.
ExternalAgentDefinition	The external agent definition. Represents a third-party agent hosted outside Foundry (for example, on GCP or AWS). Registration is metadata-only: Foundry records the agent definition to light up observability experiences (traces, evaluations) over customer-emitted OpenTelemetry data.
FabricDataAgentToolParameters	The fabric data agent tool parameters.
FabricIQPreviewTool	A FabricIQ server-side tool.
FabricIQPreviewToolboxTool	A FabricIQ tool stored in a toolbox.
FieldMapping	Field mapping configuration class.
FileDataGenerationJobOutput	Azure OpenAI file output for a data generation job.
FileDataGenerationJobSource	File source for data generation jobs — Azure OpenAI file input.
FileDatasetVersion	FileDatasetVersion Definition.
FileSearchTool	File search.
FileSearchToolboxTool	A file search tool stored in a toolbox.
FixedRatioVersionSelectionRule	FixedRatioVersionSelectionRule.
FolderDatasetVersion	FileDatasetVersion Definition.
FoundryModelWarning	A warning associated with a model.
FunctionShellToolParam	Shell tool.
FunctionShellToolParamEnvironment	FunctionShellToolParamEnvironment. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContainerAutoParam, FunctionShellToolParamEnvironmentContainerReferenceParam, FunctionShellToolParamEnvironmentLocalEnvironmentParam
FunctionShellToolParamEnvironmentContainerReferenceParam	FunctionShellToolParamEnvironmentContainerReferenceParam.
FunctionShellToolParamEnvironmentLocalEnvironmentParam	FunctionShellToolParamEnvironmentLocalEnvironmentParam.
FunctionTool	Function.
FunctionToolParam	FunctionToolParam.
GenerateVoiceAgentRequest	The inputs for generating a voice agent. Only kind and name are always required. The authoring service expands these inputs into a full, editable VoiceAgentDefinition, which is then created through POST /agents. The generated instructions and audio/voice settings are stored as separate fields on the resulting agent definition, so the caller can edit or override any of them afterward via standard agent versioning.
GitHubCopilotHarness	The GitHub Copilot managed harness for prompt agents.
GitHubCopilotToolsetConfig	An enablement override for a GitHub Copilot built-in tool.
GitHubCopilotToolsetDefaultConfig	The default enablement setting for GitHub Copilot built-in tools.
GitHubCopilotToolsetPreview	Configuration overrides for GitHub Copilot built-in tools.
GitHubIssueRoutineTrigger	A GitHub issue routine trigger.
HeaderTelemetryEndpointAuth	Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header.
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
InlineSkillParam	InlineSkillParam.
InlineSkillSourceParam	Inline skill payload.
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.
InvocationsProtocolConfiguration	Configuration specific to the invocations protocol.
InvocationsWsProtocolConfiguration	Configuration specific to the WebSocket-based invocations protocol.
InvokeAgentInvocationsApiDispatchPayload	A manual payload used to test an invocations API routine dispatch.
InvokeAgentInvocationsApiRoutineAction	Dispatches a routine through the raw invocations API. Exactly one of agent_name or agent_endpoint_id must be provided.
InvokeAgentResponsesApiDispatchPayload	A manual payload used to test a responses API routine dispatch.
InvokeAgentResponsesApiRoutineAction	Dispatches a routine through the responses API. Exactly one of agent_name or agent_endpoint_id must be provided.
LocalShellToolParam	Local shell tool.
LocalSkillParam	LocalSkillParam.
LogProbProperties	A log probability object.
LoraConfig	Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time.
MCPListToolsTool	MCP list tools tool.
MCPListToolsToolAnnotations	MCPListToolsToolAnnotations.
MCPListToolsToolInputSchema	MCPListToolsToolInputSchema.
MCPTool	MCP tool.
MCPToolFilter	MCP tool filter.
MCPToolRequireApproval	MCPToolRequireApproval.
MCPToolboxTool	An MCP tool stored in a toolbox.
ManagedAgentIdentityBlueprintReference	ManagedAgentIdentityBlueprintReference.
ManagedAzureAISearchIndex	Managed Azure AI Search Index Definition.
McpProtocolConfiguration	Configuration specific to the MCP protocol.
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, ProceduralMemoryItem, 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.
Metadata	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.
Microsoft365PermissionScopes	A set of delegated permission scopes requested from a single resource application.
Microsoft365PublishDefaults	Default and previously-published values used to pre-populate a Microsoft 365 publish request for a Foundry agent.
Microsoft365PublishResult	Response from publishing an agent to Microsoft 365 / Microsoft Teams.
MicrosoftFabricPreviewTool	The input definition information for a Microsoft Fabric tool as used to configure an agent.
ModelCredentialRequest	Request to fetch credentials for a model asset.
ModelDeployment	Model Deployment Definition.
ModelDeploymentSku	Sku information.
ModelPendingUploadRequest	Represents a request for a pending upload of a model version.
ModelPendingUploadResponse	Represents the response for a model pending upload request.
ModelSamplingConfigParam	Represents a set of parameters used to control the sampling behavior of a language model during text generation.
ModelSamplingParams	Represents a set of parameters used to control the sampling behavior of a language model during text generation.
ModelSourceData	Source information for the model.
ModelVersion	Model Version Definition.
MonthlyRecurrenceSchedule	Monthly recurrence schedule.
NamespaceToolParam	Namespace.
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.
OpenApiToolboxTool	An OpenAPI tool stored in a toolbox.
OptimizedAgentIdentifier	Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config.
OtlpTelemetryEndpoint	An OTLP (OpenTelemetry Protocol) telemetry export endpoint.
PSTNTelephonyTransferDestination	A PSTN destination for a telephony transfer target.
PendingUploadRequest	Represents a request for a pending upload.
PendingUploadResponse	Represents the response for a pending upload request.
PickPropertiesVoiceAgentAudioConfig	The template for picking properties.
ProceduralMemoryItem	A memory item containing a procedure extracted from conversations.
ProgrammaticToolCallingParam	ProgrammaticToolCallingParam.
PromotionInfo	Promotion metadata recorded when a candidate is deployed to a Foundry agent.
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.
PromptDataGenerationJobSource	Prompt source for data generation jobs — inline text provided by the user.
PromptEvaluatorGenerationJobSource	Prompt source for evaluator generation jobs — inline text provided by the user.
ProtocolConfiguration	Per-protocol configuration for the agent endpoint.
ProtocolVersionRecord	A record mapping for a single protocol and its version.
RaiConfig	Configuration for Responsible AI (RAI) content filtering and safety features.
RaiInvocationModeration	Declares where request/response text lives so content-safety guardrails can extract it.
RaiSseTextSelector	An SSE event-type to text-field selector for streaming invocation output.
RankingOptions	RankingOptions.
RealtimeAudioFormats	RealtimeAudioFormats. You probably want to use the sub-classes and not this class directly. Known sub-classes are: RealtimeAudioFormatsAudioPcm, RealtimeAudioFormatsAudioPcma, RealtimeAudioFormatsAudioPcmu
RealtimeAudioFormatsAudioPcm	RealtimeAudioFormatsAudioPcm.
RealtimeAudioFormatsAudioPcma	RealtimeAudioFormatsAudioPcma.
RealtimeAudioFormatsAudioPcmu	RealtimeAudioFormatsAudioPcmu.
RealtimeClientEvent	A realtime client event. You probably want to use the sub-classes and not this class directly. Known sub-classes are: RealtimeClientEventConversationItemCreate, RealtimeClientEventConversationItemDelete, RealtimeClientEventConversationItemRetrieve, RealtimeClientEventConversationItemTruncate, RealtimeClientEventInputAudioBufferAppend, RealtimeClientEventInputAudioBufferClear, RealtimeClientEventInputAudioBufferCommit, RealtimeClientEventOutputAudioBufferClear, RealtimeClientEventResponseCancel, RealtimeClientEventResponseCreate, VoiceAgentClientEventRtcCallSdpCreate, VoiceAgentClientEventSessionAvatarConnect
RealtimeClientEventConversationItemCreate	Add a new Item to the Conversation's context, including messages, function calls, and function call responses. This event can be used both to populate a "history" of the conversation and to add new items mid-stream, but has the current limitation that it cannot populate assistant audio messages. If successful, the server will respond with a conversation.item.created event, otherwise an error event will be sent.
RealtimeClientEventConversationItemDelete	Send this event when you want to remove any item from the conversation history. The server will respond with a conversation.item.deleted event, unless the item does not exist in the conversation history, in which case the server will respond with an error.
RealtimeClientEventConversationItemRetrieve	Send this event when you want to retrieve the server's representation of a specific item in the conversation history. This is useful, for example, to inspect user audio after noise cancellation and VAD. The server will respond with a conversation.item.retrieved event, unless the item does not exist in the conversation history, in which case the server will respond with an error.
RealtimeClientEventConversationItemTruncate	Send this event to truncate a previous assistant message's audio. The server will produce audio faster than realtime, so this event is useful when the user interrupts to truncate audio that has already been sent to the client but not yet played. This will synchronize the server's understanding of the audio with the client's playback. Truncating audio will delete the server-side text transcript to ensure there is not text in the context that hasn't been heard by the user. If successful, the server will respond with a conversation.item.truncated event.
RealtimeClientEventInputAudioBufferAppend	Send this event to append audio bytes to the input audio buffer. The audio buffer is temporary storage you can write to and later commit. A "commit" will create a new user message item in the conversation history from the buffer content and clear the buffer. Input audio transcription (if enabled) will be generated when the buffer is committed. If VAD is enabled the audio buffer is used to detect speech and the server will decide when to commit. When Server VAD is disabled, you must commit the audio buffer manually. Input audio noise reduction operates on writes to the audio buffer. The client may choose how much audio to place in each event up to a maximum of 15 MiB, for example streaming smaller chunks from the client may allow the VAD to be more responsive. Unlike most other client events, the server will not send a confirmation response to this event.
RealtimeClientEventInputAudioBufferClear	Send this event to clear the audio bytes in the buffer. The server will respond with an input_audio_buffer.cleared event.
RealtimeClientEventInputAudioBufferCommit	Send this event to commit the user input audio buffer, which will create a new user message item in the conversation. This event will produce an error if the input audio buffer is empty. When in Server VAD mode, the client does not need to send this event, the server will commit the audio buffer automatically. Committing the input audio buffer will trigger input audio transcription (if enabled in session configuration), but it will not create a response from the model. The server will respond with an input_audio_buffer.committed event.
RealtimeClientEventOutputAudioBufferClear	WebRTC/SIP Only: Emit to cut off the current audio response. This will trigger the server to stop generating audio and emit a output_audio_buffer.cleared event. This event should be preceded by a response.cancel client event to stop the generation of the current response. Learn more.
RealtimeClientEventResponseCancel	Send this event to cancel an in-progress response. The server will respond with a response.done event with a status of response.status=cancelled. If there is no response to cancel, the server will respond with an error. It's safe to call response.cancel even if no response is in progress, an error will be returned the session will remain unaffected.
RealtimeClientEventResponseCreate	This event instructs the server to create a Response, which means triggering model inference. When in Server VAD mode, the server will create Responses automatically. A Response will include at least one Item, and may have two, in which case the second will be a function call. These Items will be appended to the conversation history by default. The server will respond with a response.created event, events for Items and content created, and finally a response.done event to indicate the Response is complete. The response.create event includes inference configuration like instructions and tools. If these are set, they will override the Session's configuration for this Response only. Responses can be created out-of-band of the default Conversation, meaning that they can have arbitrary input, and it's possible to disable writing the output to the Conversation. Only one Response can write to the default Conversation at a time, but otherwise multiple Responses can be created in parallel. The metadata field is a good way to disambiguate multiple simultaneous Responses. Clients can set conversation to none to create a Response that does not write to the default Conversation. Arbitrary input can be provided with the input field, which is an array accepting raw Items and references to existing Items.
RealtimeConversationItem	A single item within a Realtime conversation. You probably want to use the sub-classes and not this class directly. Known sub-classes are: RealtimeConversationItemFunctionCall, RealtimeConversationItemFunctionCallOutput, RealtimeMCPApprovalRequest, RealtimeMCPApprovalResponse, RealtimeMCPToolCall, RealtimeMCPListTools, RealtimeConversationItemMessage
RealtimeConversationItemFunctionCall	Realtime function call item.
RealtimeConversationItemFunctionCallOutput	Realtime function call output item.
RealtimeConversationItemMessage	RealtimeConversationItemMessage. You probably want to use the sub-classes and not this class directly. Known sub-classes are: RealtimeConversationItemMessageAssistant, RealtimeConversationItemMessageSystem, RealtimeConversationItemMessageUser
RealtimeConversationItemMessageAssistant	Realtime assistant message item.
RealtimeConversationItemMessageAssistantContent	RealtimeConversationItemMessageAssistantContent.
RealtimeConversationItemMessageSystem	Realtime system message item.
RealtimeConversationItemMessageSystemContent	RealtimeConversationItemMessageSystemContent.
RealtimeConversationItemMessageUser	Realtime user message item.
RealtimeConversationItemMessageUserContent	RealtimeConversationItemMessageUserContent.
RealtimeFunctionTool	Function tool.
RealtimeFunctionToolParameters	RealtimeFunctionToolParameters.
RealtimeMCPApprovalRequest	Realtime MCP approval request.
RealtimeMCPApprovalResponse	Realtime MCP approval response.
RealtimeMCPError	RealtimeMCPError. You probably want to use the sub-classes and not this class directly. Known sub-classes are: RealtimeMCPHTTPError, RealtimeMCPProtocolError, RealtimeMCPToolExecutionError
RealtimeMCPHTTPError	Realtime MCP HTTP error.
RealtimeMCPListTools	Realtime MCP list tools.
RealtimeMCPProtocolError	Realtime MCP protocol error.
RealtimeMCPToolCall	Realtime MCP tool call.
RealtimeMCPToolExecutionError	Realtime MCP tool execution error.
RealtimeReasoning	Realtime reasoning configuration.
RealtimeResponseStatusDetails	RealtimeResponseStatusDetails.
RealtimeResponseStatusDetailsError	RealtimeResponseStatusDetailsError.
RealtimeResponseUsage	RealtimeResponseUsage.
RealtimeResponseUsageInputTokenDetails	RealtimeResponseUsageInputTokenDetails.
RealtimeResponseUsageInputTokenDetailsCachedTokensDetails	RealtimeResponseUsageInputTokenDetailsCachedTokensDetails.
RealtimeResponseUsageOutputTokenDetails	RealtimeResponseUsageOutputTokenDetails.
RealtimeServerEvent	A realtime server event. You probably want to use the sub-classes and not this class directly. Known sub-classes are: RealtimeServerEventConversationItemAdded, RealtimeServerEventConversationItemCreated, RealtimeServerEventConversationItemDeleted, RealtimeServerEventConversationItemDone, RealtimeServerEventConversationItemInputAudioTranscriptionCompleted, RealtimeServerEventConversationItemInputAudioTranscriptionDelta, RealtimeServerEventConversationItemInputAudioTranscriptionFailed, RealtimeServerEventConversationItemInputAudioTranscriptionSegment, RealtimeServerEventConversationItemRetrieved, RealtimeServerEventConversationItemTruncated, RealtimeServerEventInputAudioBufferCleared, RealtimeServerEventInputAudioBufferCommitted, RealtimeServerEventInputAudioBufferSpeechStarted, RealtimeServerEventInputAudioBufferSpeechStopped, RealtimeServerEventInputAudioBufferTimeoutTriggered, RealtimeServerEventMCPListToolsCompleted, RealtimeServerEventMCPListToolsFailed, RealtimeServerEventMCPListToolsInProgress, RealtimeServerEventOutputAudioBufferCleared, RealtimeServerEventRateLimitsUpdated, VoiceAgentServerEventResponseAnimationBlendshapesDelta, VoiceAgentServerEventResponseAnimationBlendshapesDone, VoiceAgentServerEventResponseAnimationVisemeDelta, VoiceAgentServerEventResponseAnimationVisemeDone, VoiceAgentServerEventResponseAudioTimestampDelta, VoiceAgentServerEventResponseAudioTimestampDone, RealtimeServerEventResponseContentPartAdded, RealtimeServerEventResponseContentPartDone, RealtimeServerEventResponseCreated, RealtimeServerEventResponseDone, RealtimeServerEventResponseFunctionCallArgumentsDelta, RealtimeServerEventResponseFunctionCallArgumentsDone, RealtimeServerEventResponseMCPCallCompleted, RealtimeServerEventResponseMCPCallFailed, RealtimeServerEventResponseMCPCallInProgress, RealtimeServerEventResponseMCPCallArgumentsDelta, RealtimeServerEventResponseMCPCallArgumentsDone, RealtimeServerEventResponseAudioDelta, RealtimeServerEventResponseAudioDone, RealtimeServerEventResponseAudioTranscriptDelta, RealtimeServerEventResponseAudioTranscriptDone, RealtimeServerEventResponseOutputItemAdded, RealtimeServerEventResponseOutputItemDone, RealtimeServerEventResponseTextDelta, RealtimeServerEventResponseTextDone, VoiceAgentServerEventResponseVideoDelta, VoiceAgentServerEventRtcCallError, VoiceAgentServerEventRtcCallSdpCreated, VoiceAgentServerEventSessionAvatarConnecting, VoiceAgentServerEventSessionAvatarSwitchToIdle, VoiceAgentServerEventSessionAvatarSwitchToSpeaking, RealtimeServerEventSessionCreated, VoiceAgentServerEventSessionSubagentAborted, VoiceAgentServerEventSessionSubagentCompleted, VoiceAgentServerEventSessionSubagentStarted, RealtimeServerEventSessionUpdated, VoiceAgentServerEventWarning
RealtimeServerEventConversationItemAdded	Sent by the server when an Item is added to the default Conversation. This can happen in several cases: When the client sends a conversation.item.create event. When the input audio buffer is committed. In this case the item will be a user message containing the audio from the buffer. When the model is generating a Response. In this case the conversation.item.added event will be sent when the model starts generating a specific Item, and thus it will not yet have any content (and status will be in_progress). The event will include the full content of the Item (except when model is generating a Response) except for audio data, which can be retrieved separately with a conversation.item.retrieve event if necessary.
RealtimeServerEventConversationItemCreated	Returned when a conversation item is created. There are several scenarios that produce this event: The server is generating a Response, which if successful will produce either one or two Items, which will be of type message (role assistant) or type function_call. The input audio buffer has been committed, either by the client or the server (in server_vad mode). The server will take the content of the input audio buffer and add it to a new user message Item. The client has sent a conversation.item.create event to add a new Item to the Conversation.
RealtimeServerEventConversationItemDeleted	Returned when an item in the conversation is deleted by the client with a conversation.item.delete event. This event is used to synchronize the server's understanding of the conversation history with the client's view.
RealtimeServerEventConversationItemDone	Returned when a conversation item is finalized. The event will include the full content of the Item except for audio data, which can be retrieved separately with a conversation.item.retrieve event if needed.
RealtimeServerEventConversationItemInputAudioTranscriptionCompleted	This event is the output of audio transcription for user audio written to the user audio buffer. Transcription begins when the input audio buffer is committed by the client or server (when VAD is enabled). Transcription runs asynchronously with Response creation, so this event may come before or after the Response events. Realtime API models accept audio natively, and thus input transcription is a separate process run on a separate ASR (Automatic Speech Recognition) model. The transcript may diverge somewhat from the model's interpretation, and should be treated as a rough guide.
RealtimeServerEventConversationItemInputAudioTranscriptionDelta	Returned when the text value of an input audio transcription content part is updated with incremental transcription results.
RealtimeServerEventConversationItemInputAudioTranscriptionFailed	Returned when input audio transcription is configured, and a transcription request for a user message failed. These events are separate from other error events so that the client can identify the related Item.
RealtimeServerEventConversationItemInputAudioTranscriptionFailedError	RealtimeServerEventConversationItemInputAudioTranscriptionFailedError.
RealtimeServerEventConversationItemInputAudioTranscriptionSegment	Returned when an input audio transcription segment is identified for an item.
RealtimeServerEventConversationItemRetrieved	Returned when a conversation item is retrieved with conversation.item.retrieve. This is provided as a way to fetch the server's representation of an item, for example to get access to the post-processed audio data after noise cancellation and VAD. It includes the full content of the Item, including audio data.
RealtimeServerEventConversationItemTruncated	Returned when an earlier assistant audio message item is truncated by the client with a conversation.item.truncate event. This event is used to synchronize the server's understanding of the audio with the client's playback. This action will truncate the audio and remove the server-side text transcript to ensure there is no text in the context that hasn't been heard by the user.
RealtimeServerEventError	Returned when an error occurs, which could be a client problem or a server problem. Most errors are recoverable and the session will stay open, we recommend to implementors to monitor and log error messages by default.
RealtimeServerEventErrorError	RealtimeServerEventErrorError.
RealtimeServerEventInputAudioBufferCleared	Returned when the input audio buffer is cleared by the client with a input_audio_buffer.clear event.
RealtimeServerEventInputAudioBufferCommitted	Returned when an input audio buffer is committed, either by the client or automatically in server VAD mode. The item_id property is the ID of the user message item that will be created, thus a conversation.item.created event will also be sent to the client.
RealtimeServerEventInputAudioBufferSpeechStarted	Sent by the server when in server_vad mode to indicate that speech has been detected in the audio buffer. This can happen any time audio is added to the buffer (unless speech is already detected). The client may want to use this event to interrupt audio playback or provide visual feedback to the user. The client should expect to receive a input_audio_buffer.speech_stopped event when speech stops. The item_id property is the ID of the user message item that will be created when speech stops and will also be included in the input_audio_buffer.speech_stopped event (unless the client manually commits the audio buffer during VAD activation).
RealtimeServerEventInputAudioBufferSpeechStopped	Returned in server_vad mode when the server detects the end of speech in the audio buffer. The server will also send an conversation.item.created event with the user message item that is created from the audio buffer.
RealtimeServerEventInputAudioBufferTimeoutTriggered	Returned when the Server VAD timeout is triggered for the input audio buffer. This is configured with idle_timeout_ms in the turn_detection settings of the session, and it indicates that there hasn't been any speech detected for the configured duration. The audio_start_ms and audio_end_ms fields indicate the segment of audio after the last model response up to the triggering time, as an offset from the beginning of audio written to the input audio buffer. This means it demarcates the segment of audio that was silent and the difference between the start and end values will roughly match the configured timeout. The empty audio will be committed to the conversation as an input_audio item (there will be a input_audio_buffer.committed event) and a model response will be generated. There may be speech that didn't trigger VAD but is still detected by the model, so the model may respond with something relevant to the conversation or a prompt to continue speaking.
RealtimeServerEventMCPListToolsCompleted	Returned when listing MCP tools has completed for an item.
RealtimeServerEventMCPListToolsFailed	Returned when listing MCP tools has failed for an item.
RealtimeServerEventMCPListToolsInProgress	Returned when listing MCP tools is in progress for an item.
RealtimeServerEventOutputAudioBufferCleared	WebRTC/SIP Only: Emitted when the output audio buffer is cleared. This happens either in VAD mode when the user has interrupted (input_audio_buffer.speech_started), or when the client has emitted the output_audio_buffer.clear event to manually cut off the current audio response. Learn more.
RealtimeServerEventRateLimitsUpdated	Emitted at the beginning of a Response to indicate the updated rate limits. When a Response is created some tokens will be "reserved" for the output tokens, the rate limits shown here reflect that reservation, which is then adjusted accordingly once the Response is completed.
RealtimeServerEventRateLimitsUpdatedRateLimits	RealtimeServerEventRateLimitsUpdatedRateLimits.
RealtimeServerEventResponseAudioDelta	Returned when the model-generated audio is updated.
RealtimeServerEventResponseAudioDone	Returned when the model-generated audio is done. Also emitted when a Response is interrupted, incomplete, or cancelled.
RealtimeServerEventResponseAudioTranscriptDelta	Returned when the model-generated transcription of audio output is updated.
RealtimeServerEventResponseAudioTranscriptDone	Returned when the model-generated transcription of audio output is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.
RealtimeServerEventResponseContentPartAdded	Returned when a new content part is added to an assistant message item during response generation.
RealtimeServerEventResponseContentPartAddedPart	RealtimeServerEventResponseContentPartAddedPart.
RealtimeServerEventResponseContentPartDone	Returned when a content part is done streaming in an assistant message item. Also emitted when a Response is interrupted, incomplete, or cancelled.
RealtimeServerEventResponseContentPartDonePart	RealtimeServerEventResponseContentPartDonePart.
RealtimeServerEventResponseCreated	Returned when a new Response is created. The first event of response creation, where the response is in an initial state of in_progress.
RealtimeServerEventResponseDone	Returned when a Response is done streaming. Always emitted, no matter the final state. The Response object included in the response.done event will include all output Items in the Response but will omit the raw audio data. Clients should check the status field of the Response to determine if it was successful (completed) or if there was another outcome: cancelled, failed, or incomplete. A response will contain all output items that were generated during the response, excluding any audio content.
RealtimeServerEventResponseFunctionCallArgumentsDelta	Returned when the model-generated function call arguments are updated.
RealtimeServerEventResponseFunctionCallArgumentsDone	Returned when the model-generated function call arguments are done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.
RealtimeServerEventResponseMCPCallArgumentsDelta	Returned when MCP tool call arguments are updated during response generation.
RealtimeServerEventResponseMCPCallArgumentsDone	Returned when MCP tool call arguments are finalized during response generation.
RealtimeServerEventResponseMCPCallCompleted	Returned when an MCP tool call has completed successfully.
RealtimeServerEventResponseMCPCallFailed	Returned when an MCP tool call has failed.
RealtimeServerEventResponseMCPCallInProgress	Returned when an MCP tool call has started and is in progress.
RealtimeServerEventResponseOutputItemAdded	Returned when a new Item is created during Response generation.
RealtimeServerEventResponseOutputItemDone	Returned when an Item is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.
RealtimeServerEventResponseTextDelta	Returned when the text value of an "output_text" content part is updated.
RealtimeServerEventResponseTextDone	Returned when the text value of an "output_text" content part is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.
RealtimeServerEventSessionCreated	Returned when a Session is created. Emitted automatically when a new connection is established as the first server event. This event will contain the default Session configuration.
RealtimeServerEventSessionUpdated	Returned when a session is updated with a session.update event, unless there is an error.
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.
RedTeamEvalRunDataSource	RedTeamEvalRunDataSource.
RedTeamTargetConfig	Abstract class for target configuration. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureOpenAIModelConfiguration
ReminderPreviewToolboxTool	A reminder tool stored in a toolbox.
ResponseRetrievalItemGenerationParams	Represents the parameters for response retrieval item generation.
ResponseUsageInputTokensDetails	ResponseUsageInputTokensDetails.
ResponseUsageOutputTokensDetails	ResponseUsageOutputTokensDetails.
ResponsesProtocolConfiguration	Configuration specific to the responses protocol.
Routine	A routine definition returned by the service.
RoutineAction	Base model for a routine action. You probably want to use the sub-classes and not this class directly. Known sub-classes are: InvokeAgentInvocationsApiRoutineAction, InvokeAgentResponsesApiRoutineAction
RoutineAuthorization	Optional authorization configuration for a routine dispatch.
RoutineDispatchPayload	Base model for a manual dispatch payload. You probably want to use the sub-classes and not this class directly. Known sub-classes are: InvokeAgentInvocationsApiDispatchPayload, InvokeAgentResponsesApiDispatchPayload
RoutineRun	A single routine run returned from the run history API.
RoutineTrigger	Base model for a routine trigger. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CustomRoutineTrigger, GitHubIssueRoutineTrigger, ScheduleRoutineTrigger, TimerRoutineTrigger
RubricBasedEvaluatorDefinition	Rubric-based evaluator definition — stores dimensions produced by the generate API. Used for both quality and safety evaluators.
RubricGenerationInputQualityWarning	A non-fatal advisory produced during rubric evaluator generation when resolved inputs are technically valid but likely too weak to produce a high-quality rubric. Read-only; service-generated. Persisted with the terminal EvaluatorGenerationJob.
SASCredentials	Shared Access Signature (SAS) credential definition.
Schedule	Schedule model.
ScheduleRoutineTrigger	A recurring cron-based routine trigger.
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
SessionConfiguration	Session defaults applied to sessions created for a hosted agent version.
SessionDirectoryEntry	A single entry in a directory listing.
SessionFileWriteResult	Response from uploading a file to a session sandbox.
SessionLogEvent	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"}
SharepointGroundingToolParameters	The sharepoint grounding tool parameters.
SharepointPreviewTool	The input definition information for a sharepoint tool as used to configure an agent.
ShellToolboxTool	A shell tool stored in a toolbox. This model is additive to toolbox configuration and does not modify the OpenAI tool contract or existing toolbox tool definitions.
SimpleQnADataGenerationJobOptions	The options for a data generation job with SimpleQnA type.
SimulationSeedDataGenerationJobOptions	The options for a task generation data generation job. Use with multiturn evaluation scenarios and with prompt, file, or agent sources. Generated dataset rows include fields such as id, category, test_case_description, and desired_num_turns.
SipTelephonyTransferDestination	A SIP destination for a telephony transfer target.
SkillDetails	A skill resource.
SkillInlineContent	Inline content for defining a simple skill without uploading files. Follows the agentskills.io SKILL.md specification.
SkillReference	A reference to a versioned Foundry skill.
SkillReferenceParam	SkillReferenceParam.
SkillVersion	A specific version of a skill.
SpecificApplyPatchParam	Specific apply patch tool choice.
SpecificFunctionShellParam	Specific shell tool choice.
SpecificProgrammaticToolCallingParam	SpecificProgrammaticToolCallingParam.
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.
TargetCompletionEvalRunDataSource	Represents a data source for target-based completion evaluation configuration.
TaxonomyCategory	Taxonomy category definition.
TaxonomySubCategory	Taxonomy sub-category definition.
TeamsPhoneExtensionTelephonyBinding	A Microsoft Teams Phone Extension binding owned by a voice agent.
TeamsPhoneExtensionTelephonyBindingListItem	A Microsoft Teams Phone Extension binding returned in a list, including its entity tag.
TeamsTelephonyTransferDestination	A Microsoft Teams destination for a telephony transfer target.
TelemetryConfig	Customer-supplied telemetry configuration for exporting container logs, traces, and metrics.
TelemetryEndpoint	A telemetry export endpoint configuration. You probably want to use the sub-classes and not this class directly. Known sub-classes are: OtlpTelemetryEndpoint
TelemetryEndpointAuth	Authentication configuration for a telemetry endpoint. You probably want to use the sub-classes and not this class directly. Known sub-classes are: HeaderTelemetryEndpointAuth
TelephonyBinding	A telephony binding owned by a voice agent. You probably want to use the sub-classes and not this class directly. Known sub-classes are: TeamsPhoneExtensionTelephonyBinding, TwilioTelephonyBinding
TelephonyBindingListItem	A telephony binding returned in a list, including its entity tag. You probably want to use the sub-classes and not this class directly. Known sub-classes are: TeamsPhoneExtensionTelephonyBindingListItem, TwilioTelephonyBindingListItem
TelephonyCallJob	A durable direct or campaign-created outbound call intent.
TelephonyCallJobCancellation	A cancellation request recorded for an outbound call job.
TelephonyCallJobSchedule	The optional execution window for a direct outbound call.
TelephonyCallLifecycleEvent	A bounded durable observation in the lifecycle of one telephony call.
TelephonyCallRecord	Detailed diagnostics for a durable inbound call to a voice agent.
TelephonyCallSummary	A summary of a durable inbound call to a voice agent.
TelephonyCallTiming	Detailed provider-neutral timing for an inbound telephony call.
TelephonyCallTrace	Correlation from a durable telephony call record to its customer-facing Foundry trace.
TelephonyOutboundDestination	The destination of an outbound call.
TelephonyOutboundFixedIntervalRetryPolicy	The frozen fixed-interval retry policy returned for an outbound call or campaign.
TelephonyOutboundRetryPolicy	The retry policy for one durable outbound call intent. max_attempts includes the first attempt. Strategy-specific settings are defined by the derived policy. You probably want to use the sub-classes and not this class directly. Known sub-classes are: TelephonyOutboundFixedIntervalRetryPolicy
TelephonyTransferDestination	A destination for a telephony transfer target. You probably want to use the sub-classes and not this class directly. Known sub-classes are: PSTNTelephonyTransferDestination, SipTelephonyTransferDestination, TeamsTelephonyTransferDestination
TelephonyTransferTarget	A named destination to which the voice agent may transfer a call.
TelephonyTransferTargets	The telephony transfer targets configured for one voice agent.
TestingCriterionAzureAIEvaluator	AzureAIEvaluatorGrader.
TextResponseFormat	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
TextResponseFormatJsonObject	JSON object.
TextResponseFormatJsonSchema	JSON schema.
TextResponseFormatText	Text.
TimerRoutineTrigger	A one-shot timer routine trigger.
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: A2ATool, A2APreviewTool, ApplyPatchToolParam, AzureAISearchTool, AzureFunctionTool, BingCustomSearchPreviewTool, BingGroundingTool, BrowserAutomationPreviewTool, CaptureStructuredOutputsTool, CodeInterpreterTool, ComputerTool, ComputerUsePreviewTool, CustomToolParam, MicrosoftFabricPreviewTool, FabricIQPreviewTool, FileSearchTool, FunctionTool, GitHubCopilotToolsetPreview, ImageGenTool, LocalShellToolParam, MCPTool, MemorySearchPreviewTool, NamespaceToolParam, OpenApiTool, ProgrammaticToolCallingParam, SharepointPreviewTool, FunctionShellToolParam, ToolSearchToolParam, WebIQPreviewTool, WebSearchTool, WebSearchPreviewTool, WorkIQPreviewTool
ToolChoiceAllowed	Allowed tools.
ToolChoiceCodeInterpreter	Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
ToolChoiceComputer	Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
ToolChoiceComputerUse	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, ToolChoiceComputer, ToolChoiceComputerUse, ToolChoiceComputerUsePreview, ToolChoiceCustom, ToolChoiceFileSearch, ToolChoiceFunction, ToolChoiceImageGeneration, ToolChoiceMCP, SpecificProgrammaticToolCallingParam, 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.
ToolConfig	Per-tool configuration that controls tool visibility and search behavior.
ToolDescription	Description of a tool that can be used by an agent.
ToolDescriptionParam	Description of a tool that can be used by an agent.
ToolProjectConnection	A project connection resource.
ToolSearchToolParam	Tool search tool.
ToolSearchToolboxTool	A toolbox search tool stored in a toolbox.
ToolUseFineTuningDataGenerationJobOptions	The options for a data generation job with ToolUse type. Used only for fine-tuning scenarios.
ToolboxObject	A toolbox that stores reusable tool definitions for agents.
ToolboxPolicies	Policy configuration for a toolbox, including content safety and other governance settings.
ToolboxSearchPreviewToolboxTool	A toolbox search tool stored in a toolbox.
ToolboxShellContainerAutoEnvironment	An automatically provisioned container environment for a shell tool stored in a toolbox.
ToolboxShellContainerReferenceEnvironment	An existing container environment for a shell tool stored in a toolbox.
ToolboxShellEnvironment	An execution environment for a shell tool stored in a toolbox. This environment model is scoped to toolbox configuration and does not modify the OpenAI shell environment contract. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ToolboxShellContainerAutoEnvironment, ToolboxShellContainerReferenceEnvironment
ToolboxShellNetworkPolicy	Network access policy for an automatically provisioned toolbox shell container. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ToolboxShellNetworkPolicyDisabled
ToolboxShellNetworkPolicyDisabled	A network policy that disables outbound access from a toolbox shell container.
ToolboxSkill	A skill source included in a toolbox. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ToolboxSkillReference
ToolboxSkillReference	A reference to an existing skill to include in a toolbox.
ToolboxTool	An abstract representation of a tool stored in a toolbox. You probably want to use the sub-classes and not this class directly. Known sub-classes are: A2AToolboxTool, A2APreviewToolboxTool, AzureAISearchToolboxTool, BrowserAutomationPreviewToolboxTool, CodeInterpreterToolboxTool, FabricIQPreviewToolboxTool, FileSearchToolboxTool, MCPToolboxTool, OpenApiToolboxTool, ReminderPreviewToolboxTool, ShellToolboxTool, ToolSearchToolboxTool, ToolboxSearchPreviewToolboxTool, WebIQPreviewToolboxTool, WebSearchToolboxTool, WorkIQPreviewToolboxTool
ToolboxVersionObject	A specific version of a toolbox.
ToolboxVersions	The versions associated with a toolbox.
TracesDataGenerationJobOptions	The options for a data generation job with Traces type.
TracesDataGenerationJobSource	Traces source for data generation jobs — conversation traces from Application Insights.
TracesEvaluatorGenerationJobSource	Traces source for evaluator generation jobs — conversation traces from Application Insights.
TracesPreviewEvalRunDataSource	Represents a data source for evaluation runs that operate over Agent traces stored in Application Insights.
TranscriptTextUsageDuration	Duration Usage.
TranscriptTextUsageTokens	Token Usage.
TranscriptTextUsageTokensInputTokenDetails	TranscriptTextUsageTokensInputTokenDetails.
TranscriptionLanguage	A language detected in transcribed audio.
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
TwilioTelephonyBinding	A Twilio binding owned by a voice agent.
TwilioTelephonyBindingListItem	A Twilio binding returned in a list, including its entity tag.
UpdateMemoriesLROPoller	Custom LROPoller for Memory Store update operations.
UpdateModelVersionRequest	Request body for updating a model version. Only description and tags can be modified.
UpdateTelephonyBindingRequest	The request to update an existing telephony binding. Every property is optional and the binding's provider is immutable.
UpdateToolboxRequest	UpdateToolboxRequest.
UserProfileMemoryItem	A memory item specifically containing user profile information extracted from conversations, such as preferences, interests, and personal details.
VersionIndicator	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
VersionRefIndicator	Version indicator that references a specific agent version by name.
VersionSelectionRule	VersionSelectionRule. You probably want to use the sub-classes and not this class directly. Known sub-classes are: FixedRatioVersionSelectionRule
VersionSelector	VersionSelector.
VoiceAgentAnimationConfig	Animation settings for a voice-agent session.
VoiceAgentAudioConfig	The audio configuration for a voice agent. These values are session defaults and may be overridden when connecting.
VoiceAgentAudioInputConfig	Input audio configuration for a voice agent.
VoiceAgentAudioOutputConfig	Output audio configuration for a voice agent. Provider-specific fields are selected by voice_type: openai: voice and speed. azure-standard: voice, voice_locale, speed, voice_temperature, custom_lexicon_url, custom_text_normalization_url, prefer_locales, style, pitch, and volume. azure-custom: all azure-standard fields except style, plus custom_voice_endpoint_id. azure-personal: all azure-standard fields except style, plus personal_voice_model. avatar-voice-sync: all azure-standard fields except voice and style, plus personal_voice_model; the voice name is derived from the avatar. azure-realtime-native: voice and speed. format and output_audio_timestamp_types apply to every voice type.
VoiceAgentAvatarConfig	Avatar configuration for a voice agent. These values are session defaults and may be overridden when connecting.
VoiceAgentAvatarIceServer	An ICE server used for avatar WebRTC negotiation.
VoiceAgentAvatarScene	Avatar placement and motion settings.
VoiceAgentAvatarVideoBackground	The avatar video background.
VoiceAgentAvatarVideoCrop	The rectangular crop applied to avatar video.
VoiceAgentAvatarVideoParams	Avatar video encoder and presentation settings.
VoiceAgentAvatarVideoResolution	The avatar video resolution.
VoiceAgentAzureSemanticVadEnTurnDetection	English-optimized Azure semantic voice activity detection.
VoiceAgentAzureSemanticVadMultilingualTurnDetection	Multilingual Azure semantic voice activity detection.
VoiceAgentAzureSemanticVadTurnDetection	Azure semantic voice activity detection.
VoiceAgentClientEventRtcCallSdpCreate	The rtc.call.sdp.create client event: begins WebRTC signaling with an SDP offer.
VoiceAgentClientEventSessionAvatarConnect	The session.avatar.connect client event.
VoiceAgentClientEventSessionUpdate	The session.update client event.
VoiceAgentDefinition	The voice agent definition. Its configuration (model, instructions, audio, tools, and optional avatar) drives a managed speech-to-speech experience. Establish realtime voice sessions through GET /agents/{agent_name}/endpoint/protocols/voice. Every create or update produces a new immutable version.
VoiceAgentEchoCancellation	Server-side echo cancellation settings for input audio.
VoiceAgentEndConversationSystemTool	A service-managed control that ends the active conversation.
VoiceAgentEndOfUtteranceDetection	Semantic end-of-utterance detection configuration.
VoiceAgentFunctionTool	A native function tool executed by the client.
VoiceAgentGreetingConfig	Session-start greeting configuration for a voice agent. You probably want to use the sub-classes and not this class directly. Known sub-classes are: VoiceAgentLlmGeneratedGreetingConfig, VoiceAgentTemplateGreetingConfig
VoiceAgentInputTranscription	Asynchronous input-audio transcription configuration. Extends the OpenAI Realtime transcription options with the Azure and MAI transcription models, custom speech models, and phrase hints.
VoiceAgentInterimResponseConfig	Fields shared by interim-response configurations. You probably want to use the sub-classes and not this class directly. Known sub-classes are: VoiceAgentLlmInterimResponseConfig, VoiceAgentStaticInterimResponseConfig
VoiceAgentLlmGeneratedGreetingConfig	A greeting authored by the session model from a scoped opening-turn prompt.
VoiceAgentLlmInterimResponseConfig	An interim response generated by a language model.
VoiceAgentMcpTool	An MCP tool available to a voice agent.
VoiceAgentNoiseReduction	Input audio noise reduction configuration.
VoiceAgentRealtimeResponse	A live realtime response returned by the voice-agent service in both response.created and response.done events.
VoiceAgentRealtimeResponseBase	Properties shared by realtime responses returned by the voice-agent service.
VoiceAgentResponseCreateParams	Parameters accepted by a voice-agent response.create event.
VoiceAgentRtcCallErrorDetails	Details of a WebRTC signaling error.
VoiceAgentSemanticVadTurnDetection	OpenAI semantic VAD turn-detection settings.
VoiceAgentServerEventResponseAnimationBlendshapesDelta	The response.animation_blendshapes.delta server event.
VoiceAgentServerEventResponseAnimationBlendshapesDone	The response.animation_blendshapes.done server event.
VoiceAgentServerEventResponseAnimationVisemeDelta	The response.animation_viseme.delta server event.
VoiceAgentServerEventResponseAnimationVisemeDone	The response.animation_viseme.done server event.
VoiceAgentServerEventResponseAudioTimestampDelta	The response.audio_timestamp.delta server event.
VoiceAgentServerEventResponseAudioTimestampDone	The response.audio_timestamp.done server event.
VoiceAgentServerEventResponseVideoDelta	The response.video.delta server event.
VoiceAgentServerEventRtcCallError	The rtc.call.error server event: a WebRTC signaling failure.
VoiceAgentServerEventRtcCallSdpCreated	The rtc.call.sdp.created server event: the SDP answer that completes WebRTC negotiation.
VoiceAgentServerEventSessionAvatarConnecting	The session.avatar.connecting server event.
VoiceAgentServerEventSessionAvatarSwitchToIdle	The session.avatar.switch_to_idle server event.
VoiceAgentServerEventSessionAvatarSwitchToSpeaking	The session.avatar.switch_to_speaking server event.
VoiceAgentServerEventSessionSubagentAborted	The session.subagent.aborted server event.
VoiceAgentServerEventSessionSubagentCompleted	The session.subagent.completed server event.
VoiceAgentServerEventSessionSubagentStarted	The session.subagent.started server event.
VoiceAgentServerEventWarning	The warning server event.
VoiceAgentServerEventWarningDetails	Details of a non-fatal warning.
VoiceAgentServerVadTurnDetection	Server-side voice activity detection.
VoiceAgentSessionAvatarConfig	Avatar settings accepted by the stable voice-agent WebSocket contract.
VoiceAgentSessionResponseConfig	The effective stable realtime session settings returned by the voice-agent service.
VoiceAgentSessionUpdateConfig	The stable realtime session settings accepted in a session.update client event.
VoiceAgentStaticInterimResponseConfig	A static interim response selected from configured text.
VoiceAgentSubagent	A sibling Foundry text agent that a voice agent may consult as a background specialist.
VoiceAgentSubagentConfig	Configuration for sibling Foundry text agents that a voice agent may consult.
VoiceAgentSubagentResponsePolicy	Policy for delivering responses while a voice agent waits for a subagent.
VoiceAgentSystemTool	A service-managed control that acts on the active voice session without customer code or external authentication. You probably want to use the sub-classes and not this class directly. Known sub-classes are: VoiceAgentEndConversationSystemTool
VoiceAgentTemplateGreetingConfig	A deterministic greeting rendered with the voice agent's structured inputs and synthesized without model-authored generation.
VoiceAgentTool	A tool usable by a voice agent. You probably want to use the sub-classes and not this class directly. Known sub-classes are: VoiceAgentFunctionTool, VoiceAgentMcpTool, VoiceAgentSystemTool, VoiceAgentToolboxTool
VoiceAgentToolboxTool	A reference to a Foundry toolbox, which is a versioned bundle of tools executed through its MCP endpoint.
VoiceAgentTranscriptionPhrase	A transcribed phrase with timing information.
VoiceAgentTranscriptionWord	A time-stamped word in an input-audio transcription.
VoiceAgentTurnDetectionConfig	Turn-detection configuration for a voice agent. You probably want to use the sub-classes and not this class directly. Known sub-classes are: VoiceAgentAzureSemanticVadTurnDetection, VoiceAgentAzureSemanticVadEnTurnDetection, VoiceAgentAzureSemanticVadMultilingualTurnDetection, VoiceAgentSemanticVadTurnDetection, VoiceAgentServerVadTurnDetection
VoiceAudioItem	Metadata for a single conversation item's audio segment. For bring-your-own-storage (BYOS), the response includes blob_uri, a direct customer-storage URI without a SAS token, that the customer accesses with their own credentials. For Foundry-managed storage, blob_uri is absent and the bytes are streamed through the item's /audio/content route.
VoiceConversation	A persisted voice conversation. The Foundry envelope that owns a voice agent's stored transcript, responses, per-turn metrics, and audio. It is the parent, retention, and delete boundary: deleting it cascades to its responses, items, metrics, and audio. When finalization fails, any partial persisted responses, items, and item audio remain readable.
VoiceConversationEngine	An engine that owns conversation handling for a voice agent. You probably want to use the sub-classes and not this class directly. Known sub-classes are: VoiceHostedAgentConversationEngine
VoiceGeneratedAudioItem	Metadata for a conversation item's generated audio. For bring-your-own-storage (BYOS), the response includes blob_uri, a direct customer-storage URI without a SAS token, that the customer accesses with their own credentials. For Foundry-managed storage, blob_uri is absent and the bytes are streamed through the item's /audio/generated/content route.
VoiceHostedAgentConversationEngine	A closed reference to the hosted text agent that owns conversation handling for a voice agent. The hosted agent is resolved within the same project and must support the invocations_ws protocol, Voice Live compatibility, and Bridge Protocol 1.0.
VoiceRecording	Metadata for the merged, whole-call stereo recording of a voice conversation (user audio on the left channel, agent audio on the right). Built once from the per-turn segments after the session ends and durably cached. The common metadata (format, sample rate, channels, channel layout, duration) is returned for both Foundry-managed and bring-your-own-storage (BYOS) recordings. For BYOS the response also includes blob_uri, the URI of the recording in the customer's own storage (no SAS token), which the customer downloads using their own storage credentials. For Foundry-managed storage blob_uri is absent and the bytes are streamed via the /audio/content route instead.
VoiceRecordingChannelLayout	The role assigned to each channel of a merged stereo voice recording.
VoiceResponse	A persisted voice response representing one model inference turn within a conversation. In list results the output projection may be omitted; retrieve the full response (GET .../responses/{response_id}) or the paged response-items route (GET .../responses/{response_id}/items) for its output items. created_at/completed_at are Foundry durable ordering extensions.
VoiceResponseAudio	Audio configuration for a response. Follows the OpenAI Realtime GA audio object shape.
VoiceResponseAudioOutput	The flat response audio-output projection, with optional voice, voice_type, voice_locale, and format fields.
VoiceResponseBase	Properties shared by persisted voice responses.
WebIQPreviewTool	A WebIQ server-side tool.
WebIQPreviewToolboxTool	A WebIQ tool stored in a toolbox.
WebSearchApproximateLocation	Web search approximate location.
WebSearchConfiguration	A web search configuration for bing custom search.
WebSearchPreviewTool	Web search preview.
WebSearchTool	Web search.
WebSearchToolFilters	WebSearchToolFilters.
WebSearchToolboxTool	A web search tool stored in a toolbox.
WeeklyRecurrenceSchedule	Weekly recurrence schedule.
WorkIQPreviewTool	A WorkIQ server-side tool.
WorkIQPreviewToolboxTool	A WorkIQ tool stored in a toolbox.
WorkflowAgentDefinition	The workflow agent definition. Microsoft Foundry is retiring workflows on December 1, 2026. If you're looking to build new workflows, use Microsoft Agent Framework. To migrate existing workflows, see the Migration guide.

Enums

A2AProtocolVersion	Supported A2A protocol versions.
ActivityProtocolAccessBoundary	An access boundary for the activity protocol.
AgentBlueprintReferenceType	Type of AgentBlueprintReferenceType.
AgentEndpointAuthorizationSchemeType	Type of AgentEndpointAuthorizationSchemeType.
AgentEndpointProtocol	Type of AgentEndpointProtocol.
AgentIdentityStatus	The status of an agent identity, applicable to both the agent instance identity and the agent blueprint.
AgentInsightOverviewSource	Identifies where an Agent Insights overview came from.
AgentInsightPromptSurface	The Prompt surface changed by a proposed fix.
AgentInsightProposedFixKind	The customer-renderable kind of an agent insight's proposed fix.
AgentInsightRunTrigger	The trigger that started an agent insight run.
AgentInsightSeverity	The severity of an agent insight.
AgentInsightStatus	The lifecycle status of an agent insight.
AgentKind	Type of AgentKind.
AgentObjectType	Type of AgentObjectType.
AgentOptimizationDatasetInputType	Discriminator values for the dataset input union.
AgentSessionStatus	The status of an agent session.
AgentState	The operational state of an agent.
AgentStateSource	Indicates the source of an agent's operational state. Empty when the state is not derived from a specific source.
AgentVersionStatus	The provisioning status of an agent version.
AttackStrategy	Strategies for attacks.
AzureAISearchQueryType	Available query types for Azure AI Search tool.
CallableToolAllowedCaller	Type of CallableToolAllowedCaller.
CodeDependencyResolution	How package dependencies are resolved at deployment time for a code-based hosted agent.
ComputerEnvironment	Type of ComputerEnvironment.
ConnectionType	The Type (or category) of the connection.
ContainerMemoryLimit	Type of ContainerMemoryLimit.
ContainerNetworkPolicyParamType	Type of ContainerNetworkPolicyParamType.
ContainerSkillType	Type of ContainerSkillType.
CreateTranscriptionResponseJsonUsageType	Type of CreateTranscriptionResponseJsonUsageType.
CredentialType	The credential type used by the connection.
CustomToolParamFormatType	Type of CustomToolParamFormatType.
DataGenerationJobOutputType	The supported output file types for a data generation job.
DataGenerationJobOutputWriteMode	The supported write modes for data generation job outputs.
DataGenerationJobScenario	The supported scenarios for a data generation job.
DataGenerationJobSourceType	The supported source types for data generation jobs.
DataGenerationJobType	The supported data generation job types.
DatasetType	Enum to determine the type of data.
DayOfWeek	Days of the week for recurrence schedule.
DeploymentType	Type of DeploymentType.
DigitalWorkerType	The type of digital worker.
EvaluationLevel	The level at which evaluation is performed.
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.
EvaluatorGenerationJobSourceType	The supported source types for evaluator generation jobs.
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.
FoundryModelArtifactProfileCategory	The artifact profile category.
FoundryModelArtifactProfileSignal	Signals detected in the model artifact.
FoundryModelSourceType	The source type of the model.
FoundryModelWarningCode	Warning code for model artifacts.
FoundryModelWeightType	The weight type of the model.
FunctionShellToolParamEnvironmentType	Type of FunctionShellToolParamEnvironmentType.
GenerationWarningType	Category of a warning surfaced on a generated evaluator version. Extensible so new warning categories (e.g., safety, output quality) can be introduced without a breaking change.
GitHubCopilotBuiltInTool	A customer-configurable GitHub Copilot built-in tool.
GitHubIssueEvent	Known GitHub issue events that can fire a routine.
GrammarSyntax1	Type of GrammarSyntax1.
ImageGenAction	Type of ImageGenAction.
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 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.
InsightType	The request of the insights.
JobStatus	Extensible status values shared by Foundry jobs.
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.
Microsoft365PublishScope	The publish scope for the generated Microsoft Teams app.
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.
PublishApprovalStatus	The Microsoft Agent Certification review status of the Microsoft 365 store title published for an agent.
RaiInvocationContentType	How an invocations request/response body is parsed to locate text for content-safety moderation.
RaiInvocationMode	Author-declared response shape for the invocations protocol.
RankerVersionType	Type of RankerVersionType.
RealtimeAudioFormatsType	Type of RealtimeAudioFormatsType.
RealtimeClientEventType	Type of RealtimeClientEventType.
RealtimeConversationItemMessageType	Type of RealtimeConversationItemMessageType.
RealtimeConversationItemType	Type of RealtimeConversationItemType.
RealtimeMcpErrorType	Type of RealtimeMcpErrorType.
RealtimeReasoningEffort	Constrains effort on reasoning for reasoning-capable Realtime models such as gpt-realtime-2.
RealtimeServerEventType	Type of RealtimeServerEventType.
ReasoningEffort	Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, xhigh, and max. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the reasoning guide for model-specific support.
ReasoningModeEnum	Type of ReasoningModeEnum.
RecurrenceType	Recurrence type.
RiskCategory	Risk category for the attack objective.
RoutineActionType	The discriminator values supported for routine actions.
RoutineAttemptSource	Known source paths that can produce a routine run.
RoutineDispatchIdentity	The supported identities for routine dispatch authorization.
RoutineDispatchPayloadType	The discriminator values supported for manual routine dispatch payloads.
RoutineRunPhase	Known lifecycle phases recorded for a routine run.
RoutineTriggerType	The discriminator values supported for routine triggers.
RubricGenerationInputQualityWarningCode	Stable searchable machine-readable warning code for a rubric-generation input-quality warning. Values are snake_case; clients must tolerate additional service-defined identifiers.
RubricGenerationInputQualityWarningSeverity	Advisory severity for a rubric-generation input-quality warning. Initial value set: warning.
RubricGenerationInputQualityWarningSource	Warning source attribution for a rubric-generation input-quality warning. Per-source values (prompt, agent, dataset) match the source category visible to the generation runtime. aggregate is a synthetic value used only for warnings computed across successfully resolved sources. traces is not exposed because trace sources resolve into dataset content upstream.
SampleType	The type of sample used in the analysis.
ScheduleProvisioningStatus	Schedule provisioning status.
ScheduleTaskType	Type of the task.
SearchContentType	Type of SearchContentType.
SearchContextSize	Type of SearchContextSize.
SessionLogEventType	Known SSE event types emitted by the hosted agent session log stream. Additional event types may be introduced in future versions.
SimpleQnAFineTuningQuestionType	The supported question types for SimpleQnA data generation jobs used for fine-tuning scenarios.
TelemetryDataKind	The type of telemetry data to export.
TelemetryEndpointAuthType	The type of authentication for a telemetry endpoint.
TelemetryEndpointKind	The kind of telemetry export endpoint.
TelemetryTransportProtocol	The transport protocol for telemetry export.
TelephonyBindingStatus	The lifecycle status of a telephony binding.
TelephonyCallDurationBasis	The timestamp used as the basis for call duration.
TelephonyCallEndReason	Known service-generated reasons that one telephony call ended, rather than reasons for an overall outbound call job. Additional string codes may be returned.
TelephonyCallJobStatus	The lifecycle status of a durable outbound call job.
TelephonyCallJobTerminalReason	Known terminal reasons for an overall outbound call job, which can span multiple provider attempts. These are distinct from individual call lifecycle reasons. Additional string codes may be returned.
TelephonyCallLifecycleEventName	A provider-neutral lifecycle event name. Known values are stable; additional values may be added over time.
TelephonyCallLifecycleEventOutcome	The outcome of one telephony lifecycle observation.
TelephonyCallLifecycleEventReason	Known service-generated reasons for a telephony lifecycle event. An event reason does not necessarily describe the final outcome of the call. Additional string codes may be returned.
TelephonyCallLifecycleEventSource	The component that supplied a telephony lifecycle observation.
TelephonyCallPhase	The provider-neutral phase reached by an inbound telephony call.
TelephonyCallStatus	The lifecycle status of an inbound telephony call.
TelephonyCallTimestampSource	The source of a telephony lifecycle timestamp.
TelephonyCallTraceMode	The mode used to expose a telephony call as a customer-facing Foundry trace.
TelephonyCallTraceStatus	The availability status of a customer-facing telephony call trace.
TelephonyOutboundDestinationType	The type of destination for an outbound call.
TelephonyOutboundRetryPolicyType	The retry strategy for an outbound call.
TelephonyProvider	A telephony provider supported by an agent binding. Known values are stable; additional values may be added over time.
TelephonyTransferDestinationKind	The kind of telephony transfer destination. Known values are stable; additional values may be added over time.
TextResponseFormatConfigurationType	Type of TextResponseFormatConfigurationType.
ToolChoiceOptions	Tool choice mode.
ToolChoiceParamType	Type of ToolChoiceParamType.
ToolSearchExecutionType	Type of ToolSearchExecutionType.
ToolType	Type of ToolType.
ToolboxToolType	Supported tool types for tools stored in a toolbox.
TreatmentEffectType	Treatment Effect Type.
TriggerType	Type of the trigger.
VersionIndicatorType	The type of version indicator used to determine the agent version backing a session.
VersionSelectorType	Type of VersionSelectorType.
VoiceAgentAnimationOutputType	An animation output produced by a voice-agent session.
VoiceAgentAudioTimestampType	An output-audio timestamp kind supported by a voice agent.
VoiceAgentAvatarOutputProtocol	The transport used to deliver the avatar video stream.
VoiceAgentAvatarType	The avatar type.
VoiceAgentEchoCancellationReferenceSource	The source of reference audio used for echo cancellation.
VoiceAgentEndOfUtteranceDetectionModel	The semantic end-of-utterance detection model.
VoiceAgentEndOfUtteranceThresholdLevel	The sensitivity threshold for semantic end-of-utterance detection.
VoiceAgentInputTranscriptionModel	The input-audio transcription model identifier. This is a model name, not a Foundry deployment name. Mirrors the transcription models supported by the managed voice backend, covering the OpenAI Realtime transcription models plus the Azure and MAI models. Additional values may be added over time.
VoiceAgentInterimResponseTrigger	A condition that may trigger an interim response.
VoiceAgentNoiseReductionType	The input audio noise reduction mode.
VoiceAgentSessionIncludeOption	Additional fields that a voice-agent session may include in service outputs.
VoiceAgentSubagentAbortReason	The reason a subagent consultation was aborted.
VoiceAgentSystemToolName	A service-managed voice-session control action. Known values are stable; additional values may be added over time.
VoiceAgentToolResponseScheduling	When a tool invocation creates a follow-up response. Additional values may be added over time.
VoiceAgentTurnDetectionType	The turn-detection strategy. Additional values may be added over time.
VoiceAudioCodec	An audio codec. Additional values may be added over time.
VoiceAudioContainerFormat	An audio container format. Additional values may be added over time.
VoiceAudioRole	A voice-audio participant role. Additional values may be added over time.
VoiceConversationStatus	The lifecycle status of a persisted voice conversation: in_progress: the live session is active, or post-session persistence finalization is pending. completed: finalization succeeded after normal or client close, end_conversation, a max-duration 1001 close, or a client or network disconnect that the service can still finalize. failed: a terminal service, bridge, storage, or unrecoverable transport failure prevented finalization.
VoiceModelType	How the model backing a voice agent is served. This is independent of the architecture (realtime or cascaded), which the service derives from the selected model.
VoiceOutputModality	An output modality the agent may produce. animation and avatar are used when an avatar is configured.
VoiceType	The voice implementation. Additional values may be added over time.