@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
AgentClusterInsightRequest	Insights on set of Agent Evaluation Results
AgentClusterInsightResult	Insights from the agent cluster analysis.
AgentDefinition	Base definition interface for agents. Contains the agent kind and optional RAI configuration.
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.
AgentsUpdateAgentFromManifestOptionalParams	Optional parameters.
AgentsUpdateOptionalParams	Optional parameters.
Annotation	An annotation that applies to a span of output text.
ApiErrorResponse	Error response for API failures.
ApiKeyCredentials	API Key Credential definition
ApplyPatchCreateFileOperationParam	Instruction for creating a new file via the apply_patch tool.
ApplyPatchDeleteFileOperationParam	Instruction for deleting an existing file via the apply_patch tool.
ApplyPatchOperationParam	One of the create_file, delete_file, or update_file operations supplied to the apply_patch tool.
ApplyPatchToolParam	Allows the assistant to create, delete, or update files using unified diffs.
ApplyPatchUpdateFileOperationParam	Instruction for updating an existing file via the apply_patch tool.
ApproximateLocation	model interface ApproximateLocation
AzureAIAgentTarget	Represents a target specifying an Azure AI agent.
AzureAIModelTarget	Represents a target specifying an Azure AI model for operations requiring model selection.
AzureAISearchIndex	Azure AI Search Index Definition
AzureAISearchTool	The input definition information for an Azure AI search tool as used to configure an agent.
AzureAISearchToolResource	A set of index resources used by the azure_ai_search tool.
AzureFunctionBinding	The structure for keeping storage queue name and URI.
AzureFunctionDefinition	The definition of Azure function.
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
BetaEvaluationTaxonomiesCreateOptionalParams	Optional parameters.
BetaEvaluationTaxonomiesDeleteOptionalParams	Optional parameters.
BetaEvaluationTaxonomiesGetOptionalParams	Optional parameters.
BetaEvaluationTaxonomiesListOptionalParams	Optional parameters.
BetaEvaluationTaxonomiesOperations	Interface representing a BetaEvaluationTaxonomies operations.
BetaEvaluationTaxonomiesUpdateOptionalParams	Optional parameters.
BetaEvaluatorsCreateVersionOptionalParams	Optional parameters.
BetaEvaluatorsDeleteVersionOptionalParams	Optional parameters.
BetaEvaluatorsGetVersionOptionalParams	Optional parameters.
BetaEvaluatorsListLatestVersionsOptionalParams	Optional parameters.
BetaEvaluatorsListVersionsOptionalParams	Optional parameters.
BetaEvaluatorsOperations	Interface representing a BetaEvaluators operations.
BetaEvaluatorsUpdateVersionOptionalParams	Optional parameters.
BetaInsightsGenerateOptionalParams	Optional parameters.
BetaInsightsGetOptionalParams	Optional parameters.
BetaInsightsListOptionalParams	Optional parameters.
BetaInsightsOperations	Interface representing a BetaInsights operations.
BetaMemoryStoresCreateOptionalParams	Optional parameters.
BetaMemoryStoresDeleteOptionalParams	Optional parameters.
BetaMemoryStoresDeleteScopeOptionalParams	Optional parameters.
BetaMemoryStoresGetOptionalParams	Optional parameters.
BetaMemoryStoresGetUpdateResultOptionalParams	Optional parameters.
BetaMemoryStoresListOptionalParams	Optional parameters.
BetaMemoryStoresOperations	Interface representing a BetaMemoryStores operations.
BetaMemoryStoresSearchMemoriesOptionalParams	Optional parameters.
BetaMemoryStoresUpdateMemoriesOptionalParams	Optional parameters.
BetaMemoryStoresUpdateOptionalParams	Optional parameters.
BetaOperations	Interface representing a Beta operations.
BetaRedTeamsCreateOptionalParams	Optional parameters.
BetaRedTeamsGetOptionalParams	Optional parameters.
BetaRedTeamsListOptionalParams	Optional parameters.
BetaRedTeamsOperations	Interface representing a BetaRedTeams 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.
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.
BrowserAutomationPreviewTool	The input definition information for a Browser Automation Tool, as used to configure an Agent.
BrowserAutomationToolConnectionParameters	Definition of input parameters for the connection used by the Browser Automation Tool.
BrowserAutomationToolParameters	Definition of input parameters for the Browser Automation Tool.
CaptureStructuredOutputsTool	A tool for capturing structured outputs
ChartCoordinate	Coordinates for the analysis chart.
ChatSummaryMemoryItem	A memory item containing a summary extracted from conversations.
ClickParam	A click action.
ClusterInsightResult	Insights from the cluster analysis.
ClusterTokenUsage	Token usage for cluster analysis
CodeBasedEvaluatorDefinition	Code-based evaluator definition using python code
CodeInterpreterContainerAuto	Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
CodeInterpreterOutputImage	The image output from the code interpreter.
CodeInterpreterOutputLogs	The logs output from the code interpreter.
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.
ComputerAction	model interface ComputerAction
ComputerCallSafetyCheckParam	A pending safety check for the computer call.
ComputerScreenshotImage	A computer screenshot image used with the computer use 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.
ContainerAppAgentDefinition	The container app agent definition.
ContainerFileCitationBody	A citation for a container file used to generate a model response.
ContinuousEvaluationRuleAction	Evaluation rule action for continuous evaluation.
CosmosDBIndex	CosmosDB Vector Store Index Definition
CronTrigger	Cron based trigger.
CustomCredential	Custom credential definition
CustomGrammarFormatParam	A grammar defined by the user.
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.
DatasetCredential	Represents a reference to a blob for consumption
DatasetUploadOptions	Options for uploading datasets
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
DeleteMemoryStoreResponse	model interface DeleteMemoryStoreResponse
Deployment	Model Deployment Definition
DeploymentsGetOptionalParams	Optional parameters.
DeploymentsListOptionalParams	Optional parameters.
DeploymentsOperations	Interface representing a Deployments operations.
DoubleClickAction	A double click action.
Drag	A drag action.
DragPoint	An x/y coordinate pair, e.g. { x: 100, y: 200 }.
EasyInputMessage	A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role. Messages with the assistant role are presumed to have been generated by the model in previous interactions.
EmbeddingConfiguration	Embedding configuration class
EntraIDCredentials	Entra ID credential definition
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.
EvaluationTaxonomy	Evaluation Taxonomy Definition
EvaluationTaxonomyInput	Input configuration for the evaluation taxonomy.
EvaluatorDefinition	Base evaluator configuration with discriminator
EvaluatorMetric	Evaluator Metric
EvaluatorVersion	Evaluator Definition
FabricDataAgentToolParameters	The fabric data agent tool parameters.
FieldMapping	Field mapping configuration class
FileCitationBody	A citation to a file.
FileDatasetVersion	FileDatasetVersion Definition
FilePath	A path to a file.
FileSearchTool	A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
FileSearchToolCallResults	model interface FileSearchToolCallResults
FolderDatasetVersion	FileDatasetVersion Definition
FunctionAndCustomToolCallOutput	model interface FunctionAndCustomToolCallOutput
FunctionAndCustomToolCallOutputInputFileContent	A file input to the model.
FunctionAndCustomToolCallOutputInputImageContent	An image input to the model. Learn about image inputs.
FunctionAndCustomToolCallOutputInputTextContent	A text input to the model.
FunctionShellActionParam	Commands and limits describing how to run the shell tool call.
FunctionShellCallOutputContentParam	Captured stdout and stderr for a portion of a shell tool call output.
FunctionShellCallOutputExitOutcomeParam	Indicates that the shell commands finished and returned an exit code.
FunctionShellCallOutputOutcomeParam	The exit or timeout outcome associated with this shell call.
FunctionShellCallOutputTimeoutOutcomeParam	Indicates that the shell call exceeded its configured time limit.
FunctionShellToolParam	A tool that allows the model to execute shell commands.
FunctionTool	Defines a function in your own code the model can choose to call. Learn more about function calling.
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.
InputContent	model interface InputContent
InputContentInputFileContent	A file input to the model.
InputContentInputImageContent	An image input to the model. Learn about image inputs.
InputContentInputTextContent	A text input to the model.
InputFileContentParam	A file input to the model.
InputImageContentParamAutoParam	An image input to the model. Learn about image inputs
InputItem	An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assistant responses and tool call outputs.
InputItemApplyPatchToolCallItemParam	A tool call representing a request to create, delete, or update files using diff patches.
InputItemApplyPatchToolCallOutputItemParam	The streamed output emitted by an apply patch tool call.
InputItemCodeInterpreterToolCall	A tool call to run code.
InputItemCompactionSummaryItemParam	A compaction item generated by the v1/responses/compact API.
InputItemComputerCallOutputItemParam	The output of a computer tool call.
InputItemComputerToolCall	A tool call to a computer use tool. See the computer use guide for more information.
InputItemCustomToolCall	A call to a custom tool created by the model.
InputItemCustomToolCallOutput	The output of a custom tool call from your code, being sent back to the model.
InputItemFileSearchToolCall	The results of a file search tool call. See the file search guide for more information.
InputItemFunctionCallOutputItemParam	The output of a function tool call.
InputItemFunctionShellCallItemParam	A tool representing a request to execute one or more shell commands.
InputItemFunctionShellCallOutputItemParam	The streamed output items emitted by a shell tool call.
InputItemFunctionToolCall	A tool call to run a function. See the function calling guide for more information.
InputItemImageGenToolCall	An image generation request made by the model.
InputItemLocalShellToolCall	A tool call to run a command on the local shell.
InputItemLocalShellToolCallOutput	The output of a local shell tool call.
InputItemMcpApprovalRequest	A request for human approval of a tool invocation.
InputItemMcpApprovalResponse	A response to an MCP approval request.
InputItemMcpListTools	A list of tools available on an MCP server.
InputItemMcpToolCall	An invocation of a tool on an MCP server.
InputItemOutputMessage	An output message from the model.
InputItemReasoningItem	A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.
InputItemWebSearchToolCall	The results of a web search tool call. See the web search guide for more information.
InputTextContentParam	A text input to the model.
Insight	The response body for cluster insights.
InsightCluster	A cluster of analysis samples.
InsightModelConfiguration	Configuration of the model used in the insight generation.
InsightRequest	The request of the insights report.
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.
ItemReferenceParam	An internal identifier for an item to reference.
KeyPressAction	A collection of keypresses the model would like to perform.
LocalShellExecAction	Execute a shell command on the server.
LocalShellToolParam	A tool that allows the model to execute shell commands in a local environment.
LogProb	The log probability of a token.
MCPListToolsTool	A tool available on an MCP server.
MCPListToolsToolAnnotations	model interface MCPListToolsToolAnnotations
MCPListToolsToolInputSchema	model interface MCPListToolsToolInputSchema
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
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.
ModelDeployment	Model Deployment Definition
ModelDeploymentSku	Sku information
ModelSamplingParams	Represents a set of parameters used to control the sampling behavior of a language model during text generation.
MonthlyRecurrenceSchedule	Monthly recurrence schedule.
Move	A mouse move action.
NoAuthenticationCredentials	Credentials that do not require authentication
OneTimeTrigger	One-time trigger.
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.
OutputMessageContent	model interface OutputMessageContent
OutputMessageContentOutputTextContent	A text output from the model.
OutputMessageContentRefusalContent	A refusal from the model.
PageSettings	Options for the byPage method
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
PromptAgentDefinition	The prompt agent definition
PromptAgentDefinitionTextOptions	Configuration options for a text response from the model. Can be plain text or structured JSON data.
PromptBasedEvaluatorDefinition	Prompt-based evaluator
ProtocolVersionRecord	A record mapping for a single protocol and its version.
RaiConfig	Configuration for Responsible AI (RAI) content filtering and safety features.
RankingOptions	model interface RankingOptions
Reasoning	gpt-5 and o-series models only Configuration options for reasoning models.
ReasoningTextContent	Reasoning text from the model.
RecurrenceSchedule	Recurrence schedule model.
RecurrenceTrigger	Recurrence based trigger.
RedTeam	Red team details.
ResponseUsageInputTokensDetails	model interface ResponseUsageInputTokensDetails
ResponseUsageOutputTokensDetails	model interface ResponseUsageOutputTokensDetails
RestorePollerOptions
SASTokenCredentials	Shared Access Signature (SAS) credential definition
SasCredential	SAS Credential definition
Schedule	Schedule model.
ScheduleRun	Schedule run model.
ScheduleTask	Schedule task model.
Screenshot	A screenshot action.
Scroll	A scroll action.
SharepointGroundingToolParameters	The sharepoint grounding tool parameters.
SharepointPreviewTool	The input definition information for a sharepoint tool as used to configure an agent.
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.
Summary	A summary text from the model.
Target	Base class for targets with discriminator support.
TargetConfig	Abstract class for target configuration.
TaxonomyCategory	Taxonomy category definition.
TaxonomySubCategory	Taxonomy sub-category definition.
TelemetryOperations	Interface representing telemetry operations
TextResponseFormatConfiguration	An object specifying the format that the model must output. Configuring { "type": "json_schema" } enables Structured Outputs, which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide. The default format is { "type": "text" } with no additional options. Not recommended for gpt-4o and newer models:* Setting to { "type": "json_object" } enables the older JSON mode, which ensures the message the model generates is valid JSON. Using json_schema is preferred for models that support it.
TextResponseFormatConfigurationResponseFormatJsonObject	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.
TextResponseFormatConfigurationResponseFormatText	Default response format. Used to generate text responses.
TextResponseFormatJsonSchema	JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.
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.
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.
ToolDescription	Description of a tool that can be used by an agent.
ToolProjectConnection	A project connection resource.
TopLogProb	The top log probability of a token.
Trigger	Base model for Trigger of the schedule.
Type	An action to type in text.
UrlCitationBody	A citation for a web resource used to generate a model response.
UserProfileMemoryItem	A memory item specifically containing user profile information extracted from conversations, such as preferences, interests, and personal details.
VectorStoreFileAttributes	Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.
Wait	A wait action.
WebSearchActionFind	Action type "find": Searches for a pattern within a loaded page.
WebSearchActionOpenPage	Action type "open_page" - Opens a specific URL from search results.
WebSearchActionSearch	Action type "search" - Performs a web search query.
WebSearchActionSearchSources	model interface WebSearchActionSearchSources
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.
WorkflowAgentDefinition	The workflow agent definition.

Type Aliases

AgentDefinitionUnion	Union type for all agent definition types. Supports workflow, hosted, container app, and prompt agents.
AgentKind	Defines the type/kind of agent. Determines which agent definition structure is used.
AgentProtocol	Type of AgentProtocol
AgentType	Type of AgentType
AnnotationType	Type of AnnotationType
AnnotationUnion	Alias for AnnotationUnion
ApplyPatchCallOutputStatusParam	Outcome values reported for apply_patch tool call outputs.
ApplyPatchCallStatusParam	Status values reported for apply_patch tool calls.
ApplyPatchOperationParamType	Type of ApplyPatchOperationParamType
ApplyPatchOperationParamUnion	Alias for ApplyPatchOperationParamUnion
AttackStrategy	Strategies for attacks.
AzureAISearchQueryType	Available query types for Azure AI Search tool.
BaseCredentialsUnion	Alias for BaseCredentialsUnion
ClickButtonType	Type of ClickButtonType
ComparisonFilterValueItems	Alias for ComparisonFilterValueItems
ComputerActionType	Type of ComputerActionType
ComputerActionUnion	Alias for ComputerActionUnion
ComputerEnvironment	Type of ComputerEnvironment
ConnectionType	The Type (or category) of the connection
ContainerMemoryLimit	Type of ContainerMemoryLimit
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
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
DetailEnum	Type of DetailEnum
EvaluationRuleActionType	Type of the evaluation action.
EvaluationRuleActionUnion	Alias for EvaluationRuleActionUnion
EvaluationRuleEventType	Type of the evaluation rule event.
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
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
Filters	Alias for Filters
FoundryFeaturesOptInKeys	Type of FoundryFeaturesOptInKeys
FunctionAndCustomToolCallOutputType	Type of FunctionAndCustomToolCallOutputType
FunctionAndCustomToolCallOutputUnion	Alias for FunctionAndCustomToolCallOutputUnion
FunctionCallItemStatus	Type of FunctionCallItemStatus
FunctionShellCallItemStatus	Status values reported for shell tool calls.
FunctionShellCallOutputOutcomeParamType	Type of FunctionShellCallOutputOutcomeParamType
FunctionShellCallOutputOutcomeParamUnion	Alias for FunctionShellCallOutputOutcomeParamUnion
GrammarSyntax1	Type of GrammarSyntax1
ImageDetail	Type of ImageDetail
IndexType	Type of IndexType
IndexUnion	Alias for IndexUnion
InputContentType	Type of InputContentType
InputContentUnion	Alias for InputContentUnion
InputFidelity	Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1. Unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.
InputItemType	Type of InputItemType
InputItemUnion	Alias for InputItemUnion
InsightRequestUnion	Alias for InsightRequestUnion
InsightResultUnion	Alias for InsightResultUnion
InsightSampleUnion	Alias for InsightSampleUnion
InsightType	The request of the insights.
MCPToolCallStatus	Type of MCPToolCallStatus
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.
OutputMessageContentType	Type of OutputMessageContentType
OutputMessageContentUnion	Alias for OutputMessageContentUnion
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.
RiskCategory	Risk category for the attack objective.
SampleType	The type of sample used in the analysis.
ScheduleProvisioningStatus	Schedule provisioning status.
ScheduleTaskType	Type of the task.
ScheduleTaskUnion	Alias for ScheduleTaskUnion
SearchContextSize	Type of SearchContextSize
TargetConfigUnion	Alias for TargetConfigUnion
TargetUnion	Alias for TargetUnion
TextResponseFormatConfigurationType	Type of TextResponseFormatConfigurationType
TextResponseFormatConfigurationUnion	Alias for TextResponseFormatConfigurationUnion
ToolChoiceParamType	Type of ToolChoiceParamType
ToolChoiceParamUnion	Alias for ToolChoiceParamUnion
ToolType	Type of ToolType
ToolUnion	Alias for ToolUnion
TreatmentEffectType	Treatment Effect Type.
TriggerType	Type of the trigger.
TriggerUnion	Alias for TriggerUnion

Enums

KnownApiVersions

Microsoft Foundry API versions

Functions

restorePoller<TResponse, TResult>(AIProjectClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(AIProjectClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: AIProjectClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

AIProjectClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>