@azure/ai-projects package

Classes

AIProjectClient

gets the OpenAI client with optional OpenAI client options

Interfaces

@azure/ai-projects.Index

A2APreviewTool	An agent implementing the A2A protocol.
AIProjectClientOptionalParams	Optional parameters for the client.
AISearchIndexResource	A AI Search Index resource.
Agent	model interface Agent
AgentBlueprintReference	model interface AgentBlueprintReference
AgentCard	model interface AgentCard
AgentCardSkill	model interface 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	Base definition interface for agents. Contains the agent kind and optional RAI configuration.
AgentEndpointAuthorizationScheme	model interface AgentEndpointAuthorizationScheme
AgentEndpointConfig	model interface AgentEndpointConfig
AgentEvaluatorGenerationJobSource	Agent source for evaluator generation jobs — references an agent to fetch instructions and metadata from.
AgentIdentifier	Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config.
AgentIdentity	model interface AgentIdentity
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.
AgentVersion	Represents a specific version of an agent. Includes metadata, versioning, creation time, and agent definition.
AgenticIdentityPreviewCredentials	Agentic identity credential definition
AgentsCreateAgentFromManifestOptionalParams	Optional parameters.
AgentsCreateAgentVersionFromManifestOptionalParams	Optional parameters.
AgentsCreateOptionalParams	Optional parameters.
AgentsCreateVersionOptionalParams	Optional parameters.
AgentsDeleteOptionalParams	Optional parameters.
AgentsDeleteVersionOptionalParams	Optional parameters.
AgentsGetOptionalParams	Optional parameters.
AgentsGetVersionOptionalParams	Optional parameters.
AgentsListOptionalParams	Optional parameters.
AgentsListVersionsOptionalParams	Optional parameters.
AgentsOperations	Interface representing a Agents operations.
AgentsPagedResultOptimizationCandidate	The response data for a requested list of items.
AgentsUpdateAgentFromManifestOptionalParams	Optional parameters.
AgentsUpdateOptionalParams	Optional parameters.
ApiErrorResponse	Error response for API failures.
ApiKeyCredentials	API Key Credential definition
ApplyPatchToolParam	Allows the assistant to create, delete, or update files using unified diffs.
ApproximateLocation	model interface ApproximateLocation
ArtifactProfile	Artifact profile of the model
AutoCodeInterpreterToolParam	Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
AzureAIAgentTarget	Represents a target specifying an Azure AI agent.
AzureAIModelTarget	Represents a target specifying an Azure AI model for operations requiring model selection.
AzureAISearchIndex	Azure AI Search Index Definition
AzureAISearchTool	The input definition information for an Azure AI search tool as used to configure an agent.
AzureAISearchToolResource	A set of index resources used by the azure_ai_search tool.
AzureAgentConfig	Configuration options for agent endpoint of getOpenAIClient method. Mainly used for hosted agents.
AzureFunctionBinding	The structure for keeping storage queue name and URI.
AzureFunctionDefinition	The definition of Azure function.
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
BetaAgentsCancelOptimizationJobOptionalParams	Optional parameters.
BetaAgentsCreateAgentVersionFromCodeOptionalParams	Optional parameters.
BetaAgentsCreateOptimizationJobOptionalParams	Optional parameters.
BetaAgentsCreateSessionOptionalParams	Optional parameters.
BetaAgentsDeleteOptimizationJobOptionalParams	Optional parameters.
BetaAgentsDeleteSessionFileOptionalParams	Optional parameters.
BetaAgentsDeleteSessionOptionalParams	Optional parameters.
BetaAgentsDownloadAgentCodeOptionalParams	Optional parameters.
BetaAgentsDownloadSessionFileOptionalParams	Optional parameters.
BetaAgentsGetCandidateFileOptionalParams	Optional parameters.
BetaAgentsGetOptimizationCandidateConfigOptionalParams	Optional parameters.
BetaAgentsGetOptimizationCandidateOptionalParams	Optional parameters.
BetaAgentsGetOptimizationCandidateResultsOptionalParams	Optional parameters.
BetaAgentsGetOptimizationJobOptionalParams	Optional parameters.
BetaAgentsGetSessionLogStreamOptionalParams	Optional parameters.
BetaAgentsGetSessionOptionalParams	Optional parameters.
BetaAgentsListOptimizationCandidatesOptionalParams	Optional parameters.
BetaAgentsListOptimizationJobsOptionalParams	Optional parameters.
BetaAgentsListSessionFilesOptionalParams	Optional parameters.
BetaAgentsListSessionsOptionalParams	Optional parameters.
BetaAgentsOperations	Interface representing a BetaAgents operations.
BetaAgentsPatchAgentObjectOptionalParams	Optional parameters.
BetaAgentsPromoteCandidateOptionalParams	Optional parameters.
BetaAgentsStopSessionOptionalParams	Optional parameters.
BetaAgentsUploadSessionFileOptionalParams	Optional parameters.
BetaDatasetsCancelGenerationJobOptionalParams	Optional parameters.
BetaDatasetsCreateGenerationJobOptionalParams	Optional parameters.
BetaDatasetsDeleteGenerationJobOptionalParams	Optional parameters.
BetaDatasetsGetGenerationJobOptionalParams	Optional parameters.
BetaDatasetsListGenerationJobsOptionalParams	Optional parameters.
BetaDatasetsOperations	Interface representing a BetaDatasets operations.
BetaEvaluationTaxonomiesCreateOptionalParams	Optional parameters.
BetaEvaluationTaxonomiesDeleteOptionalParams	Optional parameters.
BetaEvaluationTaxonomiesGetOptionalParams	Optional parameters.
BetaEvaluationTaxonomiesListOptionalParams	Optional parameters.
BetaEvaluationTaxonomiesOperations	Interface representing a BetaEvaluationTaxonomies operations.
BetaEvaluationTaxonomiesUpdateOptionalParams	Optional parameters.
BetaEvaluatorsCancelGenerationJobOptionalParams	Optional parameters.
BetaEvaluatorsCreateGenerationJobOptionalParams	Optional parameters.
BetaEvaluatorsCreateVersionOptionalParams	Optional parameters.
BetaEvaluatorsDeleteGenerationJobOptionalParams	Optional parameters.
BetaEvaluatorsDeleteVersionOptionalParams	Optional parameters.
BetaEvaluatorsGetCredentialsOptionalParams	Optional parameters.
BetaEvaluatorsGetGenerationJobOptionalParams	Optional parameters.
BetaEvaluatorsGetVersionOptionalParams	Optional parameters.
BetaEvaluatorsListGenerationJobsOptionalParams	Optional parameters.
BetaEvaluatorsListOptionalParams	Optional parameters.
BetaEvaluatorsListVersionsOptionalParams	Optional parameters.
BetaEvaluatorsOperations	Interface representing a BetaEvaluators operations.
BetaEvaluatorsPendingUploadOptionalParams	Optional parameters.
BetaEvaluatorsUpdateVersionOptionalParams	Optional parameters.
BetaInsightsGenerateOptionalParams	Optional parameters.
BetaInsightsGetOptionalParams	Optional parameters.
BetaInsightsListOptionalParams	Optional parameters.
BetaInsightsOperations	Interface representing a BetaInsights operations.
BetaMemoryStoresCreateMemoryOptionalParams	Optional parameters.
BetaMemoryStoresCreateOptionalParams	Optional parameters.
BetaMemoryStoresDeleteMemoryOptionalParams	Optional parameters.
BetaMemoryStoresDeleteOptionalParams	Optional parameters.
BetaMemoryStoresDeleteScopeOptionalParams	Optional parameters.
BetaMemoryStoresGetMemoryOptionalParams	Optional parameters.
BetaMemoryStoresGetOptionalParams	Optional parameters.
BetaMemoryStoresGetUpdateResultOptionalParams	Optional parameters.
BetaMemoryStoresListMemoriesOptionalParams	Optional parameters.
BetaMemoryStoresListOptionalParams	Optional parameters.
BetaMemoryStoresOperations	Interface representing a BetaMemoryStores operations.
BetaMemoryStoresSearchMemoriesOptionalParams	Optional parameters.
BetaMemoryStoresUpdateMemoriesOptionalParams	Optional parameters.
BetaMemoryStoresUpdateMemoryOptionalParams	Optional parameters.
BetaMemoryStoresUpdateOptionalParams	Optional parameters.
BetaModelsCreateOptions	Options for the create method that uploads local files and registers a model version.
BetaModelsDeleteOptionalParams	Optional parameters.
BetaModelsGetCredentialsOptionalParams	Optional parameters.
BetaModelsGetOptionalParams	Optional parameters.
BetaModelsListOptionalParams	Optional parameters.
BetaModelsListVersionsOptionalParams	Optional parameters.
BetaModelsOperations	Interface representing a BetaModels operations.
BetaModelsPendingCreateVersionOptionalParams	Optional parameters.
BetaModelsPendingUploadOptionalParams	Optional parameters.
BetaModelsUpdateOptionalParams	Optional parameters.
BetaOperations	Interface representing a Beta operations.
BetaRedTeamsCreateOptionalParams	Optional parameters.
BetaRedTeamsGetOptionalParams	Optional parameters.
BetaRedTeamsListOptionalParams	Optional parameters.
BetaRedTeamsOperations	Interface representing a BetaRedTeams operations.
BetaRoutinesCreateOrUpdateOptionalParams	Optional parameters.
BetaRoutinesDeleteOptionalParams	Optional parameters.
BetaRoutinesDisableOptionalParams	Optional parameters.
BetaRoutinesDispatchOptionalParams	Optional parameters.
BetaRoutinesEnableOptionalParams	Optional parameters.
BetaRoutinesGetOptionalParams	Optional parameters.
BetaRoutinesListOptionalParams	Optional parameters.
BetaRoutinesListRunsOptionalParams	Optional parameters.
BetaRoutinesOperations	Interface representing a BetaRoutines operations.
BetaSchedulesCreateOrUpdateOptionalParams	Optional parameters.
BetaSchedulesDeleteOptionalParams	Optional parameters.
BetaSchedulesGetOptionalParams	Optional parameters.
BetaSchedulesGetRunOptionalParams	Optional parameters.
BetaSchedulesListOptionalParams	Optional parameters.
BetaSchedulesListRunsOptionalParams	Optional parameters.
BetaSchedulesOperations	Interface representing a BetaSchedules operations.
BetaSkillsCreateOptionalParams	Optional parameters.
BetaSkillsDeleteOptionalParams	Optional parameters.
BetaSkillsDownloadOptionalParams	Optional parameters.
BetaSkillsGetOptionalParams	Optional parameters.
BetaSkillsListOptionalParams	Optional parameters.
BetaSkillsOperations	Interface representing a BetaSkills operations.
BetaSkillsUpdateOptionalParams	Optional parameters.
BetaToolboxesDeleteOptionalParams	Optional parameters.
BetaToolboxesGetOptionalParams	Optional parameters.
BetaToolboxesListOptionalParams	Optional parameters.
BetaToolboxesOperations	Interface representing a BetaToolboxes operations.
BetaToolboxesUpdateOptionalParams	Optional parameters.
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.
BotServiceAuthorizationScheme	model interface BotServiceAuthorizationScheme
BotServiceRbacAuthorizationScheme	model interface BotServiceRbacAuthorizationScheme
BrowserAutomationPreviewTool	The input definition information for a Browser Automation Tool, as used to configure an Agent.
BrowserAutomationToolConnectionParameters	Definition of input parameters for the connection used by the Browser Automation Tool.
BrowserAutomationToolParameters	Definition of input parameters for the Browser Automation Tool.
CandidateDeployConfig	Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version.
CandidateFileInfo	File entry in a candidate's blob directory.
CandidateMetadata	Candidate metadata returned by GET /candidates/{id}.
CandidateResults	Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results.
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	A tool that runs Python code to help generate a response to a prompt.
ComparisonFilter	A filter used to compare a specified attribute key to a given value using a defined comparison operation.
CompoundFilter	Combine multiple filters using and or or.
ComputerTool	A tool that controls a virtual computer. Learn more about the computer tool.
ComputerUsePreviewTool	A tool that controls a virtual computer. Learn more about the computer tool.
Connection	Response from the list and get connections operations
ConnectionsGetOptionalParams	Optional parameters.
ConnectionsGetWithCredentialsOptionalParams	Optional parameters.
ConnectionsListOptionalParams	Optional parameters.
ConnectionsOperations	Interface representing a Connections operations.
ContainerAutoParam	model interface ContainerAutoParam
ContainerConfiguration	Container-based deployment configuration for a hosted agent.
ContainerNetworkPolicyAllowlistParam	model interface ContainerNetworkPolicyAllowlistParam
ContainerNetworkPolicyDisabledParam	model interface ContainerNetworkPolicyDisabledParam
ContainerNetworkPolicyDomainSecretParam	model interface ContainerNetworkPolicyDomainSecretParam
ContainerNetworkPolicyParam	Network access policy for the container.
ContainerSkill	model interface ContainerSkill
ContinuousEvaluationRuleAction	Evaluation rule action for continuous evaluation.
CosmosDBIndex	CosmosDB Vector Store Index Definition
CreateAgentVersionFromCodeContent	Multipart request body for updating or versioning a code-based agent (POST /agents/{name} and POST /agents/{name}/versions).
CreateAgentVersionFromCodeMetadata	JSON metadata for code-based agent operations (create, update, create version). The agent name comes from the URL path parameter or the x-ms-agent-name header, so it is not included in this model. The content hash (SHA-256 of the zip) is carried in the x-ms-code-zip-sha256 header.
CreateFromFilesOptionalParams	Optional parameters.
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.
CreateVersionOptionalParams	Optional parameters.
CronTrigger	Cron based trigger.
CustomCredential	Custom credential definition
CustomGrammarFormatParam	A grammar defined by the user.
CustomRoutineTrigger	A custom event routine trigger.
CustomTextFormatParam	Unconstrained free-form text.
CustomToolParam	A custom tool that processes input using a specified format. Learn more about custom tools
CustomToolParamFormat	The input format for the custom tool. Default is unconstrained text.
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.
DataGenerationJobOutput	Output information for a data generation job.
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.
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.
DatasetInfo	Metadata about the dataset used for optimization, surfaced in the response.
DatasetRef	Reference to a registered dataset in the Foundry Dataset Service.
DatasetReference	Reference to a versioned Foundry Dataset.
DatasetVersion	DatasetVersion Definition
DatasetsCreateOrUpdateOptionalParams	Optional parameters.
DatasetsDeleteOptionalParams	Optional parameters.
DatasetsGetCredentialsOptionalParams	Optional parameters.
DatasetsGetOptionalParams	Optional parameters.
DatasetsListOptionalParams	Optional parameters.
DatasetsListVersionsOptionalParams	Optional parameters.
DatasetsOperations	Interface representing a Datasets operations.
DatasetsPendingUploadOptionalParams	Optional parameters.
DeleteAgentResponse	A deleted agent Object
DeleteAgentVersionResponse	A deleted agent version Object
DeleteMemoryResponse	Response for deleting a memory item from a memory store.
DeleteMemoryStoreResponse	model interface DeleteMemoryStoreResponse
DeleteSkillResponse	A deleted skill.
DeleteSkillVersionResponse	A deleted skill version.
DeleteVersionOptionalParams	Optional parameters.
Deployment	Model Deployment Definition
DeploymentsGetOptionalParams	Optional parameters.
DeploymentsListOptionalParams	Optional parameters.
DeploymentsOperations	Interface representing a Deployments operations.
Dimension	A single dimension — one independent, measurable quality dimension within a rubric evaluator's scoring blueprint.
DispatchRoutineResponse	Identifiers returned after a routine dispatch is queued.
DownloadVersionOptionalParams	Optional parameters.
EmbeddingConfiguration	Embedding configuration class
EmptyModelParam	model interface EmptyModelParam
EntraAuthorizationScheme	model interface EntraAuthorizationScheme
EntraIDCredentials	Entra ID credential definition
EntraIsolationKeySource	model interface EntraIsolationKeySource
ErrorModel	model interface ErrorModel
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.
EvaluationRuleFilter	Evaluation filter model.
EvaluationRulesCreateOrUpdateOptionalParams	Optional parameters.
EvaluationRulesDeleteOptionalParams	Optional parameters.
EvaluationRulesGetOptionalParams	Optional parameters.
EvaluationRulesListOptionalParams	Optional parameters.
EvaluationRulesOperations	Interface representing a EvaluationRules operations.
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.
EvaluationTaxonomy	Evaluation Taxonomy Definition
EvaluationTaxonomyInput	Input configuration for the evaluation taxonomy.
EvaluatorCredentialRequest	Request body for getting evaluator credentials
EvaluatorDefinition	Base evaluator configuration with discriminator
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.
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.
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	A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
FixedRatioVersionSelectionRule	model interface FixedRatioVersionSelectionRule
FolderDatasetVersion	FileDatasetVersion Definition
FoundryModelWarning	A warning associated with a model.
FunctionShellToolParam	A tool that allows the model to execute shell commands.
FunctionShellToolParamEnvironment	model interface FunctionShellToolParamEnvironment
FunctionShellToolParamEnvironmentContainerReferenceParam	model interface FunctionShellToolParamEnvironmentContainerReferenceParam
FunctionShellToolParamEnvironmentLocalEnvironmentParam	model interface FunctionShellToolParamEnvironmentLocalEnvironmentParam
FunctionTool	Defines a function in your own code the model can choose to call. Learn more about function calling.
FunctionToolParam	model interface FunctionToolParam
GetVersionOptionalParams	Optional parameters.
GitHubIssueRoutineTrigger	A GitHub issue routine trigger.
HeaderIsolationKeySource	model interface HeaderIsolationKeySource
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	model interface HybridSearchOptions
ImageGenTool	A tool that generates images using the GPT image models.
ImageGenToolInputImageMask	model interface ImageGenToolInputImageMask
IndexesCreateOrUpdateOptionalParams	Optional parameters.
IndexesDeleteOptionalParams	Optional parameters.
IndexesGetOptionalParams	Optional parameters.
IndexesListOptionalParams	Optional parameters.
IndexesListVersionsOptionalParams	Optional parameters.
IndexesOperations	Interface representing a Indexes operations.
InlineSkillParam	model interface InlineSkillParam
InlineSkillSourceParam	Inline skill payload
Insight	The response body for cluster insights.
InsightCluster	A cluster of analysis samples.
InsightGenerationRequest	The request body for generating an insight.
InsightModelConfiguration	Configuration of the model used in the insight generation.
InsightRequest	The request of the insights report.
InsightResult	The result of the insights.
InsightSample	A sample from the analysis.
InsightScheduleTask	Insight task for the schedule.
InsightSummary	Summary of the error cluster analysis.
InsightsMetadata	Metadata about the insights.
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.
IsolationKeySource	model interface IsolationKeySource
ListVersionsOptionalParams	Optional parameters.
LocalShellToolParam	A tool that allows the model to execute shell commands in a local environment.
LocalSkillParam	model interface LocalSkillParam
LoraConfig	Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time.
MCPTool	Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.
MCPToolFilter	A filter object to specify which tools are allowed.
MCPToolRequireApproval	model interface MCPToolRequireApproval
ManagedAgentIdentityBlueprintReference	model interface ManagedAgentIdentityBlueprintReference
ManagedAzureAISearchIndex	Managed Azure AI Search Index Definition
MemoryItem	A single memory item stored in the memory store, containing content and metadata.
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.
MemoryStore	A memory store that can store and retrieve user memories.
MemoryStoreDefaultDefinition	Default memory store implementation.
MemoryStoreDefaultOptions	Default memory store configurations.
MemoryStoreDefinition	Base definition for memory store configurations.
MemoryStoreDeleteScopeResponse	Response for deleting memories from a scope.
MemoryStoreOperationUsage	Usage statistics of a memory store operation.
MemoryStoreSearchResponse	Memory search response.
MemoryStoreUpdateCompletedResult	Memory update result.
MemoryStoreUpdateResponse	Provides the status of a memory store update operation.
MicrosoftFabricPreviewTool	The input definition information for a Microsoft Fabric tool as used to configure an agent.
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.
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	Groups function/custom tools under a shared namespace.
NoAuthenticationCredentials	Credentials that do not require authentication
OneTimeTrigger	One-time trigger.
OpenAIClientOptionsWithAzureAgent	Extended OpenAI client options to include Azure Agent endpoint configuration.
OpenApiAnonymousAuthDetails	Security details for OpenApi anonymous authentication
OpenApiAuthDetails	authentication details for OpenApiFunctionDefinition
OpenApiFunctionDefinition	The input definition information for an openapi function.
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.
OptimizationAgentDefinition	Agent definition returned in response payloads (includes resolved config).
OptimizationCandidate	Aggregated evaluation result for a single candidate agent configuration across all tasks.
OptimizationJob	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.
OptimizationJobInputs	Caller-supplied inputs for an optimization job.
OptimizationJobProgress	In-flight progress; only populated while status is queued or in_progress.
OptimizationJobResult	Terminal-state result body. Populated when status is succeeded or failed.
OptimizationOptions	Tuning knobs and run-mode for an optimization job.
OptimizationTaskResult	Per-task evaluation result for a single candidate.
OtlpTelemetryEndpoint	An OTLP (OpenTelemetry Protocol) telemetry export endpoint.
PageSettings	An interface that tracks the settings for paged iteration
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PendingUploadRequest	Represents a request for a pending upload.
PendingUploadResponse	Represents the response for a pending upload request
ProceduralMemoryItem	A memory item containing a procedure extracted from conversations.
PromoteCandidateRequest	Request body for promoting a candidate to a Foundry agent version.
PromoteCandidateResponse	Response after successfully promoting a candidate.
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.
ProtocolVersionRecord	A record mapping for a single protocol and its version.
RaiConfig	Configuration for Responsible AI (RAI) content filtering and safety features.
RankingOptions	model interface RankingOptions
Reasoning	gpt-5 and o-series models only Configuration options for reasoning models.
RecurrenceSchedule	Recurrence schedule model.
RecurrenceTrigger	Recurrence based trigger.
RedTeam	Red team details.
RedTeamTargetConfig	Abstract class for target configuration.
ResponseUsageInputTokensDetails	model interface ResponseUsageInputTokensDetails
ResponseUsageOutputTokensDetails	model interface ResponseUsageOutputTokensDetails
Routine	A routine definition returned by the service.
RoutineAction	Base model for a routine action.
RoutineDispatchPayload	Base model for a manual dispatch payload.
RoutineRun	A single routine run returned from the run history API.
RoutineTrigger	Base model for a routine trigger.
RubricBasedEvaluatorDefinition	Rubric-based evaluator definition — stores dimensions produced by the generate API. Used for both quality and safety evaluators.
SASTokenCredentials	Shared Access Signature (SAS) credential definition
SasCredential	SAS Credential definition
Schedule	Schedule model.
ScheduleRoutineTrigger	A recurring cron-based routine trigger.
ScheduleRun	Schedule run model.
ScheduleTask	Schedule task model.
SessionDirectoryEntry	A single entry in a directory listing.
SessionDirectoryListResponse	Response from listing a directory in a session sandbox.
SessionFileWriteResponse	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.
SimpleQnADataGenerationJobOptions	The options for a data generation job with SimpleQnA type.
Skill	A skill resource.
SkillInlineContent	Inline content for defining a simple skill without uploading files. Follows the agentskills.io SKILL.md specification.
SkillReferenceParam	model interface SkillReferenceParam
SkillVersion	A specific version of a skill.
SpecificApplyPatchParam	Forces the model to call the apply_patch tool when executing a tool call.
SpecificFunctionShellParam	Forces the model to call the shell tool when a tool call is required.
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.
SystemDataV3	System metadata for a resource
TaxonomyCategory	Taxonomy category definition.
TaxonomySubCategory	Taxonomy sub-category definition.
TelemetryConfig	Customer-supplied telemetry configuration for exporting container logs, traces, and metrics.
TelemetryEndpoint	A telemetry export endpoint configuration.
TelemetryEndpointAuth	Authentication configuration for a telemetry endpoint.
TelemetryOperations	Interface representing telemetry operations
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.
TextResponseFormatConfiguration
TextResponseFormatConfigurationResponseFormatJsonObject
TextResponseFormatConfigurationResponseFormatText
TextResponseFormatJsonObject	JSON object response format. An older method of generating JSON responses. Using json_schema is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.
TextResponseFormatJsonSchema	JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.
TextResponseFormatText	Default response format. Used to generate text responses.
TimerRoutineTrigger	A one-shot timer routine trigger.
Tool	A tool that can be used to generate a response.
ToolChoiceAllowed	Constrains the tools available to the model to a pre-defined set.
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	Use this option to force the model to call a specific custom tool.
ToolChoiceFileSearch	Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
ToolChoiceFunction	Use this option to force the model to call a specific function.
ToolChoiceImageGeneration	Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
ToolChoiceMCP	Use this option to force the model to call a specific tool on a remote MCP server.
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.
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.
ToolProjectConnection	A project connection resource.
ToolSearchToolParam	Hosted or BYOT tool search configuration for deferred tools.
ToolUseFineTuningDataGenerationJobOptions	The options for a data generation job with ToolUse type. Used only for fine-tuning scenarios.
ToolboxDeleteVersionOptionalParams	Optional parameters.
ToolboxGetVersionOptionalParams	Optional parameters.
ToolboxListVersionsOptionalParams	Optional parameters.
ToolboxObject	A toolbox that stores reusable tool definitions for agents.
ToolboxPolicies	Policy configuration for a toolbox, including content safety and other governance settings.
ToolboxSearchPreviewTool	A tool for searching over the agent's toolbox. When present, deferred tools are hidden from tools/list and only discoverable via search_tools queries at runtime.
ToolboxSkill	A skill source included in a toolbox.
ToolboxSkillReference	A reference to an existing skill to include in a toolbox.
ToolboxVersionObject	A specific version of 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.
Trigger	Base model for Trigger of the schedule.
UpdateModelVersionRequest	Request body for updating a model version. Only description and tags can be modified.
UpdateToolboxRequest	model interface 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.
VersionRefIndicator	Version indicator that references a specific agent version by name.
VersionSelectionRule	model interface VersionSelectionRule
VersionSelector	model interface VersionSelector
WebSearchApproximateLocation	The approximate location of the user.
WebSearchConfiguration	A web search configuration for bing custom search
WebSearchPreviewTool	This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
WebSearchTool	Search the Internet for sources related to the prompt. Learn more about the web search tool.
WebSearchToolFilters	model interface WebSearchToolFilters
WeeklyRecurrenceSchedule	Weekly recurrence schedule.
WorkIQPreviewTool	A WorkIQ server-side tool.
WorkflowAgentDefinition	The workflow agent definition.

Type Aliases

AgentBlueprintReferenceType	Type of AgentBlueprintReferenceType
AgentBlueprintReferenceUnion	Alias for AgentBlueprintReferenceUnion
AgentDefinitionOptInKeys	Feature opt-in keys for agent definition operations supporting hosted or workflow agents.
AgentDefinitionUnion	Union type for all agent definition types. Supports workflow, hosted, container app, prompt and external agents.
AgentEndpoint
AgentEndpointAuthorizationSchemeType	Type of AgentEndpointAuthorizationSchemeType
AgentEndpointAuthorizationSchemeUnion	Alias for AgentEndpointAuthorizationSchemeUnion
AgentEndpointProtocol	Type of AgentEndpointProtocol
AgentKind	Defines the type/kind of agent. Determines which agent definition structure is used.
AgentProtocol	Type of AgentProtocol
AgentSessionStatus	The status of an agent session.
AgentType	Type of AgentType
AgentVersionStatus	The provisioning status of an agent version.
AttackStrategy	Strategies for attacks.
AzureAISearchQueryType	Available query types for Azure AI Search tool.
BaseCredentialsUnion	Alias for BaseCredentialsUnion
BetaAgentsDownloadAgentCodeResponse
BetaAgentsDownloadSessionFileResponse
BetaAgentsGetCandidateFileResponse
BetaSkillsDownloadResponse
CodeDependencyResolution	How package dependencies are resolved at deployment time for a code-based hosted agent.
ComparisonFilterValueItems	Alias for ComparisonFilterValueItems
ComputerEnvironment	Type of ComputerEnvironment
ConnectionType	The Type (or category) of the connection
ContainerMemoryLimit	Type of ContainerMemoryLimit
ContainerNetworkPolicyParamType	Type of ContainerNetworkPolicyParamType
ContainerNetworkPolicyParamUnion	Alias for ContainerNetworkPolicyParamUnion
ContainerSkillType	Type of ContainerSkillType
ContainerSkillUnion	Alias for ContainerSkillUnion
ContinuablePage	An interface that describes a page of results.
CredentialType	The credential type used by the connection
CustomToolParamFormatType	Type of CustomToolParamFormatType
CustomToolParamFormatUnion	Alias for CustomToolParamFormatUnion
DataGenerationJobOptionsUnion	Alias for DataGenerationJobOptionsUnion
DataGenerationJobOutputType	The supported output file types for a data generation job.
DataGenerationJobOutputUnion	Alias for DataGenerationJobOutputUnion
DataGenerationJobScenario	The supported scenarios for a data generation job.
DataGenerationJobSourceType	The supported source types for data generation jobs.
DataGenerationJobSourceUnion	Alias for DataGenerationJobSourceUnion
DataGenerationJobType	The supported data generation job types.
DatasetType	Enum to determine the type of data.
DatasetVersionUnion	Alias for DatasetVersionUnion
DayOfWeek	Days of the week for recurrence schedule.
DeploymentType	Type of DeploymentType
DeploymentUnion	Alias for DeploymentUnion
DownloadVersionResponse
EvaluationLevel	The level at which evaluation is performed.
EvaluationRuleActionType	Type of the evaluation action.
EvaluationRuleActionUnion	Alias for EvaluationRuleActionUnion
EvaluationRuleEventType	Type of the evaluation rule event.
EvaluationTargetUnion	Alias for EvaluationTargetUnion
EvaluationTaxonomyInputType	Type of the evaluation taxonomy input.
EvaluationTaxonomyInputUnion	Alias for EvaluationTaxonomyInputUnion
EvaluatorCategory	The category of the evaluator
EvaluatorDefinitionType	The type of evaluator definition
EvaluatorDefinitionUnion	Alias for EvaluatorDefinitionUnion
EvaluatorGenerationJobSourceType	The supported source types for evaluator generation jobs.
EvaluatorGenerationJobSourceUnion	Alias for EvaluatorGenerationJobSourceUnion
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
FileContents	Valid values for the contents of a binary file.
Filters	Alias for Filters
FoundryFeaturesOptInKeys	Type of FoundryFeaturesOptInKeys
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
FunctionShellToolParamEnvironmentUnion	Alias for FunctionShellToolParamEnvironmentUnion
GitHubIssueEvent	Known GitHub issue events that can fire a routine.
GrammarSyntax	Type of GrammarSyntax
ImageGenAction	Type of ImageGenAction
IndexType	Type of IndexType
IndexUnion	Alias for IndexUnion
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.
InsightRequestUnion	Alias for InsightRequestUnion
InsightResultUnion	Alias for InsightResultUnion
InsightSampleUnion	Alias for InsightSampleUnion
InsightType	The request of the insights.
IsolationKeySourceKind	Type of IsolationKeySourceKind
IsolationKeySourceUnion	Alias for IsolationKeySourceUnion
JobStatus	Extensible status values shared by Foundry jobs.
MemoryItemKind	Memory item kind.
MemoryItemUnion	Alias for MemoryItemUnion
MemoryOperationKind	Memory operation kind.
MemoryStoreDefinitionUnion	Alias for MemoryStoreDefinitionUnion
MemoryStoreKind	The type of memory store implementation to use.
MemoryStoreType	Type of MemoryStoreType
MemoryStoreUpdateStatus	Status of a memory store update operation.
OpenApiAuthDetailsUnion	Alias for OpenApiAuthDetailsUnion
OpenApiAuthType	Authentication type for OpenApi endpoint. Allowed types are: Anonymous (no authentication required) Project Connection (requires project_connection_id to endpoint, as setup in AI Foundry) Managed_Identity (requires audience for identity based auth)
OperationState	Enum describing allowed operation states.
PageOrder	Type of PageOrder
PendingUploadType	The type of pending upload.
RankerVersionType	Type of RankerVersionType
ReasoningEffort	Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. gpt-5.1 defaults to none, which does not perform reasoning. The supported reasoning values for gpt-5.1 are none, low, medium, and high. Tool calls are supported for all reasoning values in gpt-5.1. All models before gpt-5.1 default to medium reasoning effort, and do not support none. The gpt-5-pro model defaults to (and only supports) high reasoning effort. xhigh is supported for all models after gpt-5.1-codex-max.
RecurrenceScheduleUnion	Alias for RecurrenceScheduleUnion
RecurrenceType	Recurrence type.
RedTeamTargetConfigUnion	Alias for RedTeamTargetConfigUnion
RiskCategory	Risk category for the attack objective.
RoutineActionType	The discriminator values supported for routine actions.
RoutineActionUnion	Alias for RoutineActionUnion
RoutineAttemptSource	Known source paths that can produce a routine run.
RoutineDispatchPayloadType	The discriminator values supported for manual routine dispatch payloads.
RoutineDispatchPayloadUnion	Alias for RoutineDispatchPayloadUnion
RoutineRunPhase	Known lifecycle phases recorded for a routine run.
RoutineTriggerType	The discriminator values supported for routine triggers.
RoutineTriggerUnion	Alias for RoutineTriggerUnion
SampleType	The type of sample used in the analysis.
ScheduleProvisioningStatus	Schedule provisioning status.
ScheduleTaskType	Type of the task.
ScheduleTaskUnion	Alias for ScheduleTaskUnion
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.
TelemetryEndpointAuthUnion	Alias for TelemetryEndpointAuthUnion
TelemetryEndpointKind	The kind of telemetry export endpoint.
TelemetryEndpointUnion	Alias for TelemetryEndpointUnion
TelemetryTransportProtocol	The transport protocol for telemetry export.
TextResponseFormatConfigurationType	Type of TextResponseFormatConfigurationType
TextResponseFormatConfigurationUnion
TextResponseFormatUnion	Alias for TextResponseFormatUnion
ToolChoiceParamType	Type of ToolChoiceParamType
ToolChoiceParamUnion	Alias for ToolChoiceParamUnion
ToolSearchExecutionType	Type of ToolSearchExecutionType
ToolType	Type of ToolType
ToolUnion	Alias for ToolUnion
ToolboxSkillUnion	Alias for ToolboxSkillUnion
TreatmentEffectType	Treatment Effect Type.
TriggerType	Type of the trigger.
TriggerUnion	Alias for TriggerUnion
VersionIndicatorType	The type of version indicator used to determine the agent version backing a session.
VersionIndicatorUnion	Alias for VersionIndicatorUnion
VersionSelectionRuleUnion	Alias for VersionSelectionRuleUnion
VersionSelectorType	Type of VersionSelectorType

Enums

KnownApiVersions

Microsoft Foundry API versions

Variables

RestError

A custom error type for failed pipeline requests.

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor