Azure.AI.Projects.Agents Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| Name | Description |
|---|---|
| A2APreviewTool |
An agent implementing the A2A protocol. |
| A2APreviewToolboxTool |
An A2A tool stored in a toolbox. |
| A2AProtocolConfiguration |
Configuration specific to the A2A protocol. |
| A2AToolboxTool |
An A2A tool stored in a toolbox. |
| ActivityProtocolConfiguration |
Configuration specific to the activity protocol. |
| AgentAdministrationClient |
The AgentAdministrationClient sub-client. |
| AgentAdministrationClientOptions |
Client options for Azure.AI.Projects.Agents.InternalProjectsClient. |
| AgentAdministrationClientSettings |
Represents the settings used to configure a AgentAdministrationClient that can be loaded from an IConfigurationSection. |
| AgentAdministrationSettings |
Represents the settings used to configure a AgentAdministrationClient that can be loaded from an IConfigurationSection. |
| AgentBlueprintReference |
The AgentBlueprintReference. Please note this is the abstract base class. The derived classes available for instantiation are: ManagedAgentIdentityBlueprintReference. |
| AgentCard |
The AgentCard. |
| AgentCardSkill |
The AgentCardSkill. |
| AgentEndpointAuthorizationScheme |
The AgentEndpointAuthorizationScheme. Please note this is the abstract base class. The derived classes available for instantiation are: BotServiceAuthorizationScheme, BotServiceRbacAuthorizationScheme, BotServiceTenantAuthorizationScheme, and EntraAuthorizationScheme. |
| AgentEndpointConfiguration |
The AgentEndpointConfiguration. |
| AgentFromCodeOptions |
Multipart request body for creating a new code-based agent (POST /agents). Inherits from CreateAgentVersionFromCodeContent for future extensibility. |
| AgentHarness |
A managed runtime and agent loop used to execute a prompt agent. Please note this is the abstract base class. The derived classes available for instantiation are: GitHubCopilotHarness and MicrosoftCopilotHarness. |
| AgentIdentity |
The AgentIdentity. |
| AgentManifestOptions |
The AgentManifestOptions. |
| AgentObjectVersions |
The AgentObjectVersions. |
| AgentOptimizationAgentCandidateOutput |
Candidate output produced by an agent-optimization job. |
| AgentOptimizationBaselineAgentConfiguration |
Caller-supplied baseline agent values that cannot be resolved from the target agent. |
| AgentOptimizationCandidate |
A candidate generated by an optimization job. |
| AgentOptimizationCandidateEvaluation |
Comparative evaluation summary for a candidate. |
| AgentOptimizationCandidateOutput |
Base candidate output. Job types define derived output models with their own fields. Please note this is the abstract base class. The derived classes available for instantiation are: AgentOptimizationAgentCandidateOutput and AgentOptimizationPromptCandidateOutput. |
| AgentOptimizationCandidatePromotionInfo |
Promotion metadata recorded for a candidate. |
| AgentOptimizationCandidateSearchConfiguration |
Candidate search settings. |
| AgentOptimizationConfiguration |
Configuration for optimizing an agent for measured quality. |
| AgentOptimizationConfigurationBase |
Base model for type-specific optimization configuration. Please note this is the abstract base class. The derived classes available for instantiation are: AgentOptimizationConfiguration and PromptOptimizationConfiguration. |
| AgentOptimizationCostEstimate |
Estimated monetary cost. Present only when at least one contributing model has pricing data. |
| AgentOptimizationEstimateBand |
A low/typical/ceiling range for an estimated quantity. Cost values apply average per-call usage assumptions to each call-count scenario. Expected values may be fractional, including estimated model-call counts. |
| AgentOptimizationEstimateInputs |
Inputs for estimating an agent-optimization job. |
| AgentOptimizationEstimateResult |
Result returned when estimating an agent-optimization job. |
| AgentOptimizationEvaluationConfiguration |
Reusable quality-measurement configuration. |
| AgentOptimizationEvaluationSet |
Base discriminated model for an optimization evaluation set. Please note this is the abstract base class. The derived classes available for instantiation are: AgentOptimizationTargetCompletionEvaluationSet and AgentOptimizationUserConversationSimulationEvaluationSet. |
| AgentOptimizationEvaluator |
Reference to a named evaluator, optionally pinned to a version. |
| AgentOptimizationFoundryAgentTargetConfiguration |
Identifies the Foundry agent that owns the configuration being optimized. |
| AgentOptimizationInstructionsMutation |
Instructions mutation. |
| AgentOptimizationJob |
Agent optimization job resource — a long-running job that produces candidate changes to a Foundry agent configuration. |
| AgentOptimizationJobCandidates |
The AgentOptimizationJobCandidates sub-client. |
| AgentOptimizationJobLatency |
Average latency for one optimization stage and model. |
| AgentOptimizationJobResult |
Partial or terminal result produced by an agent optimization job. |
| AgentOptimizationJobs |
The AgentOptimizationJobs sub-client. |
| AgentOptimizationJobTokenUsage |
Aggregated token usage for one optimization stage and model. |
| AgentOptimizationModelConfiguration |
Identifies a model used by an optimization or evaluation step. |
| AgentOptimizationModelMutation |
Model mutation. |
| AgentOptimizationMutation |
Base candidate mutation. Please note this is the abstract base class. The derived classes available for instantiation are: AgentOptimizationInstructionsMutation, AgentOptimizationModelMutation, AgentOptimizationSkillsMutation, and AgentOptimizationToolsMutation. |
| AgentOptimizationPromptCandidateOutput |
Candidate output produced by a prompt-optimization job. |
| AgentOptimizationResultCandidateSummary |
Summary of candidates produced by an agent optimization job. |
| AgentOptimizationSkill |
A skill in the manually supplied agent optimization surface. |
| AgentOptimizationSkillsMutation |
Skill mutations. |
| AgentOptimizationSpace |
The agent attributes and alternative values available to an agent-optimization search. |
| AgentOptimizationStageEstimate |
Estimated values grouped by optimization stage. |
| AgentOptimizationTargetCompletionDatasetReferenceDataSource |
References an explicitly versioned registered Foundry dataset for target-completion evaluation. |
| AgentOptimizationTargetCompletionDataSource |
Base source for a target-completion optimization evaluation set. Please note this is the abstract base class. The derived classes available for instantiation are: AgentOptimizationTargetCompletionDatasetReferenceDataSource and AgentOptimizationTargetCompletionInlineDataSource. |
| AgentOptimizationTargetCompletionEvaluationSet |
Evaluation set containing independent single-turn inputs. |
| AgentOptimizationTargetCompletionInlineDataSource |
Supplies single-turn rows directly in the optimization request. |
| AgentOptimizationTargetCompletionTestCase |
A single item in an inline evaluation set. |
| AgentOptimizationTargetConfiguration |
Base target configuration for an optimization job. Please note this is the abstract base class. The derived classes available for instantiation are: AgentOptimizationFoundryAgentTargetConfiguration. |
| AgentOptimizationToolsMutation |
Tool mutations. |
| AgentOptimizationUserConversationSimulationDatasetReferenceDataSource |
References an explicitly versioned registered Foundry dataset for user-conversation-simulation evaluation. |
| AgentOptimizationUserConversationSimulationDataSource |
Base source for a user-conversation-simulation optimization evaluation set. Please note this is the abstract base class. The derived classes available for instantiation are: AgentOptimizationUserConversationSimulationDatasetReferenceDataSource and AgentOptimizationUserConversationSimulationInlineDataSource. |
| AgentOptimizationUserConversationSimulationEvaluationSet |
Evaluation set containing scenarios for simulated conversations. |
| AgentOptimizationUserConversationSimulationInlineDataSource |
Supplies Evals user-conversation simulation test cases directly in the optimization request. |
| AgentReference |
The AgentReference. |
| AgentSessionFiles |
Session-scoped file operations for hosted agent sandboxes. These endpoints enable uploading, downloading, listing, and deleting files within a live ADC sandbox session. All file content is streamed end-to-end (no buffering in Agents service memory). Sessions are scoped to agent endpoints (not individual versions), allowing the endpoint to evolve the backing agent version independently of the session lifecycle. |
| AgentsSkill |
A skill resource. |
| AgentToolboxes |
The AgentToolboxes sub-client. |
| AgentVersionFromCodeMetadata |
JSON metadata for code-based agent operations (create, update, create version).
The agent name comes from the URL path parameter or the |
| AzureAIProjectsAgentsContext |
Context class which will be filled in by the System.ClientModel.SourceGeneration. For more information https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/System.ClientModel/src/docs/ModelReaderWriterContext.md |
| AzureAISearchTool |
The input definition information for an Azure AI search tool as used to configure an agent. |
| AzureAISearchToolboxTool |
An Azure AI Search tool stored in a toolbox. |
| AzureAISearchToolIndex |
A AI Search Index resource. |
| AzureAISearchToolOptions |
A set of index resources used by the |
| AzureFunctionBinding |
The structure for keeping storage queue name and URI. |
| AzureFunctionDefinition |
The definition of Azure function. |
| AzureFunctionDefinitionFunction |
The 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. |
| BetaVoiceAgentsConversations |
Read-only, endpoint-scoped retrieval of the conversations, responses, transcript items, per-turn
metrics, and audio recorded by a voice agent. For a |
| BetaVoiceAgentsTelephony |
The BetaVoiceAgentsTelephony sub-client. |
| BingCustomSearchConfiguration |
A bing custom search configuration. |
| BingCustomSearchPreviewTool |
The input definition information for a Bing custom search tool as used to configure an agent. |
| BingCustomSearchToolOptions |
The bing custom search tool parameters. |
| BingGroundingSearchConfiguration |
Search configuration for Bing Grounding. |
| BingGroundingSearchToolOptions |
The bing grounding search tool parameters. |
| BingGroundingTool |
The input definition information for a bing grounding search tool as used to configure an agent. |
| BotServiceAuthorizationScheme |
The BotServiceAuthorizationScheme. |
| BotServiceRbacAuthorizationScheme |
The BotServiceRbacAuthorizationScheme. |
| BotServiceTenantAuthorizationScheme |
The BotServiceTenantAuthorizationScheme. |
| BrowserAutomationPreviewTool |
The input definition information for a Browser Automation Tool, as used to configure an Agent. |
| BrowserAutomationToolboxTool |
A browser automation tool stored in a toolbox. |
| BrowserAutomationToolConnectionParameters |
Definition of input parameters for the connection used by the Browser Automation Tool. |
| BrowserAutomationToolOptions |
Definition of input parameters for the Browser Automation Tool. |
| CaptureStructuredOutputsTool |
A tool for capturing structured outputs. |
| ClientConnectionProviderExtensions |
Extension methods on ClientConnectionProvider that produce Foundry-project-specific agent clients. |
| CodeConfiguration |
Code-based deployment configuration for a hosted agent. |
| CodeInterpreterToolboxTool |
A code interpreter tool stored in a toolbox. |
| ContainerConfiguration |
Container-based deployment configuration for a hosted agent. |
| ContainerSkill |
The ContainerSkill. Please note this is the abstract base class. The derived classes available for instantiation are: InlineSkillParam and SkillReferenceParam. |
| ContentFilterConfiguration |
Configuration for Responsible AI (RAI) content filtering and safety features. |
| CreateAgentVersionFromManifestRequest |
The CreateAgentVersionFromManifestRequest. |
| CreateTeamsPhoneExtensibilityTelephonyBindingContent |
The request to create a Microsoft Teams Phone extensibility binding. |
| CreateTelephonyBindingContent |
The request to create a telephony binding. Please note this is the abstract base class. The derived classes available for instantiation are: CreateTeamsPhoneExtensibilityTelephonyBindingContent and CreateTwilioTelephonyBindingContent. |
| CreateTelephonyCallJobContent |
A request to create one durable direct outbound call job. |
| CreateTwilioTelephonyBindingContent |
The request to create a Twilio binding. |
| DeclarativeAgentDefinition |
The prompt agent definition. |
| EntraAuthorizationScheme |
The EntraAuthorizationScheme. |
| EvaluationAzureStandardVoiceModelConfiguration |
Configures an Azure standard neural voice used to convert text to speech for evaluation through the Voice Live endpoint. |
| EvaluationModelConfiguration |
Configures the model that plays the simulated user. This model is separate from the evaluated |
| EvaluationVoiceModelConfiguration |
Voice configuration used to convert text to speech for evaluation through the Voice Live endpoint. Please note this is the abstract base class. The derived classes available for instantiation are: EvaluationAzureStandardVoiceModelConfiguration. |
| 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. |
| FabricDataAgentToolOptions |
The fabric data agent tool parameters. |
| FabricIQPreviewToolboxTool |
A FabricIQ tool stored in a toolbox. |
| FileSearchToolboxTool |
A file search tool stored in a toolbox. |
| FixedRatioVersionSelectionRule |
The FixedRatioVersionSelectionRule. |
| GenerateVoiceAgentRequest |
The inputs for generating a voice agent. Only |
| GitHubCopilotHarness |
The legacy GitHub Copilot managed harness retained for compatibility. Use |
| HeaderTelemetryEndpointAuth |
Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header. |
| HostedAgentDefinition |
The hosted agent definition. |
| InlineSkillParam |
The InlineSkillParam. |
| InlineSkillSourceParam |
Inline skill payload. |
| InvocationsProtocolConfiguration |
Configuration specific to the invocations protocol. |
| InvocationsWsProtocolConfiguration |
Configuration specific to the WebSocket-based invocations protocol. |
| ManagedAgentIdentityBlueprintReference |
The ManagedAgentIdentityBlueprintReference. |
| McpProtocolConfiguration |
Configuration specific to the MCP protocol. |
| MCPToolboxTool |
An MCP tool stored in a toolbox. |
| McpToolExtensions |
Extension methods on OpenAI.Responses.McpTool that expose Foundry-project-specific configuration (such as the project connection identifier). |
| MemorySearchPreviewTool |
A tool for integrating memories into the agent. |
| MemorySearchToolOptions |
Memory search options. |
| MicrosoftCopilotHarness |
The Microsoft Copilot managed harness for prompt agents. |
| MicrosoftFabricPreviewTool |
The input definition information for a Microsoft Fabric tool as used to configure an agent. |
| ModelSamplingParams |
Represents a set of parameters used to control the sampling behavior of a language model during text generation. |
| OpenAPIAnonymousAuthenticationDetails |
Security details for OpenApi anonymous authentication. |
| OpenApiAuthenticationDetails |
authentication details for OpenApiFunctionDefinition Please note this is the abstract base class. The derived classes available for instantiation are: OpenAPIAnonymousAuthenticationDetails, OpenApiProjectConnectionAuthenticationDetails, and OpenAPIManagedAuthenticationDetails. |
| OpenApiFunctionDefinition |
The input definition information for an openapi function. |
| OpenAPIFunctionEntry |
The OpenAPIFunctionEntry. |
| OpenAPIManagedAuthenticationDetails |
Security details for OpenApi managed_identity authentication. |
| OpenAPIManagedSecurityScheme |
Security scheme for OpenApi managed_identity authentication. |
| OpenApiProjectConnectionAuthenticationDetails |
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. |
| OptimizationContext |
Base model for typed optimization context. Please note this is the abstract base class. The derived classes available for instantiation are: SteeringPromptOptimizationContext. |
| OtlpTelemetryEndpoint |
An OTLP (OpenTelemetry Protocol) telemetry export endpoint. |
| PatchAgentOptions |
The PatchAgentOptions. |
| ProjectAgentSession |
An agent session providing a long-lived compute sandbox for hosted agent invocations. |
| ProjectAgentSkills |
The ProjectAgentSkills sub-client. |
| ProjectsAgentDefinition |
The ProjectsAgentDefinition. Please note this is the abstract base class. The derived classes available for instantiation are: DeclarativeAgentDefinition, ExternalAgentDefinition, HostedAgentDefinition, VoiceAgentDefinition, and WorkflowAgentDefinition. |
| ProjectsAgentRecord |
The ProjectsAgentRecord. |
| ProjectsAgentsModelFactory |
A factory class for creating instances of the models for mocking. |
| ProjectsAgentTool |
A tool that can be used to generate a response. Please note this is the abstract base class. The derived classes available for instantiation are: Azure.AI.Projects.Agents.FabricIQPreviewTool, BingGroundingTool, MicrosoftFabricPreviewTool, SharepointPreviewTool, AzureAISearchTool, OpenAPITool, BingCustomSearchPreviewTool, BrowserAutomationPreviewTool, AzureFunctionTool, CaptureStructuredOutputsTool, A2APreviewTool, Azure.AI.Projects.Agents.A2ATool, Azure.AI.Projects.Agents.WorkIQPreviewTool, Azure.AI.Projects.Agents.WebIQPreviewTool, MemorySearchPreviewTool, OpenAI.ProgrammaticToolCallingParam, and Azure.AI.Projects.Agents.ToolSearchTool. |
| ProjectsAgentVersion |
The ProjectsAgentVersion. |
| ProjectsAgentVersionCreationOptions |
The ProjectsAgentVersionCreationOptions. |
| ProjectWebSearchConfiguration |
A web search configuration for bing custom search. |
| PromptOptimizationConfiguration |
Configuration for a one-shot prompt transformation without comparative evaluation. |
| ProtocolConfiguration |
Per-protocol configuration for the agent endpoint. |
| ProtocolVersionRecord |
A record mapping for a single protocol and its version. |
| PSTNTelephonyTransferDestination |
A PSTN destination for a telephony transfer target. |
| 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. |
| RealtimeFunctionToolParameters |
The RealtimeFunctionToolParameters. |
| ReminderPreviewToolboxTool |
A reminder tool stored in a toolbox. |
| ResponsesProtocolConfiguration |
Configuration specific to the responses protocol. |
| ResponseToolExtensions |
Extension methods that convert OpenAI OpenAI.Responses.ResponseTool instances into the equivalent ProjectsAgentTool representation. |
| 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
|
| SharePointGroundingToolOptions |
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. |
| SipTelephonyTransferDestination |
A SIP destination for a telephony transfer target. |
| SkillDeletionResult |
A deleted skill. |
| 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 |
The SkillReferenceParam. |
| SkillVersion |
A specific version of a skill. |
| SkillVersionDeletionResult |
A deleted skill version. |
| SteeringPromptOptimizationContext |
Natural-language guidance for the desired optimization. |
| 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. |
| TeamsPhoneExtensibilityTelephonyBinding |
A Microsoft Teams Phone extensibility binding owned by a voice agent. |
| TeamsPhoneExtensibilityTelephonyBindingListItem |
A Microsoft Teams Phone extensibility 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. Please note this is the abstract base class. The derived classes available for instantiation are: OtlpTelemetryEndpoint. |
| TelemetryEndpointAuthentication |
Authentication configuration for a telemetry endpoint. Please note this is the abstract base class. The derived classes available for instantiation are: HeaderTelemetryEndpointAuth. |
| TelephonyBinding |
A telephony binding owned by a voice agent. Please note this is the abstract base class. The derived classes available for instantiation are: TeamsPhoneExtensibilityTelephonyBinding and TwilioTelephonyBinding. |
| TelephonyBindingListItem |
A telephony binding returned in a list, including its entity tag. Please note this is the abstract base class. The derived classes available for instantiation are: TeamsPhoneExtensibilityTelephonyBindingListItem and 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. |
| TelephonyOutboundFixedIntervalRetryPolicyResult |
The frozen fixed-interval retry policy returned for an outbound call or campaign. |
| TelephonyOutboundRetryPolicy |
The retry policy for one durable outbound call intent. |
| TelephonyTransferDestination |
A destination for a telephony transfer target. Please note this is the abstract base class. The derived classes available for instantiation are: PSTNTelephonyTransferDestination, SipTelephonyTransferDestination, and TeamsTelephonyTransferDestination. |
| TelephonyTransferTarget |
A named destination to which the voice agent may transfer a call. |
| TelephonyTransferTargets |
The telephony transfer targets configured for one voice agent. |
| ToolboxPolicies |
Policy configuration for a toolbox, including content safety and other governance settings. |
| ToolboxRecord |
A toolbox that stores reusable tool definitions for agents. |
| 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. Please note this is the abstract base class. The derived classes available for instantiation are: ToolboxShellContainerAutoEnvironment and ToolboxShellContainerReferenceEnvironment. |
| ToolboxShellNetworkPolicy |
Network access policy for an automatically provisioned toolbox shell container. Please note this is the abstract base class. The derived classes available for instantiation are: ToolboxShellNetworkPolicyDisabled. |
| ToolboxShellNetworkPolicyDisabled |
A network policy that disables outbound access from a toolbox shell container. |
| ToolboxSkill |
A skill source included in a toolbox. Please note this is the abstract base class. The derived classes available for instantiation 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. Please note this is the abstract base class. The derived classes available for instantiation are: A2APreviewToolboxTool, A2AToolboxTool, AzureAISearchToolboxTool, Azure.AI.Projects.Agents.BrowserAutomationPreviewToolboxTool, BrowserAutomationToolboxTool, CodeInterpreterToolboxTool, FabricIQPreviewToolboxTool, FileSearchToolboxTool, MCPToolboxTool, OpenApiToolboxTool, ReminderPreviewToolboxTool, ShellToolboxTool, ToolSearchToolboxTool, ToolboxSearchPreviewToolboxTool, WebIQPreviewToolboxTool, WebSearchToolboxTool, and WorkIQPreviewToolboxTool. |
| ToolboxVersion |
A specific version of a toolbox. |
| ToolboxVersions |
The versions associated with a toolbox. |
| ToolChoiceOption |
Represents constraints placed on tool calls made by the model. |
| ToolProjectConnection |
A project connection resource. |
| ToolSearchToolboxTool |
A toolbox search tool stored in a toolbox. |
| TwilioTelephonyBinding |
A Twilio binding owned by a voice agent. |
| TwilioTelephonyBindingListItem |
A Twilio binding returned in a list, including its entity tag. |
| UpdateToolboxRequest |
The UpdateToolboxRequest. |
| UserConversationSimulationAudioEffectsConfiguration |
Configures effects applied to simulated conversation audio. |
| UserConversationSimulationConfiguration |
Configures the number, length, audio effects, and simulated user behavior of conversations. |
| UserConversationSimulationDefaultInterruptionConfiguration |
Configures the default interruption behavior for the simulated user. |
| UserConversationSimulationInterruptionConfiguration |
Configuration for simulated user interruption behavior. Please note this is the abstract base class. The derived classes available for instantiation are: UserConversationSimulationDefaultInterruptionConfiguration. |
| UserConversationSimulationTestCase |
Defines one test scenario. Simulation configuration properties specified here override the corresponding data-source defaults. |
| UserConversationSimulationUserBehaviorConfiguration |
Configures conversation behavior for the simulated user. |
| VersionIndicator |
Version indicator determining which agent version backs the session. Please note this is the abstract base class. The derived classes available for instantiation are: VersionRefIndicator. |
| VersionRefIndicator |
Version indicator that references a specific agent version by name. |
| VersionSelectionRule |
The VersionSelectionRule. Please note this is the abstract base class. The derived classes available for instantiation are: FixedRatioVersionSelectionRule. |
| VersionSelector |
The VersionSelector. |
| 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
|
| VoiceAgentAvatarConfig |
Avatar configuration for a voice agent. These values are session defaults and may be overridden when connecting. |
| 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. |
| 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
|
| 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. |
| VoiceAgentEventGridPostCallDestination |
An Event Grid connection that receives post-call events. |
| VoiceAgentFunctionTool |
A native function tool executed by the client. |
| VoiceAgentGreetingConfig |
Session-start greeting configuration for a voice agent. Please note this is the abstract base class. The derived classes available for instantiation are: VoiceAgentLlmGeneratedGreetingConfig and VoiceAgentTemplateGreetingConfig. |
| VoiceAgentInputTranscription |
Settings for transcribing input audio, including the transcription model, Custom Speech deployments,
and phrase hints.
When |
| VoiceAgentInterimResponseConfig |
Fields shared by interim-response configurations. Please note this is the abstract base class. The derived classes available for instantiation are: VoiceAgentLlmInterimResponseConfig and VoiceAgentStaticInterimResponseConfig. |
| VoiceAgentLlmGeneratedGreetingConfig |
A greeting authored by the session model from a scoped opening-turn prompt. |
| VoiceAgentLlmInterimResponseConfig |
An interim response generated by a language model. |
| VoiceAgentMaxOutputTokens |
The VoiceAgentMaxOutputTokens represents integer value, or infinity. |
| VoiceAgentMcpTool |
An MCP tool available to a voice agent. Server endpoints use |
| VoiceAgentNoiseReduction |
Input audio noise reduction configuration. |
| VoiceAgentPostCallConfig |
Post-call delivery configuration. |
| VoiceAgentPostCallDestination |
A post-call destination. Please note this is the abstract base class. The derived classes available for instantiation are: VoiceAgentEventGridPostCallDestination and VoiceAgentRoutinePostCallDestination. |
| VoiceAgentRoutinePostCallDestination |
A routine that is dispatched with the post-call event. |
| VoiceAgentSemanticVadTurnDetection |
OpenAI semantic VAD turn-detection settings. |
| VoiceAgentServerVadTurnDetection |
Server-side voice activity detection. |
| VoiceAgentSoundscapeConfig |
Agent-owned background ambience and event cues. Each omitted track is disabled. The service rejects unknown fields; custom uploads, URLs, and inline audio are not supported. |
| VoiceAgentSoundscapeSourceConfig |
A packaged sound selected from the service-managed catalogue. The service rejects unknown source fields and discriminator values. |
| VoiceAgentSoundscapeTrackConfig |
A soundscape track with its own audio source and playback volume. |
| VoiceAgentSoundscapeWorkingTrackConfig |
A working-loop track with a delay measured from the first pending non-call-control tool. |
| 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. |
| 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. Please note this is the abstract base class. The derived classes available for instantiation are: VoiceAgentFunctionTool, VoiceAgentMcpTool, VoiceAgentSystemTool, and VoiceAgentToolboxTool. |
| VoiceAgentToolboxTool |
A reference to a Foundry toolbox, which is a versioned bundle of tools executed through its MCP endpoint. |
| VoiceAgentTurnDetectionConfig |
Turn-detection configuration for a voice agent. Please note this is the abstract base class. The derived classes available for instantiation are: VoiceAgentAzureSemanticVadEnTurnDetection, VoiceAgentAzureSemanticVadMultilingualTurnDetection, VoiceAgentAzureSemanticVadTurnDetection, VoiceAgentSemanticVadTurnDetection, and VoiceAgentServerVadTurnDetection. |
| VoiceAudioItem |
Metadata for a single conversation item's audio segment. For bring-your-own-storage (BYOS), the response includes
|
| 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. Please note this is the abstract base class. The derived classes available for instantiation are: VoiceHostedAgentConversationEngine. |
| VoiceGeneratedAudioItem |
Metadata for a conversation item's generated audio. For bring-your-own-storage (BYOS), the response includes
|
| 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 declare |
| 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 |
| VoiceRecordingChannelLayout |
The role assigned to each channel of a merged stereo voice recording. |
| VoiceResponseAudio |
Audio configuration for a response. Follows the OpenAI Realtime GA |
| VoiceResponseAudioOutput |
The flat response audio-output projection, with optional |
| VoiceResult |
A persisted voice response representing one model inference turn within a conversation. In list results the
|
| WebIQPreviewToolboxTool |
A WebIQ tool stored in a toolbox. |
| WebSearchToolboxTool |
A web search tool stored in a toolbox. |
| WebSearchToolExtensions |
Extension methods that expose Microsoft Foundry-specific configuration on OpenAI.Responses.WebSearchTool instances. |
| 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. |
| WorkIQPreviewToolboxTool |
A WorkIQ tool stored in a toolbox. |
Structs
| Name | Description |
|---|---|
| A2AProtocolVersion |
Supported A2A protocol versions. |
| ActivityProtocolAccessBoundary |
An access boundary for the activity protocol. |
| AgentIdentityStatus |
The status of an agent identity, applicable to both the agent instance identity and the agent blueprint. |
| AgentListOrder | |
| AgentOptimizationCandidateExpand |
Vocabulary for the |
| AgentOptimizationCandidateStatus |
The candidate's lifecycle state. |
| AgentOptimizationGoal |
Goal for an agent-optimization job. |
| AgentOptimizationStage |
Stage of optimization that consumed model resources. |
| AgentOptimizationTerminationReason |
Reason the optimization process ended. Early termination reasons still indicate a successful job; completed candidates remain available. |
| AgentSessionStatus |
The status of an agent session. |
| AgentsJobStatus |
Extensible status values shared by Foundry jobs. |
| 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. |
| AzureAISearchQueryType |
Available query types for Azure AI Search tool. |
| CodeDependencyResolution |
How package dependencies are resolved at deployment time for a code-based hosted agent. |
| DigitalWorkerType |
The type of digital worker. |
| ExportedDataTypes |
The type of telemetry data to export. |
| ProjectsAgentKind | |
| ProjectsAgentProtocol | |
| 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. |
| SessionLogEventKind |
Known SSE event types emitted by the hosted agent session log stream. Additional event types may be introduced in future versions. |
| TargetAttribute |
Agent attribute that can be optimized. |
| 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. |
| TelephonyProvider |
A telephony provider supported by an agent binding. Known values are stable; additional values may be added over time. |
| ToolChoiceLiteral |
The available set of mode-level, string literal tool_choice options for the voicelive endpoint. |
| UserConversationSimulationAudioEffect |
Effect that can be applied to simulated conversation audio. The union is extensible for additional effects. |
| VoiceAgentAvatarOutputProtocol |
The transport used to deliver the avatar video stream. |
| VoiceAgentAvatarType |
The avatar type. |
| 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.
|
| VoiceAgentInterimResponseTrigger |
A condition that may trigger an interim response. |
| VoiceAgentNoiseReductionType |
The input audio noise reduction mode.
|
| VoiceAgentPostCallIncludeOption |
Content that can be included in a post-call delivery. |
| VoiceAgentProfanityFilterMode |
The supported input-transcript profanity filtering modes. |
| VoiceAgentSoundscapeSound |
The packaged sounds accepted by a built-in soundscape source. |
| 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. |
| VoiceAgentTransport |
The transport used for a voice-agent connection. |
| 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:
|
| 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. |
| VoiceResponseObject | |
| VoiceType |
The voice implementation. Additional values may be added over time. |
Enums
| Name | Description |
|---|---|
| AgentAdministrationClientOptions.ServiceVersion |
The version of the service to use. |
| CallableToolAllowedCaller | |
| VoiceAgentAudioInputConfigTranscriptionDelay | |
| VoiceAgentAudioTimestampType |
An output-audio timestamp kind supported by a voice agent. |
| VoiceAgentEchoCancellationReferenceSource |
The source of reference audio used for echo cancellation. |
| VoiceAgentSessionIncludeOption |
Additional fields that a voice-agent session may include in service outputs. |