你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/ai-projects package

AIProjectClient

获得带有可选OpenAI客户端选项的OpenAI客户端

接口

@azure/ai-projects.Index
A2APreviewTool

实现 A2A 协议的代理。

A2APreviewToolboxTool

一个存放在工具箱里的A2A工具。

A2AProtocolConfiguration

针对A2A协议的具体配置。

AIProjectClientOptionalParams

客户端的可选参数。

AISearchIndexResource

AI 搜索索引资源。

ActivityProtocolConfiguration

针对活动协议的配置。

Agent

模型接口代理

AgentBlueprintReference

模型接口 AgentBlueprintReference

AgentCard

模型接口代理卡

AgentCardSkill

model interface AgentCardSkill

AgentClusterInsightRequest

对代理评估结果集的见解

AgentClusterInsightResult

来自代理集群分析的见解。

AgentDataGenerationJobSource

数据生成作业的代理源——引用代理以获取指令和元数据。

AgentDefinition

代理的基本定义接口。 包含代理类型和可选的 RAI 配置。

AgentEndpointAuthorizationScheme

模型接口 AgentEndpointAuthorizationScheme

AgentEndpointConfig

model interface AgentEndpointConfig

AgentEvaluatorGenerationJobSource

评估器生成作业的代理源——引用代理以获取指令和元数据。

AgentIdentity

模型接口 AgentIdentity

AgentSessionResource

一个为托管代理调用提供长期计算沙盒的代理会话。

AgentTaxonomyInput

当输入类型为代理时,评估分类的输入配置。

AgentVersion

表示代理的特定版本。 包括元数据、版本控制、创建时间和代理定义。

AgenticIdentityPreviewCredentials

代理身份凭证定义

AgentsCreateAgentFromManifestOptionalParams

可选参数。

AgentsCreateAgentVersionFromManifestOptionalParams

可选参数。

AgentsCreateOptionalParams

可选参数。

AgentsCreateSessionOptionalParams

可选参数。

AgentsCreateVersionFromCodeOptionalParams

可选参数。

AgentsCreateVersionOptionalParams

可选参数。

AgentsDeleteOptionalParams

可选参数。

AgentsDeleteSessionFileOptionalParams

可选参数。

AgentsDeleteSessionOptionalParams

可选参数。

AgentsDeleteVersionOptionalParams

可选参数。

AgentsDisableOptionalParams

可选参数。

AgentsDownloadAgentCodeOptionalParams

可选参数。

AgentsDownloadSessionFileOptionalParams

可选参数。

AgentsEnableOptionalParams

可选参数。

AgentsGetOptionalParams

可选参数。

AgentsGetSessionLogStreamOptionalParams

可选参数。

AgentsGetSessionOptionalParams

可选参数。

AgentsGetVersionOptionalParams

可选参数。

AgentsListOptionalParams

可选参数。

AgentsListSessionFilesOptionalParams

可选参数。

AgentsListSessionsOptionalParams

可选参数。

AgentsListVersionsOptionalParams

可选参数。

AgentsOperations

表示代理作的接口。

AgentsStopSessionOptionalParams

可选参数。

AgentsUpdateAgentFromManifestOptionalParams

可选参数。

AgentsUpdateAgentObjectOptionalParams

可选参数。

AgentsUpdateOptionalParams

可选参数。

AgentsUploadSessionFileOptionalParams

可选参数。

ApiErrorResponse

API 故障的错误响应。

ApiKeyCredentials

API Key 凭证定义

ApplyPatchToolParam

允许助手使用统一差异创建、删除或更新文件。

ApproximateLocation

模型接口 近似位置

ArtifactProfile

模型的伪影轮廓

AutoCodeInterpreterToolParam

代码解释器容器的配置。 (可选)指定要运行代码的文件 ID。

AzureAIAgentTarget

表示指定Azure AI代理的目标。

AzureAIModelTarget

表示一个目标,指定一个Azure AI模型用于需要模型选择的操作。

AzureAISearchIndex

Azure AI 搜索索引定义

AzureAISearchTool

用于配置代理的 Azure AI 搜索工具的输入定义信息。

AzureAISearchToolResource

azure_ai_search 工具使用的一组索引资源。

AzureAISearchToolboxTool

一个存储在工具箱中的Azure AI 搜索工具。

AzureAgentConfig

Get OpenAIClient method agent endpoint 的配置选项。 主要用于托管代理。

AzureFunctionBinding

用于保留storage队列名称和 URI 的结构。

AzureFunctionDefinition

Azure函数的定义。

AzureFunctionStorageQueue

用于保留storage队列名称和 URI 的结构。

AzureFunctionTool

输入定义信息,用于配置 Agent 的 Azure 函数工具。

AzureOpenAIModelConfiguration

Azure OpenAI 模型配置. API 版本将由服务选择以查询模型。

BaseCredentials

连接凭证的基类

BetaAgentsCancelOptimizationJobOptionalParams

可选参数。

BetaAgentsCreateOptimizationJobOptionalParams

可选参数。

BetaAgentsDeleteOptimizationJobOptionalParams

可选参数。

BetaAgentsGetOptimizationJobOptionalParams

可选参数。

BetaAgentsListOptimizationJobsOptionalParams

可选参数。

BetaAgentsOperations

代表BetaAgent操作的接口。

BetaDatasetsCancelGenerationJobOptionalParams

可选参数。

BetaDatasetsCreateGenerationJobOptionalParams

可选参数。

BetaDatasetsDeleteGenerationJobOptionalParams

可选参数。

BetaDatasetsGetGenerationJobOptionalParams

可选参数。

BetaDatasetsListGenerationJobsOptionalParams

可选参数。

BetaDatasetsOperations

表示 BetaDatasets 操作的接口。

BetaEvaluationTaxonomiesCreateOptionalParams

可选参数。

BetaEvaluationTaxonomiesDeleteOptionalParams

可选参数。

BetaEvaluationTaxonomiesGetOptionalParams

可选参数。

BetaEvaluationTaxonomiesListOptionalParams

可选参数。

BetaEvaluationTaxonomiesOperations

表示BetaEvaluationTaxonomies作的接口。

BetaEvaluationTaxonomiesUpdateOptionalParams

可选参数。

BetaEvaluatorsCancelGenerationJobOptionalParams

可选参数。

BetaEvaluatorsCreateGenerationJobOptionalParams

可选参数。

BetaEvaluatorsCreateVersionOptionalParams

可选参数。

BetaEvaluatorsDeleteGenerationJobOptionalParams

可选参数。

BetaEvaluatorsDeleteVersionOptionalParams

可选参数。

BetaEvaluatorsGetCredentialsOptionalParams

可选参数。

BetaEvaluatorsGetGenerationJobOptionalParams

可选参数。

BetaEvaluatorsGetVersionOptionalParams

可选参数。

BetaEvaluatorsListGenerationJobsOptionalParams

可选参数。

BetaEvaluatorsListOptionalParams

可选参数。

BetaEvaluatorsListVersionsOptionalParams

可选参数。

BetaEvaluatorsOperations

表示BetaEvaluator作的接口。

BetaEvaluatorsPendingUploadOptionalParams

可选参数。

BetaEvaluatorsUpdateVersionOptionalParams

可选参数。

BetaInsightsGenerateOptionalParams

可选参数。

BetaInsightsGetOptionalParams

可选参数。

BetaInsightsListOptionalParams

可选参数。

BetaInsightsOperations

代表BetaInsights作的界面。

BetaMemoryStoresCreateMemoryOptionalParams

可选参数。

BetaMemoryStoresCreateOptionalParams

可选参数。

BetaMemoryStoresDeleteMemoryOptionalParams

可选参数。

BetaMemoryStoresDeleteOptionalParams

可选参数。

BetaMemoryStoresDeleteScopeOptionalParams

可选参数。

BetaMemoryStoresGetMemoryOptionalParams

可选参数。

BetaMemoryStoresGetOptionalParams

可选参数。

BetaMemoryStoresGetUpdateResultOptionalParams

可选参数。

BetaMemoryStoresListMemoriesOptionalParams

可选参数。

BetaMemoryStoresListOptionalParams

可选参数。

BetaMemoryStoresOperations

表示 BetaMemoryStorage作的接口。

BetaMemoryStoresSearchMemoriesOptionalParams

可选参数。

BetaMemoryStoresUpdateMemoriesOptionalParams

可选参数。

BetaMemoryStoresUpdateMemoryOptionalParams

可选参数。

BetaMemoryStoresUpdateOptionalParams

可选参数。

BetaModelsCreateOptions

关于上传本地文件并注册模型版本的创建方法选项。

BetaModelsDeleteOptionalParams

可选参数。

BetaModelsGetCredentialsOptionalParams

可选参数。

BetaModelsGetOptionalParams

可选参数。

BetaModelsListOptionalParams

可选参数。

BetaModelsListVersionsOptionalParams

可选参数。

BetaModelsOperations

表示BetaModels操作的接口。

BetaModelsPendingCreateVersionOptionalParams

可选参数。

BetaModelsPendingUploadOptionalParams

可选参数。

BetaModelsUpdateOptionalParams

可选参数。

BetaOperations

代表Beta作的接口。

BetaRedTeamsCreateOptionalParams

可选参数。

BetaRedTeamsGetOptionalParams

可选参数。

BetaRedTeamsListOptionalParams

可选参数。

BetaRedTeamsOperations

代表BetaRedTeams作的界面。

BetaRoutinesCreateOrUpdateOptionalParams

可选参数。

BetaRoutinesDeleteOptionalParams

可选参数。

BetaRoutinesDisableOptionalParams

可选参数。

BetaRoutinesDispatchOptionalParams

可选参数。

BetaRoutinesEnableOptionalParams

可选参数。

BetaRoutinesGetOptionalParams

可选参数。

BetaRoutinesListOptionalParams

可选参数。

BetaRoutinesListRunsOptionalParams

可选参数。

BetaRoutinesOperations

表示 BetaRoutines 操作的接口。

BetaSchedulesCreateOrUpdateOptionalParams

可选参数。

BetaSchedulesDeleteOptionalParams

可选参数。

BetaSchedulesGetOptionalParams

可选参数。

BetaSchedulesGetRunOptionalParams

可选参数。

BetaSchedulesListOptionalParams

可选参数。

BetaSchedulesListRunsOptionalParams

可选参数。

BetaSchedulesOperations

表示 BetaSchedules作的接口。

BetaSkillsCreateOptionalParams

可选参数。

BetaSkillsCreateVersionFromFilesOptionalParams

可选参数。

BetaSkillsDeleteOptionalParams

可选参数。

BetaSkillsDeleteVersionOptionalParams

可选参数。

BetaSkillsDownloadOptionalParams

可选参数。

BetaSkillsDownloadVersionOptionalParams

可选参数。

BetaSkillsGetOptionalParams

可选参数。

BetaSkillsGetVersionOptionalParams

可选参数。

BetaSkillsListOptionalParams

可选参数。

BetaSkillsListVersionsOptionalParams

可选参数。

BetaSkillsOperations

表示BetaSkills操作的接口。

BetaSkillsUpdateOptionalParams

可选参数。

BingCustomSearchConfiguration

bing自定义搜索配置。

BingCustomSearchPreviewTool

用于配置代理的Bing自定义搜索工具的输入定义信息。

BingCustomSearchToolParameters

bing自定义搜索工具参数。

BingGroundingSearchConfiguration

Bing地面的搜索配置

BingGroundingSearchToolParameters

bing地面搜索工具参数。

BingGroundingTool

用于配置代理的bing地面搜索工具的输入定义信息。

BlobReference

Blob 引用详细信息。

BotServiceAuthorizationScheme

模型接口 BotServiceAuthorizationScheme

BotServiceRbacAuthorizationScheme

模型接口 BotServiceRbacAuthorizationScheme

BotServiceTenantAuthorizationScheme

模型接口 BotServiceTenantAuthorizationScheme

BrowserAutomationPreviewTool

浏览器自动化工具的输入定义信息,用于配置代理。

BrowserAutomationPreviewToolboxTool

存储在工具箱中的浏览器自动化工具。

BrowserAutomationToolConnectionParameters

定义浏览器自动化工具使用的连接的输入参数。

BrowserAutomationToolParameters

浏览器自动化工具的输入参数的定义。

CaptureStructuredOutputsTool

用于捕获结构化输出的工具

ChartCoordinate

分析图表的坐标。

ChatSummaryMemoryItem

包含从对话中提取的摘要的记忆项。

ClusterInsightResult

来自聚类分析的见解。

ClusterTokenUsage

集群分析的令牌使用情况

CodeBasedEvaluatorDefinition

使用 python 代码定义基于代码的评估器

CodeConfiguration

基于代码的托管代理部署配置。

CodeInterpreterTool

一个运行Python代码以帮助生成对提示回复的工具。

CodeInterpreterToolboxTool

一个存储在工具箱中的代码解释器工具。

ComparisonFilter

用于使用定义的比较操作来比较指定属性键与给定值的筛选器。

CompoundFilter

使用 andor. 合并多个筛选器。

ComputerTool

控制虚拟计算机的工具。 了解有关 计算机工具的更多信息。

ComputerUsePreviewTool

控制虚拟计算机的工具。 了解有关 计算机工具的更多信息。

Connection

来自列表的响应和获取连接作

ConnectionsGetOptionalParams

可选参数。

ConnectionsGetWithCredentialsOptionalParams

可选参数。

ConnectionsListOptionalParams

可选参数。

ConnectionsOperations

表示 Connections作的接口。

ContainerAutoParam

model interface ContainerAutoParam

ContainerConfiguration

托管代理的基于容器的部署配置。

ContainerNetworkPolicyAllowlistParam

model interface ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyDisabledParam

model interface ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDomainSecretParam

model interface ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyParam

容器的网络访问政策。

ContainerSkill

model interface ContainerSkill

ContinuousEvaluationRuleAction

用于持续评估的评估规则作。

CosmosDBIndex

CosmosDB 矢量存储索引定义

CreateAgentVersionFromCodeContent

用于更新或版本化基于代码的代理的多部分请求体(POST /agents/{name} 和 POST /agents/{name}/versions)。

CreateAgentVersionFromCodeMetadata

用于基于代码的代理操作(创建、更新、创建版本)的JSON元数据。 代理名称来源于 URL 路径参数或 x-ms-agent-name 头部,因此不包含在本模型中。 内容哈希(zip的SHA-256)被存储在 x-ms-code-zip-sha256 头部中。

CreateSkillVersionFromFilesBody

多部分请求正体,用于从文件创建技能版本。 支持单个压缩包或多个技能文件(目录上传)。 对于压缩包上传,服务器会解压并验证内容。 对于目录上传,文件会被验证 as-is。

CronTrigger

基于 Cron 的触发器。

CustomCredential

自定义凭证定义

CustomGrammarFormatParam

由用户定义的语法。

CustomRoutineTrigger

自定义事件例程触发器。

CustomTextFormatParam

不受限制的自由形式文本。

CustomToolParam

一个自定义工具,使用指定格式处理输入。 详细了解 custom 工具

CustomToolParamFormat

自定义工具的输入格式。 默认是无约束文本。

DailyRecurrenceSchedule

每日重复计划。

DataGenerationJob

数据生成职位资源。

DataGenerationJobInputs

呼叫者提供的输入用于数据生成任务。

DataGenerationJobOptions

管理数据生成工作的选项。

DataGenerationJobOutput

数据生成作业的输出信息。

DataGenerationJobOutputOptions

数据生成工作的输出选项。

DataGenerationJobResult

成功的数据生成工作带来的结果。

DataGenerationJobSource

数据生成工作的基础源模型。

DataGenerationModelOptions

数据生成工作的大型语言模型选项。

DataGenerationTokenUsage

数据生成任务的令牌使用信息。

DatasetCredential

表示对 blob 的引用以供使用

DatasetDataGenerationJobOutput

数据生成作业的数据集输出。

DatasetEvaluatorGenerationJobSource

评估员生成作业的数据集来源——参考数据集。

DatasetReference

参考版本化的Foundry数据集。

DatasetVersion

DatasetVersion 定义

DatasetsCreateOrUpdateOptionalParams

可选参数。

DatasetsDeleteOptionalParams

可选参数。

DatasetsGetCredentialsOptionalParams

可选参数。

DatasetsGetOptionalParams

可选参数。

DatasetsListOptionalParams

可选参数。

DatasetsListVersionsOptionalParams

可选参数。

DatasetsOperations

表示 Datasets作的接口。

DatasetsPendingUploadOptionalParams

可选参数。

DeleteAgentResponse

已删除的代理对象

DeleteAgentVersionResponse

已删除的代理版本对象

DeleteMemoryResponse

从内存存储中删除内存项时的响应。

DeleteMemoryStoreResponse

模型接口 DeleteMemoryStoreResponse

DeleteSkillResponse

一个被删掉的技能。

DeleteSkillVersionResponse

一个被删减的技能版本。

Deployment

模型部署定义

DeploymentsGetOptionalParams

可选参数。

DeploymentsListOptionalParams

可选参数。

DeploymentsOperations

表示 Deployment作的接口。

Dimension

单一维度——评分标准评估者评分蓝图中独立且可测量的质量维度。

DispatchRoutineResponse

例行派遣后返回的标识符被排队。

EmbeddingConfiguration

嵌入配置类

EmptyModelParam

model interface EmptyModelParam

EndpointBasedEvaluatorDefinition

基于端点的评估器定义。 客户拥有并托管一个实现评估合同的HTTP端点。 评估器通过名称引用 Project Connection;连接存储端点 URL 和凭证(API Key 或 Entra ID)。 执行时,服务解析连接以获取端点URL和认证细节,然后对每个评估行调用该端点。

EntraAuthorizationScheme

模型接口EntraAuthorizationScheme

EntraIDCredentials

Entra ID 凭证定义

ErrorModel

模型接口 ErrorModel

EvalResult

评估结果。

EvalRunResultCompareItem

治疗与基线的指标比较。

EvalRunResultComparison

治疗运行与基线的比较结果。

EvalRunResultSummary

评估运行中指标的汇总统计信息。

EvaluationComparisonInsightRequest

评估比较请求

EvaluationComparisonInsightResult

评估比较的见解。

EvaluationResultSample

评估结果中的示例。

EvaluationRule

评估规则模型。

EvaluationRuleAction

评估行动模型。

EvaluationRuleFilter

评估筛选器模型。

EvaluationRulesCreateOrUpdateOptionalParams

可选参数。

EvaluationRulesDeleteOptionalParams

可选参数。

EvaluationRulesGetOptionalParams

可选参数。

EvaluationRulesListOptionalParams

可选参数。

EvaluationRulesOperations

表示 EvaluationRules作的接口。

EvaluationRunClusterInsightRequest

对一组评估结果的见解

EvaluationRunClusterInsightResult

来自评估运行集群分析的见解。

EvaluationScheduleTask

计划的评估任务。

EvaluationTarget

具有鉴别器支持的目标的基类。

EvaluationTaxonomy

评估分类定义

EvaluationTaxonomyInput

评估分类的输入配置。

EvaluatorCredentialRequest

申请评估员资格的机构

EvaluatorDefinition

使用鉴别器的基本评估器配置

EvaluatorGenerationArtifacts

由评估器生成作业产生的服务管理来源伪造物。 仅存在于通过生成管道创建的 EvaluatorVersion 资源中。 combined-JSONL Foundry 数据集是只读的,并解析为服务保留命名空间中的版本化数据集。

EvaluatorGenerationInputs

来电者提供的评估器生成任务输入。

EvaluatorGenerationJob

评估员生成作业资源——一个长期运行的作业,从源材料生成基于评分标准的评估者定义。 成功后,结果是持久化的 EvaluatorVersion。

EvaluatorGenerationJobSource

评估器生成作业的基础源模型。 多态性 。type

EvaluatorGenerationTokenUsage

评估器生成作业的代币消耗摘要。 当工作达到终极状态时,会被填满。

EvaluatorMetric

评估器指标

EvaluatorVersion

评估器定义

ExternalAgentDefinition

外部代理的定义。 代表托管在Foundry之外的第三方代理(例如在GCP或AWS上)。 注册仅包含元数据:Foundry 记录代理定义,以通过客户发布的 OpenTelemetry 数据点亮可观测性体验(追踪、评估)。

FabricDataAgentToolParameters

Fabric 数据代理工具参数。

FabricIQPreviewTool

一个FabricIQ服务器端工具。

FabricIQPreviewToolboxTool

一个存储在工具箱中的FabricIQ工具。

FieldMapping

字段映射配置类

FileDataGenerationJobOutput

Azure OpenAI file output for a data generation job.

FileDataGenerationJobSource

File source for data generation jobs — Azure OpenAI file input.

FileDatasetVersion

FileDatasetVersion 定义

FileSearchTool

一个工具,用于搜索已上传文件中的相关内容。 详细了解 文件搜索工具

FileSearchToolboxTool

一个存储在工具箱中的文件搜索工具。

FixedRatioVersionSelectionRule

model interface FixedRatioVersionSelectionRule

FolderDatasetVersion

FileDatasetVersion 定义

FoundryModelWarning

这是与模型相关的警告。

FunctionShellToolParam

一个允许模型执行shell命令的工具。

FunctionShellToolParamEnvironment

model interface FunctionShellToolParamEnvironment

FunctionShellToolParamEnvironmentContainerReferenceParam

model interface FunctionShellToolParamEnvironmentContainerReferenceParam

FunctionShellToolParamEnvironmentLocalEnvironmentParam

model interface FunctionShellToolParamEnvironmentLocalEnvironmentParam

FunctionTool

在自己的代码中定义模型可以选择调用的函数。 详细了解 函数调用

FunctionToolParam

model interface FunctionToolParam

GenAITracingOptions

在特定 AIProjectClient 实例上配置生成式 AI 追踪的选项。

在客户端实例化时,通过 AIProjectClientOptionalParams 键传递这些数据 tracingOptions ,以启用生成式 AI 追踪。 每个客户端实例都维护自己的独立追踪配置。

GitHubIssueRoutineTrigger

一个 GitHub 的问题例程触发器。

HeaderTelemetryEndpointAuth

基于头部的远程测定终端秘密认证。 解析后的秘密值会作为HTTP头注入。

HostedAgentDefinition

托管代理定义。

HourlyRecurrenceSchedule

每小时重复计划。

HumanEvaluationPreviewRuleAction

用于人工评估的评估规则作。

HybridSearchOptions

模型界面 HybridSearchOptions

ImageGenTool

一个利用GPT图像模型生成图像的工具。

ImageGenToolInputImageMask

模型接口 ImageGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

可选参数。

IndexesDeleteOptionalParams

可选参数。

IndexesGetOptionalParams

可选参数。

IndexesListOptionalParams

可选参数。

IndexesListVersionsOptionalParams

可选参数。

IndexesOperations

表示 Indexes作的接口。

InlineSkillParam

model interface InlineSkillParam

InlineSkillSourceParam

直联技能载荷

Insight

集群见解的响应正文。

InsightCluster

分析样本集群。

InsightGenerationRequest

请求机构用于生成洞察。

InsightModelConfiguration

见解生成中使用的模型的配置。

InsightRequest

见解报告的请求。

InsightResult

洞察的结果。

InsightSample

分析中的样本。

InsightScheduleTask

计划的见解任务。

InsightSummary

误差聚类分析的摘要。

InsightsMetadata

有关见解的元数据。

InvocationsProtocolConfiguration

针对调用协议的配置。

InvocationsWsProtocolConfiguration

针对基于WebSocket的调用协议的配置。

InvokeAgentInvocationsApiDispatchPayload

用于测试调用API例程调度的手动有效载荷。

InvokeAgentInvocationsApiRoutineAction

通过原始调用API调度例程。 必须提供agent_name或agent_endpoint_id中的一个。

InvokeAgentResponsesApiDispatchPayload

用于测试响应API例程调度的手动负载。

InvokeAgentResponsesApiRoutineAction

通过响应API派遣一个例程。 必须提供agent_name或agent_endpoint_id中的一个。

LocalShellToolParam

允许模型在本地环境中执行 shell 命令的工具。

LocalSkillParam

model interface LocalSkillParam

LoraConfig

针对LoRA模型的适配器专用元数据。 驱动在部署时执行发动机配置。

MCPTool

通过远程模型上下文协议 (MCP) 服务器向模型授予对其他工具的访问权限。 详细了解 MCP

MCPToolFilter

一个过滤器对象,用于指定允许使用哪些工具。

MCPToolRequireApproval

model interface MCPToolRequireApproval

MCPToolboxTool

一个存储在工具箱中的MCP工具。

ManagedAgentIdentityBlueprintReference

model interface ManagedAgentIdentityBlueprintReference

ManagedAzureAISearchIndex

托管Azure AI 搜索索引定义

McpProtocolConfiguration

针对MCP协议的具体配置。

MemoryItem

存储在内存存储中的单个内存项,包含内容和元数据。

MemoryOperation

表示对内存项执行的单个内存作(创建、更新或删除)。

MemorySearchItem

从内存搜索中检索到的内存项。

MemorySearchOptions

内存搜索选项。

MemorySearchPreviewTool

将记忆集成到代理中的工具。

MemoryStore

可以存储和检索用户记忆的内存存储。

MemoryStoreDefaultDefinition

默认内存存储实现。

MemoryStoreDefaultOptions

默认内存存储配置。

MemoryStoreDefinition

内存存储配置的基本定义。

MemoryStoreDeleteScopeResponse

从作用域中删除内存的响应。

MemoryStoreOperationUsage

内存存储作的使用情况统计信息。

MemoryStoreSearchResponse

内存搜索响应。

MemoryStoreUpdateCompletedResult

内存更新结果。

MemoryStoreUpdateResponse

提供内存存储更新作的状态。

MicrosoftFabricPreviewTool

用于配置代理的 Microsoft Fabric 工具的输入定义信息。

ModelCredentialRequest

请求获取模型资产的凭证。

ModelDeployment

模型部署定义

ModelDeploymentSku

Sku 信息

ModelPendingUploadRequest

表示模型版本上传的请求。

ModelPendingUploadResponse

表示模型等待上传请求的响应。

ModelSamplingParams

表示一组参数,用于在文本生成过程中控制语言模型的采样行为。

ModelSourceData

模型来源信息

ModelVersion

模型版本定义

MonthlyRecurrenceSchedule

每月定期计划。

NamespaceToolParam

在共享命名空间下组功能/自定义工具。

NoAuthenticationCredentials

不需要身份验证的凭据

OneTimeTrigger

一次性触发器。

OpenAIClientOptionsWithAzureAgent

扩展 OpenAI 客户端选项,包含 Azure Agent 端点配置。

OpenApiAnonymousAuthDetails

OpenApi 匿名身份验证的安全详细信息

OpenApiAuthDetails

OpenApiFunctionDefinition 的身份验证详细信息

OpenApiFunctionDefinition

openapi 函数的输入定义信息。

OpenApiManagedAuthDetails

OpenApi managed_identity身份验证的安全详细信息

OpenApiManagedSecurityScheme

OpenApi managed_identity身份验证的安全方案

OpenApiProjectConnectionAuthDetails

OpenApi project连接身份验证的安全详细信息

OpenApiProjectConnectionSecurityScheme

OpenApi managed_identity身份验证的安全方案

OpenApiTool

用于配置代理的 OpenAPI 工具的输入定义信息。

OpenApiToolboxTool

一个存储在工具箱中的OpenAPI工具。

OptimizationAgentIdentifier

识别注册的Foundry代理进行优化(仅请求)。 技能、工具和system_prompt在options.optimization_config中明确规定。

OptimizationCandidate

针对单个候选代理配置在所有任务中的汇总评估结果。

OptimizationDatasetCriterion

评估标准:用于逐项评分的名称+指令对。

OptimizationDatasetInput

基于基于的区分模型用于数据集输入。 要么是内嵌条目,要么是注册的参考文献。

OptimizationDatasetItem

在线数据集中的单个项目。

OptimizationEvaluatorRef

引用一个命名的评估器,可选择置顶到某个版本。

OptimizationInlineDatasetInput

内联数据集——直接在请求主体中提供的项目。

OptimizationJob

代理优化作业资源——一个长期运行的任务,优化代理的配置(指令、模型、技能、工具)以最大化评估分数。 成功后,结果包含评分候选人。

OptimizationJobInputs

呼叫者提供的优化输入。

OptimizationJobListItem

LIST端点返回的任务表示非常有限。

OptimizationJobProgress

飞行进展;只有在状态排队或in_progress时才会被填充。

OptimizationJobResult

终端状态结果机构。 当状态成功或失败时填充。

OptimizationOptions

调校旋钮和运行模式以进行优化工作。

OptimizationReferenceDatasetInput

引用已注册的Foundry数据集。

OtlpTelemetryEndpoint

一个OTLP(OpenTelemetry Protocol)遥测导出终端。

PageSettings

跟踪分页迭代设置的接口

PagedAsyncIterableIterator

允许异步迭代到完成和逐页迭代的接口。

PendingUploadRequest

表示对待上载的请求。

PendingUploadResponse

表示待处理上传请求的响应

ProceduralMemoryItem

一个包含从对话中提取的程序的内存项。

PromotionInfo

候选人被部署到Foundry代理时记录的晋升元数据。

PromptAgentDefinition

提示代理定义

PromptAgentDefinitionTextOptions

来自模型的文本响应的配置选项。 可以是纯文本或结构化 JSON 数据。

PromptBasedEvaluatorDefinition

基于提示的评估器

PromptDataGenerationJobSource

数据生成任务的提示源——用户提供的内联文本。

PromptEvaluatorGenerationJobSource

评估者生成任务的提示源——用户提供的内联文本。

ProtocolConfiguration

代理端点的每个协议配置。

ProtocolVersionRecord

单个协议及其版本的记录映射。

RaiConfig

负责任 AI (RAI) 内容筛选和安全功能的配置。

RankingOptions

模型界面 RankingOptions

Reasoning

仅限GPT-5和O系列车型理模型的配置选项。

RecurrenceSchedule

定期计划模型。

RecurrenceTrigger

基于重复的触发器。

RedTeam

红队详情。

RedTeamTargetConfig

目标配置的抽象类。

ReminderPreviewToolboxTool

一个存储在工具箱里的提醒工具。

ResponseUsageInputTokensDetails

model interface ResponseUsageInputTokensDetails

ResponseUsageOutputTokensDetails

模型接口 响应使用输出令牌详情

ResponsesProtocolConfiguration

针对响应协议的具体配置。

Routine

服务返回的常规定义。

RoutineAction

例行动作的基础模型。

RoutineDispatchPayload

手动调度有效载荷的基础模型。

RoutineRun

一次例程运行从运行历史API返回。

RoutineTrigger

例行触发器的基础模型。

RubricBasedEvaluatorDefinition

基于评分标准的评估器定义——存储由生成API产生的维度。 用于质量和安全评估。

SASTokenCredentials

共享访问签名 (SAS) 凭据定义

SasCredential

SAS 凭证定义

Schedule

计划模型。

ScheduleRoutineTrigger

一个反复出现的基于克隆的例行触发器。

ScheduleRun

计划运行模型。

ScheduleTask

计划任务模型。

SessionDirectoryEntry

目录列表中的一条条目。

SessionDirectoryListResponse

在会话沙箱中列出目录的响应。

SessionFileWriteResponse

上传文件到会话沙箱时的响应。

SessionLogEvent

由托管代理会话日志流发出的单一 Server-Sent 事件帧。

每个帧包含 event 一个字段,标识事件类型,以及 data 一个以明文形式载荷的字段。 虽然当前 data 有效载荷是JSON格式,但其模式并非契约性——可能会出现更多键,格式也可能随时间变化。 客户端应 data 视为不透明字符串,并可选择尝试JSON解析。

未来可能会新增新的事件类型。 客户应优雅地忽略未识别的事件类型。

线式格式:

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

SharePoint 接地工具参数。

SharepointPreviewTool

用于配置代理的 sharepoint 工具的输入定义信息。

SimpleQnADataGenerationJobOptions

SimpleQnA 类型的数据生成任务选项。

Skill

一个技能资源。

SkillInlineContent

内联内容,帮助定义一个简单技能,无需上传文件。 遵循 agentskills.io SKILL.md 规范。

SkillReferenceParam

model interface SkillReferenceParam

SkillVersion

某种技能的具体版本。

SpecificApplyPatchParam

强制模型在执行工具调用时调用apply_patch工具。

SpecificFunctionShellParam

强制模型在需要工具调用时调用 shell 工具。

StructuredInputDefinition

可以参与提示模板替换和工具参数绑定的结构化输入。

StructuredOutputDefinition

代理可以生成的结构化输出。

TaxonomyCategory

分类类别定义。

TaxonomySubCategory

分类学子类别定义。

TelemetryConfig

客户提供的遥测配置,用于导出容器日志、追踪和指标。

TelemetryEndpoint

遥测导出端点配置。

TelemetryEndpointAuth

遥测终端的认证配置。

TelemetryOperations

表示遥测作的接口

TextResponseFormat

一个对象,指定模型必须输出的格式。 配置 { "type": "json_schema" } 启用结构化输出,这可确保模型与提供的 JSON 架构匹配。 在 结构化输出指南中了解详细信息。 默认格式 { "type": "text" } 没有其他选项。 不推荐用于GPT-4o及新型号:* 设置启用 { "type": "json_object" } 旧版JSON模式,确保模型生成的消息是有效的JSON。 对于支持它的模型,首选使用 json_schema

TextResponseFormatConfiguration
TextResponseFormatConfigurationResponseFormatJsonObject
TextResponseFormatConfigurationResponseFormatText
TextResponseFormatJsonObject

JSON 对象响应格式。 生成 JSON 响应的较旧方法。 建议对支持它的模型使用 json_schema 。 请注意,除非有系统或用户消息指示,模型不会生成 JSON。

TextResponseFormatJsonSchema

JSON 架构响应格式。 用于生成结构化 JSON 响应。 详细了解 结构化输出

TextResponseFormatText

默认响应格式。 用于生成文本响应。

TimerRoutineTrigger

一次性计时程序触发。

Tool

可用于生成响应的工具。

ToolChoiceAllowed

将模型可用的工具限制为预定义集。

ToolChoiceCodeInterpreter

指示模型应使用内置工具生成响应。 详细了解内置工具

ToolChoiceComputer

指示模型应使用内置工具生成响应。 详细了解内置工具

ToolChoiceComputerUse

指示模型应使用内置工具生成响应。 详细了解内置工具

ToolChoiceComputerUsePreview

指示模型应使用内置工具生成响应。 详细了解内置工具

ToolChoiceCustom

使用此选项强制模型调用特定的自定义工具。

ToolChoiceFileSearch

指示模型应使用内置工具生成响应。 详细了解内置工具

ToolChoiceFunction

使用此选项强制模型调用特定函数。

ToolChoiceImageGeneration

指示模型应使用内置工具生成响应。 详细了解内置工具

ToolChoiceMCP

使用此选项可强制模型调用远程 MCP 服务器上的特定工具。

ToolChoiceParam

模型在生成响应时应如何选择要使用的工具(或工具)。 请参阅参数 tools ,了解如何指定模型可以调用的工具。

ToolChoiceWebSearchPreview

指示模型应使用内置工具生成响应。 详细了解内置工具

ToolChoiceWebSearchPreview20250311

指示模型应使用内置工具生成响应。 详细了解内置工具

ToolConfig

按工具配置,控制工具的可见性和搜索行为。

ToolDescription

代理可以使用的工具的描述。

ToolProjectConnection

project连接资源。

ToolSearchToolParam

延迟工具的托管或自带工具搜索配置。

ToolUseFineTuningDataGenerationJobOptions

关于ToolUse类型的数据生成任务选项。 仅用于微调场景。

ToolboxObject

一个存储可重复使用工具定义的工具箱,供代理使用。

ToolboxPolicies

工具箱的策略配置,包括内容安全和其他治理设置。

ToolboxSearchPreviewToolboxTool

一个存储在工具箱中的工具箱搜索工具。

ToolboxSkill

工具箱里包含的技能来源。

ToolboxSkillReference

指的是一项现有技能,可以纳入工具箱。

ToolboxTool

工具箱中工具的抽象表示。

ToolboxVersionObject

一个特定版本的工具箱。

ToolboxesCreateVersionOptionalParams

可选参数。

ToolboxesDeleteOptionalParams

可选参数。

ToolboxesDeleteVersionOptionalParams

可选参数。

ToolboxesGetOptionalParams

可选参数。

ToolboxesGetVersionOptionalParams

可选参数。

ToolboxesListOptionalParams

可选参数。

ToolboxesListVersionsOptionalParams

可选参数。

ToolboxesOperations

表示工具箱操作的接口。

ToolboxesUpdateOptionalParams

可选参数。

TracesDataGenerationJobOptions

带有Traces类型的数据生成作业选项。

TracesDataGenerationJobSource

数据生成工作的跟踪来源——来自应用洞察的对话追踪。

TracesEvaluatorGenerationJobSource

评估员生成职位的跟踪来源——来自 Application Insights。

Trigger

计划触发器的基本模型。

UpdateModelVersionRequest

请求正体以更新模型版本。 只有描述和标签可以修改。

UpdateToolboxRequest

model interface UpdateToolboxRequest

UserProfileMemoryItem

专门包含从对话中提取的用户个人资料信息的记忆项,例如偏好、兴趣和个人详细信息。

VersionIndicator

版本指示器,确定支持会话的代理版本。

VersionRefIndicator

版本指示器,通过名称引用特定代理版本。

VersionSelectionRule

model interface VersionSelectionRule

VersionSelector

模型接口版本选择器

WebSearchApproximateLocation

用户的大致位置。

WebSearchConfiguration

bing自定义搜索的 Web 搜索配置

WebSearchPreviewTool

该工具会在网上搜索相关结果以供回复。 详细了解 web 搜索工具

WebSearchTool

在网上搜索与该提示相关的资料。 详细了解 web 搜索工具

WebSearchToolFilters

模型界面 WebSearchToolFilters

WebSearchToolboxTool

一个存储在工具箱中的网络搜索工具。

WeeklyRecurrenceSchedule

每周重复计划。

WorkIQPreviewTool

一个WorkIQ服务器端工具。

WorkIQPreviewToolboxTool

一个存储在工具箱中的WorkIQ工具。

WorkflowAgentDefinition

工作流代理定义。

类型别名

AgentBlueprintReferenceType

代理类型:BlueprintReferenceType

AgentBlueprintReferenceUnion

AgentBlueprintReferenceUnion 的别名

AgentDefinitionOptInKeys

支持托管或工作流代理的代理定义操作的功能选择加入密钥。

AgentDefinitionUnion

所有代理定义类型的联合类型。 支持工作流程、托管、容器应用、提示符和外部代理。

AgentEndpoint
AgentEndpointAuthorizationSchemeType

代理类型端点授权方案类型

AgentEndpointAuthorizationSchemeUnion

AgentEndpointAuthorizationSchemeUnion 的别名

AgentKind

定义代理的类型/种类。 确定使用哪种代理定义结构。

AgentProtocol

代理协议类型

AgentSessionStatus

代理会话状态。

AgentState

特工的操作状态。

AgentType

代理类型类型

AgentVersionStatus

代理版本的配置状态。

AgentsDownloadAgentCodeResponse
AgentsDownloadSessionFileResponse
AttackStrategy

攻击策略。

AzureAISearchQueryType

Azure AI 搜索 工具可用的查询类型。

BaseCredentialsUnion

BaseCredentialsUnion 的别名

BetaSkillsDownloadResponse
CodeDependencyResolution

如何在基于代码的托管代理部署时解决包依赖关系。

ComparisonFilterValueItems

ComparisonFilterValueItems 的别名

ComputerEnvironment

计算机环境类型

ConnectionType

连接的类型(或类别)

ContainerMemoryLimit

容器内存限制类型

ContainerNetworkPolicyParamType

容器网络政策ParamType类型类型

ContainerNetworkPolicyParamUnion

Alias for ContainerNetworkPolicyParamUnion

ContainerSkillType

容器类型技能类型

ContainerSkillUnion

ContainerSkillUnion 的别名

ContinuablePage

描述结果页的接口。

CredentialType

连接使用的凭证类型

CustomToolParamFormatType

CustomToolParamFormatType 类型

CustomToolParamFormatUnion

Alias for CustomToolParamFormatUnion

DataGenerationJobOptionsUnion

Alias for DataGenerationJobOptionsUnion

DataGenerationJobOutputType

支持的数据生成作业输出文件类型。

DataGenerationJobOutputUnion

DataGenerationJobOutputUnion 的别名

DataGenerationJobScenario

支持的数据生成任务场景。

DataGenerationJobSourceType

支持的数据生成作业源类型。

DataGenerationJobSourceUnion

DataGenerationJobSourceUnion 的别名

DataGenerationJobType

支持的数据生成工作类型。

DatasetType

用于确定数据类型的枚举。

DatasetVersionUnion

DatasetVersionUnion 的别名

DayOfWeek

重复计划的一周中的几天。

DeploymentType

DeploymentType 类型

DeploymentUnion

DeploymentUnion 的别名

DownloadVersionResponse
EvaluationLevel

评估进行的层级。

EvaluationRuleActionType

评估作的类型。

EvaluationRuleActionUnion

EvaluationRuleActionUnion 的别名

EvaluationRuleEventType

评估规则事件的类型。

EvaluationTargetUnion

评估别名TargetUnion

EvaluationTaxonomyInputType

评估分类输入的类型。

EvaluationTaxonomyInputUnion

评估的别名TaxonomyInputUnion

EvaluatorCategory

评估者的类别

EvaluatorDefinitionType

评估器定义的类型

EvaluatorDefinitionUnion

EvaluatorDefinitionUnion 的别名

EvaluatorGenerationJobSourceType

评估器生成作业支持的源类型。

EvaluatorGenerationJobSourceUnion

EvaluatorGenerationJobSourceUnion 的别名

EvaluatorMetricDirection

指标的方向指示值越高越好、值越低越好还是中性

EvaluatorMetricType

评估器的类型

EvaluatorType

评估器的类型

FileContents

二进制文件内容的有效值。

Filters

过滤器的别名

FoundryFeaturesOptInKeys

铸造厂类型功能选择键

FoundryModelArtifactProfileCategory

文物档案类别。

FoundryModelArtifactProfileSignal

模型伪影中检测到信号。

FoundryModelSourceType

模型的来源类型。

FoundryModelWarningCode

模型伪影的警告代码。

FoundryModelWeightType

模型的重量类型。

FunctionShellToolParamEnvironmentType

函数类型ShellToolParamEnvironmentType

FunctionShellToolParamEnvironmentUnion

Alias for FunctionShellToolParamEnvironmentUnion

GitHubIssueEvent

已知的 GitHub issue 事件可以触发例程。

GrammarSyntax

语法类型句法

ImageGenAction

图像GenAction类型

IndexType

IndexType 的类型

IndexUnion

IndexUnion 的别名

InputFidelity

控制模型在匹配输入图像的样式和特征(尤其是面部特征)方面将付出多少努力。 该参数仅支持gpt-image-1gpt-image-1.5及后续模型,不支持。gpt-image-1-mini 支持 highlow。 默认为 low

InsightRequestUnion

InsightRequestUnion 的别名

InsightResultUnion

InsightResultUnion 的别名

InsightSampleUnion

InsightSampleUnion 的别名

InsightType

见解的请求。

JobStatus

铸造厂职位共享的可扩展状态值。

MemoryItemKind

记忆项种类。

MemoryItemUnion

MemoryItemUnion 的别名

MemoryOperationKind

内存作类型。

MemoryStoreDefinitionUnion

MemoryStoreDefinitionUnion 的别名

MemoryStoreKind

要使用的内存存储实现的类型。

MemoryStoreType

存储类型

MemoryStoreUpdateStatus

内存存储更新作的状态。

NodeReadableStream

为 ReadableStream 输入别名 Node.js。 在节点目标上,这会被解析为实际的NodeJS.ReadableStream类型。 在浏览器/React-native 目标上,平台变体解析为 never,自然退出 union 类型。

OpenApiAuthDetailsUnion

OpenApiAuthDetailsUnion 的别名

OpenApiAuthType

OpenApi 终端节点的身份验证类型。 允许的类型是:

  • 匿名(无需身份验证)
  • Project 连接(需要project_connection_id端点,按照 AI Foundry 的设置)
  • Managed_Identity (需要受众进行基于身份的身份验证)
OperationState

描述允许的作状态的枚举。

OptimizationDatasetInputType

数据集输入的判别值。

OptimizationDatasetInputUnion

优化数据集别名InputUnion

PageOrder

页序类型

PendingUploadType

待上传的类型。

RankerVersionType

排名者类型版本类型

ReasoningEffort

限制对推理模型的努力。 目前支持的值为 noneminimallowmediumhighxhigh、 和 。 减少推理工作量可以加快回复速度,减少回复中用于推理的标记。

  • gpt-5.1 默认为 none,不进行推理。 支持的 gpt-5.1 推理值为 nonelowmediumhigh。 gpt-5.1 中的所有推理值都支持工具调用。
  • 所有模型之前 gpt-5.1 默认采用 medium 推理努力,且不支持 none
  • gpt-5-pro 模型默认(且仅支持) high 推理努力。
  • xhigh 支持所有之后 gpt-5.1-codex-max的型号。
RecurrenceScheduleUnion

RecurrenceScheduleUnion 的别名

RecurrenceType

重复类型。

RedTeamTargetConfigUnion

RedTeamTargetConfigUnion 的别名

RiskCategory

攻击目标的风险类别。

RoutineActionType

为例行操作支持的判别器值。

RoutineActionUnion

RoutineActionUnion 的别名

RoutineAttemptSource

已知的源路径可以产生常规运行。

RoutineDispatchPayloadType

这些判别器值支持手动例行调度有效载荷。

RoutineDispatchPayloadUnion

RoutineDispatchPayloadUnion 的别名

RoutineRunPhase

例行运行记录的已知生命周期阶段。

RoutineRunStatus

例行跑的状态。

RoutineTriggerType

支持常规触发器的判别器值。

RoutineTriggerUnion

RoutineTriggerUnion 的别名

SampleType

分析中使用的样品类型。

ScheduleProvisioningStatus

计划配置状态。

ScheduleTaskType

任务的类型。

ScheduleTaskUnion

ScheduleTaskUnion 的别名

SearchContentType

搜索类型内容类型

SearchContextSize

搜索类型ContextSize

SessionLogEventType

由托管代理会话日志流发出的已知SSE事件类型。 未来版本可能会引入更多事件类型。

SimpleQnAFineTuningQuestionType

用于微调场景的 SimpleQnA 数据生成作业支持的问题类型。

TelemetryDataKind

导出的遥测数据类型。

TelemetryEndpointAuthType

遥测端点的认证类型。

TelemetryEndpointAuthUnion

Alias for TelemetryEndpointAuthUnion

TelemetryEndpointKind

那种遥测导出终端。

TelemetryEndpointUnion

Alias for TelemetryEndpointUnion

TelemetryTransportProtocol

用于遥测导出的传输协议。

TextResponseFormatConfigurationType

文本类型:响应格式配置类型

TextResponseFormatConfigurationUnion
TextResponseFormatUnion

TextResponseFormatUnion 的别名

ToolChoiceParamType

工具选择类型参数类型

ToolChoiceParamUnion

ToolChoiceParamUnion 的别名

ToolSearchExecutionType

工具类型搜索执行类型

ToolType

工具类型类型

ToolUnion

ToolUnion 的别名

ToolboxSkillUnion

ToolboxSkillUnion 的别名

ToolboxToolType

支持的工具类型,用于存储在工具箱中的工具。

ToolboxToolUnion

ToolboxToolUnion 的别名

TreatmentEffectType

治疗效果类型。

TriggerType

触发器的类型。

TriggerUnion

TriggerUnion 的别名

VersionIndicatorType

用于确定支持会话的代理版本的类型指示器。

VersionIndicatorUnion

VersionIndicatorUnion 的别名

VersionSelectionRuleType

版本选择规则类型类型

VersionSelectionRuleUnion

VersionSelectionRuleUnion 的别名

枚举

KnownApiVersions

Microsoft Foundry API 版本

函数

isRestError(unknown)

RestError 的 Typeguard

变量

RestError

失败管道请求的自定义错误类型。

函数详细信息

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

参数

e

unknown

catch 子句捕获的内容。

返回

e

变量详细信息

RestError

失败管道请求的自定义错误类型。

RestError: RestErrorConstructor

类型