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

@azure/ai-projects package

类

AIProjectClient

AIProjectClient 的主客户端

VoiceAgentAuthenticationError

在获取 Microsoft Entra 访问令牌时出现错误。

VoiceAgentConnectionError

这是由WebSocket连接引发的错误。

VoiceAgentProtocolError

当WebSocket消息与语音代理协议不匹配时,会引发错误。

VoiceAgentRealtimeClient

为建立与托管Foundry语音代理实时会话的客户端。

VoiceAgentRealtimeError

Voice Agents实时客户端引发的基础错误。

接口

@azure/ai-projects.Index
A2APreviewTool

实现 A2A 协议的代理。

A2APreviewToolboxTool

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

A2AProtocolConfiguration

针对A2A协议的具体配置。

A2ATool

实现 A2A 协议的代理。

A2AToolboxTool

一个存放在工具箱里的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

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

AgentHarness

(预览)用于执行提示代理的托管运行时和代理循环。

AgentIdentity

模型接口 AgentIdentity

AgentInsight

一个持续存在的问题,是通过一名特工的痕迹发现的。

AgentInsightDetails

更多见解细节。 除非需要细节,否则略去。

AgentInsightEstimatedCost

估算代理人洞察费用。

AgentInsightHighlightedTrace

一个高亮的痕迹,为代理人的洞察提供证据。

AgentInsightJsonObject

一个用于Agent Insights负载的JSON对象。

AgentInsightLinkedTrace

一个轻量级的痕迹参考,链接到某个代理的洞察作为支持证据。

AgentInsightMonitor

一个为每个代理设立的代理洞察监控器,负责配置、运行和发现洞察。

AgentInsightMonitorCreate

在为代理创建代理洞察监视器时,接受字段。

AgentInsightMonitorListItem

由列表操作返回的代理洞察监控摘要。

AgentInsightMonitorUpdate

这些字段可以在Agent Insights显示器上更新。

AgentInsightProposedFix

一个建议的修复方法,针对一个代理洞察。

AgentInsightProposedFixChange

一个客户可渲染的修正案。

AgentInsightRecommendedAction

推荐的修复方法,提供代理洞察。

AgentInsightRun

这是一个长期运行的流程,分析一名代理的跟踪并更新该代理的洞察。

AgentInsightRunCreate

创建代理洞察运行时使用的输入。

AgentInsightRunResult

当一次代理洞察运行成功时产生的结果统计数据。

AgentInsightSuspension

为何计划发电被暂停,有结构性原因。

AgentInsightTokenUsage

代理洞察运行时的令牌使用情况。

AgentInsightUpdate

这些字段可以在代理洞察中更新。

AgentInsightsOverview

代理洞察监视器的有效概览。

AgentInsightsOverviewOverride

用户提供的概览立即生效,并为下一代埋下种子。

AgentOptimizationAgentCandidateOutput

由代理优化作业产生的候选输出。

AgentOptimizationBaselineAgentConfiguration

呼叫者提供的基准代理值,无法从目标代理中解析。

AgentOptimizationCandidate

一个由优化作业生成的候选人。

AgentOptimizationCandidateEvaluation

候选人的比较评估摘要。

AgentOptimizationCandidateOutput

基础候选人输出。 作业类型定义了带有自身字段的衍生输出模型。

AgentOptimizationCandidatePromotionInfo

为候选人录制的晋升元数据。

AgentOptimizationCandidateSearchConfiguration

候选人搜索设置。

AgentOptimizationConfiguration

用于优化代理以测量质量的配置。

AgentOptimizationConfigurationBase

类型特定优化配置的基础模型。

AgentOptimizationCostEstimate

预计的经济成本。 仅在至少一个贡献模型拥有定价数据时才会显示。

AgentOptimizationEstimateBand

给出一个低/典型/上限范围,适用于估计数量。 期望值可能是分数的,包括估计的模型调用计数。

AgentOptimizationEstimateInputs

用于估算代理优化作业的输入。

AgentOptimizationEstimateResult

估计代理优化作业时返回结果。

AgentOptimizationEvaluationConfiguration

可重复使用质量测量配置。

AgentOptimizationEvaluationSet

基于优化评估集的判别模型。

AgentOptimizationEvaluator

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

AgentOptimizationFoundryAgentTargetConfiguration

识别拥有被优化配置的Foundry代理。

AgentOptimizationInstructionsMutation

指令变异。

AgentOptimizationJob

代理优化作业资源——一个长期运行的作业,用于对Foundry代理配置进行候选修改。

AgentOptimizationJobLatency

一个优化阶段和模型的平均延迟。

AgentOptimizationJobResult

由代理优化作业产生的部分或终端结果。

AgentOptimizationJobTokenUsage

一个优化阶段和模型的代币使用汇总。

AgentOptimizationModelConfiguration

识别被优化或评估步骤使用的模型。

AgentOptimizationModelMutation

模型突变。

AgentOptimizationMutation

碱基候选突变。

AgentOptimizationPromptCandidateOutput

由提示优化作业产生的候选输出。

AgentOptimizationResultCandidateSummary

由代理优化作业产生的候选人摘要。

AgentOptimizationSkill

这是手动提供的代理优化界面中的一项技能。

AgentOptimizationSkillsMutation

技能变异。

AgentOptimizationSpace

代理属性和可用于代理优化搜索的备选值。

AgentOptimizationStageEstimate

按优化阶段分组的估计值。

AgentOptimizationTargetCompletionDataSource

目标完成优化评估集的基础源。

AgentOptimizationTargetCompletionDatasetReferenceDataSource

引用一个明确版本化的注册Foundry数据集用于目标完成评估。

AgentOptimizationTargetCompletionEvaluationSet

包含独立单回合输入的评估集。

AgentOptimizationTargetCompletionInlineDataSource

在优化请求中直接提供单回合行。

AgentOptimizationTargetCompletionTestCase

在线评估集中的单个项目。

AgentOptimizationTargetConfiguration

优化作业的基础目标配置。

AgentOptimizationToolsMutation

工具变异。

AgentOptimizationUserConversationSimulationDataSource

用户-对话-模拟优化评估集的基础源。

AgentOptimizationUserConversationSimulationDatasetReferenceDataSource

引用一个显式版本化的注册 Foundry 数据集,用于用户对话模拟评估。

AgentOptimizationUserConversationSimulationEvaluationSet

包含模拟对话场景的评估集。

AgentOptimizationUserConversationSimulationInlineDataSource

在优化请求中直接提供 Evals 用户对话模拟测试用例。

AgentReference

模型接口 AgentReference

AgentSessionResource

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

AgentTaxonomyInput

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

AgentVersion

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

AgenticIdentityPreviewCredentials

代理身份凭证定义

AgentsCancelOptimizationJobOptionalParams

可选参数。

AgentsCreateAgentFromManifestOptionalParams

可选参数。

AgentsCreateAgentVersionFromManifestOptionalParams

可选参数。

AgentsCreateOptimizationJobOptionalParams

可选参数。

AgentsCreateOptionalParams

可选参数。

AgentsCreateSessionOptionalParams

可选参数。

AgentsCreateTelephonyBindingOptionalParams

可选参数。

AgentsCreateVersionFromCodeOptionalParams

可选参数。

AgentsCreateVersionOptionalParams

可选参数。

AgentsDeleteOptimizationJobOptionalParams

可选参数。

AgentsDeleteOptionalParams

可选参数。

AgentsDeleteSessionFileOptionalParams

可选参数。

AgentsDeleteSessionOptionalParams

可选参数。

AgentsDeleteTelephonyBindingOptionalParams

可选参数。

AgentsDeleteVersionOptionalParams

可选参数。

AgentsDisableOptionalParams

可选参数。

AgentsDownloadAgentCodeOptionalParams

可选参数。

AgentsDownloadSessionFileOptionalParams

可选参数。

AgentsEnableOptionalParams

可选参数。

AgentsEstimateOptimizationJobOptionalParams

可选参数。

AgentsGetOptimizationCandidateOptionalParams

可选参数。

AgentsGetOptimizationJobOptionalParams

可选参数。

AgentsGetOptionalParams

可选参数。

AgentsGetSessionLogStreamOptionalParams

可选参数。

AgentsGetSessionOptionalParams

可选参数。

AgentsGetTelephonyBindingOptionalParams

可选参数。

AgentsGetVersionOptionalParams

可选参数。

AgentsListOptimizationCandidatesOptionalParams

可选参数。

AgentsListOptimizationJobsOptionalParams

可选参数。

AgentsListOptionalParams

可选参数。

AgentsListSessionFilesOptionalParams

可选参数。

AgentsListSessionsOptionalParams

可选参数。

AgentsListTelephonyBindingsOptionalParams

可选参数。

AgentsListTelephonyCallsOptionalParams

可选参数。

AgentsListVersionsOptionalParams

可选参数。

AgentsOperations

表示代理作的接口。

AgentsPromoteOptimizationCandidateOptionalParams

可选参数。

AgentsStopSessionOptionalParams

可选参数。

AgentsUpdateAgentFromManifestOptionalParams

可选参数。

AgentsUpdateAgentObjectOptionalParams

可选参数。

AgentsUpdateOptionalParams

可选参数。

AgentsUpdateTelephonyBindingOptionalParams

可选参数。

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

连接凭证的基类

BetaAgentInsightMonitorsCancelRunOptionalParams

可选参数。

BetaAgentInsightMonitorsCreateOptionalParams

可选参数。

BetaAgentInsightMonitorsCreateRunOptionalParams

可选参数。

BetaAgentInsightMonitorsDeleteOptionalParams

可选参数。

BetaAgentInsightMonitorsGetInsightOptionalParams

可选参数。

BetaAgentInsightMonitorsGetOptionalParams

可选参数。

BetaAgentInsightMonitorsGetRunOptionalParams

可选参数。

BetaAgentInsightMonitorsListInsightsOptionalParams

可选参数。

BetaAgentInsightMonitorsListOptionalParams

可选参数。

BetaAgentInsightMonitorsListRunsOptionalParams

可选参数。

BetaAgentInsightMonitorsOperations

表示BetaAgentInsightMonitors操作的接口。

BetaAgentInsightMonitorsResetOptionalParams

可选参数。

BetaAgentInsightMonitorsUpdateInsightOptionalParams

可选参数。

BetaAgentInsightMonitorsUpdateOptionalParams

可选参数。

BetaAgentsCreateFromPromptOptionalParams

可选参数。

BetaAgentsOperations

管理代理的运营。

BetaEvaluationTaxonomiesCreateOptionalParams

可选参数。

BetaEvaluationTaxonomiesDeleteOptionalParams

可选参数。

BetaEvaluationTaxonomiesGetOptionalParams

可选参数。

BetaEvaluationTaxonomiesListOptionalParams

可选参数。

BetaEvaluationTaxonomiesOperations

表示BetaEvaluationTaxonomies作的接口。

BetaEvaluationTaxonomiesUpdateOptionalParams

可选参数。

BetaEvaluatorsGetCredentialsOptionalParams

可选参数。

BetaEvaluatorsOperations

Beta评估员运营。

BetaEvaluatorsPendingUploadOptionalParams

可选参数。

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

可选参数。

BetaVoiceAgentsConversationsDeleteOptionalParams

可选参数。

BetaVoiceAgentsConversationsDownloadAudioItemOptionalParams

可选参数。

BetaVoiceAgentsConversationsDownloadAudioOptionalParams

可选参数。

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemOptionalParams

可选参数。

BetaVoiceAgentsConversationsGetAudioItemOptionalParams

可选参数。

BetaVoiceAgentsConversationsGetAudioOptionalParams

可选参数。

BetaVoiceAgentsConversationsGetGeneratedAudioItemOptionalParams

可选参数。

BetaVoiceAgentsConversationsGetItemOptionalParams

可选参数。

BetaVoiceAgentsConversationsGetOptionalParams

可选参数。

BetaVoiceAgentsConversationsGetResponseOptionalParams

可选参数。

BetaVoiceAgentsConversationsListItemsOptionalParams

可选参数。

BetaVoiceAgentsConversationsListOptionalParams

可选参数。

BetaVoiceAgentsConversationsListResponseItemsOptionalParams

可选参数。

BetaVoiceAgentsConversationsListResponsesOptionalParams

可选参数。

BetaVoiceAgentsConversationsOperations

用于管理语音代理对话的运营。

BetaVoiceAgentsOperations

负责语音代理对话和电话管理的运营。

BetaVoiceAgentsTelephonyCancelCallJobOptionalParams

可选参数。

BetaVoiceAgentsTelephonyCreateBindingOptionalParams

可选参数。

BetaVoiceAgentsTelephonyCreateCallJobOptionalParams

可选参数。

BetaVoiceAgentsTelephonyDeleteBindingOptionalParams

可选参数。

BetaVoiceAgentsTelephonyEndCallOptionalParams

可选参数。

BetaVoiceAgentsTelephonyGetBindingOptionalParams

可选参数。

BetaVoiceAgentsTelephonyGetCallJobOptionalParams

可选参数。

BetaVoiceAgentsTelephonyGetCallOptionalParams

可选参数。

BetaVoiceAgentsTelephonyGetTransferTargetsOptionalParams

可选参数。

BetaVoiceAgentsTelephonyListBindingsOptionalParams

可选参数。

BetaVoiceAgentsTelephonyListCallsOptionalParams

可选参数。

BetaVoiceAgentsTelephonyOperations

管理语音代理电话的运营。

BetaVoiceAgentsTelephonyReplaceTransferTargetsOptionalParams

可选参数。

BetaVoiceAgentsTelephonyTransferCallOptionalParams

可选参数。

BetaVoiceAgentsTelephonyUpdateBindingOptionalParams

可选参数。

BingCustomSearchConfiguration

bing自定义搜索配置。

BingCustomSearchPreviewTool

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

BingCustomSearchToolParameters

bing自定义搜索工具参数。

BingGroundingSearchConfiguration

Bing地面的搜索配置

BingGroundingSearchToolParameters

bing地面搜索工具参数。

BingGroundingTool

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

BlobReference

Blob 引用详细信息。

BotServiceAuthorizationScheme

模型接口 BotServiceAuthorizationScheme

BotServiceRbacAuthorizationScheme

模型接口 BotServiceRbacAuthorizationScheme

BotServiceTenantAuthorizationScheme

模型接口 BotServiceTenantAuthorizationScheme

BrowserAutomationPreviewTool

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

BrowserAutomationPreviewToolboxTool

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

BrowserAutomationTool

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

BrowserAutomationToolConnectionParameters

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

BrowserAutomationToolParameters

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

BrowserAutomationToolboxTool

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

CaptureStructuredOutputsTool

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

ChartCoordinate

分析图表的坐标。

ChatCompletionTool

可用于生成响应的函数工具。

ChatSummaryMemoryItem

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

ClusterInsightResult

来自聚类分析的见解。

ClusterTokenUsage

集群分析的令牌使用情况

CodeBasedEvaluatorDefinition

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

CodeConfiguration

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

CodeInterpreterTool

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

CodeInterpreterToolboxTool

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

ComparisonFilter

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

CompoundFilter

使用 and 或 or. 合并多个筛选器。

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。

CreateTeamsPhoneExtensibilityTelephonyBindingRequest

创建 Microsoft Teams 电话 扩展绑定的请求。

CreateTelephonyBindingRequest

创建电话绑定的请求。

CreateTelephonyCallJobRequest

请求创建一个持久的直拨呼叫作业。

CreateTranscriptionResponseJsonUsage

请求的令牌使用统计数据。

CreateTwilioTelephonyBindingRequest

请求制作特威利奥装订。

CronTrigger

基于 Cron 的触发器。

CustomCredential

自定义凭证定义

CustomGrammarFormatParam

由用户定义的语法。

CustomRoutineTrigger

自定义事件例程触发器。

CustomTextFormatParam

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

CustomToolParam

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

CustomToolParamFormat

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

DailyRecurrenceSchedule

每日重复计划。

DataGenerationJob

数据生成职位资源。

DataGenerationJobConfiguration

用于管理数据生成作业的配置。

DataGenerationJobInputs

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

DataGenerationJobOutput

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

DataGenerationJobResult

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

DataGenerationJobSource

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

DataGenerationModelOptions

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

DataGenerationTokenUsage

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

DatasetCredential

表示对 blob 的引用以供使用

DatasetDataGenerationJobOutput

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

DatasetEvaluatorGenerationJobSource

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

DatasetReference

参考版本化的Foundry数据集。

DatasetVersion

DatasetVersion 定义

DatasetsCancelGenerationJobOptionalParams

可选参数。

DatasetsCreateGenerationJobOptionalParams

可选参数。

DatasetsCreateOrUpdateOptionalParams

可选参数。

DatasetsDeleteGenerationJobOptionalParams

可选参数。

DatasetsDeleteOptionalParams

可选参数。

DatasetsGetCredentialsOptionalParams

可选参数。

DatasetsGetGenerationJobOptionalParams

可选参数。

DatasetsGetOptionalParams

可选参数。

DatasetsListGenerationJobsOptionalParams

可选参数。

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

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

EvaluationAzureStandardVoiceModelConfiguration

配置Azure标准神经语音,用于将文本转换为语音,以便通过Voice Live端点进行评估。

EvaluationComparisonInsightRequest

评估比较请求

EvaluationComparisonInsightResult

评估比较的见解。

EvaluationDataGenerationJob

评估数据生成工作资源。

EvaluationDataGenerationJobInputs

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

EvaluationDataGenerationJobOutputConfiguration

评估数据生成作业的数据集输出配置。

EvaluationModelConfiguration

配置模拟用户的模型。 该模型与被 target评估的模型是分开的。

EvaluationResultSample

评估结果中的示例。

EvaluationRule

评估规则模型。

EvaluationRuleAction

评估行动模型。

EvaluationRuleFilter

评估筛选器模型。

EvaluationRulesCreateOrUpdateOptionalParams

可选参数。

EvaluationRulesDeleteOptionalParams

可选参数。

EvaluationRulesGetOptionalParams

可选参数。

EvaluationRulesListOptionalParams

可选参数。

EvaluationRulesOperations

表示 EvaluationRules作的接口。

EvaluationRunClusterInsightRequest

对一组评估结果的见解

EvaluationRunClusterInsightResult

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

EvaluationScheduleTask

计划的评估任务。

EvaluationTarget

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

EvaluationTaxonomy

评估分类定义

EvaluationTaxonomyInput

评估分类的输入配置。

EvaluationVoiceModelConfiguration

语音配置用于将文本转换为语音,以便通过Voice Live端点进行评估。

EvaluatorCredentialRequest

申请评估员资格的机构

EvaluatorDefinition

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

EvaluatorGenerationArtifacts

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

EvaluatorGenerationInputs

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

EvaluatorGenerationJob

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

EvaluatorGenerationJobSource

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

EvaluatorGenerationTokenUsage

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

EvaluatorMetric

评估器指标

EvaluatorVersion

评估器定义

EvaluatorsCancelGenerationJobOptionalParams

可选参数。

EvaluatorsCreateGenerationJobOptionalParams

可选参数。

EvaluatorsCreateVersionOptionalParams

可选参数。

EvaluatorsDeleteGenerationJobOptionalParams

可选参数。

EvaluatorsDeleteVersionOptionalParams

可选参数。

EvaluatorsGetGenerationJobOptionalParams

可选参数。

EvaluatorsGetVersionOptionalParams

可选参数。

EvaluatorsListGenerationJobsOptionalParams

可选参数。

EvaluatorsListOptionalParams

可选参数。

EvaluatorsListVersionsOptionalParams

可选参数。

EvaluatorsOperations

评估员运营。

EvaluatorsUpdateVersionOptionalParams

可选参数。

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

这是与模型相关的警告。

FunctionObject

model interface FunctionObject

FunctionParameters

函数接受的参数,被描述为 JSON 架构对象。 请参见 指南以获取示例,并查看 JSON Schema 参考以了解有关格式的文档。 省略 parameters 会定义具有空参数列表的函数。

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 追踪。 每个客户端实例都维护自己的独立追踪配置。

GenerateVoiceAgentRequest

生成语音代理的输入。 只有 kind 和 name ,总是必须的。 创作服务将这些输入扩展为完整且可 VoiceAgentDefinition编辑的 ,然后 POST /agents通过 创建。 生成 instructions 的设置和音频/语音设置作为独立字段存储在生成的代理定义中,呼叫者可以通过标准代理版本控制编辑或覆盖任意字段。

GetMicrosoft365PackageOptionalParams

可选参数。

GetMicrosoft365PublishDefaultsOptionalParams

可选参数。

GitHubCopilotHarness

(预览)保留了由 GitHub Copilot 管理的传统接口以保证兼容性。 用于 MicrosoftCopilotHarness 新的提示代理。

GitHubCopilotToolsetConfig

保留了针对每个工具的旧有启用覆盖以保证兼容性。 用于 MicrosoftCopilotToolsetConfig 新的集成。

GitHubCopilotToolsetDefaultConfig

保留了传统的默认启用设置以保证兼容性。 用于 MicrosoftCopilotToolsetDefaultConfig 新的集成。

GitHubCopilotToolsetPreview

(预览)保留了原有的 GitHub Copilot 工具集以保证兼容性。 用于 MicrosoftCopilotToolsetPreview 新的集成。

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中的一个。

JobOperationState

操作状态,用于创建作业资源的长期运行操作。

自定义:SDK 改进:发射的轮询器解析到作业的终端 result 有效载荷,该有效载荷不携带标识符; jobId 保持创建作业的可达性。

LocalShellToolParam

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

LocalSkillParam

model interface LocalSkillParam

LogProbProperties

一个对数概率对象。

LoraConfig

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

MCPListToolsTool

MCP 服务器上可用的工具。

MCPListToolsToolAnnotations

模型接口 MCPListToolsToolAnnotations

MCPListToolsToolInputSchema

模型接口 MCPListToolsToolInputSchema

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

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

Metadata

按 16 个成组的可附加到对象的键值对。 这可用于以结构化格式存储有关对象的其他信息,以及通过 API 或仪表板查询对象。 键是最大长度为 64 个字符的字符串。 值为最大长度为 512 个字符的字符串。

Microsoft365PermissionScopes

一组委托的权限范围,向单一资源应用程序请求。

Microsoft365PublishDefaults

用于预填充 Microsoft 365 发布请求的默认值和先前发布的值,用于 Foundry 代理。

Microsoft365PublishResponse

发布代理到Microsoft 365 / Microsoft Teams的响应。

MicrosoftCopilotHarness

(预览)Microsoft Copilot 负责即时代理的管理框架。

MicrosoftCopilotToolsetConfig

针对 Microsoft Copilot 内置工具的启用覆盖。

MicrosoftCopilotToolsetDefaultConfig

Microsoft Copilot 内置工具的默认启用设置。

MicrosoftCopilotToolsetPreview

(预览)Microsoft Copilot 内置工具的配置覆盖。

MicrosoftFabricPreviewTool

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

MisalignmentErrorDetailsResource

动作细节被屏蔽,因为可能与用户意图不符。

MisalignmentSteer

在某个动作被阻止后继续的公开指令。

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工具。

OptimizationContext

类型优化上下文的基础模型。

OtlpTelemetryEndpoint

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

PageSettings

跟踪分页迭代设置的接口

PagedAsyncIterableIterator

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

PendingUploadRequest

表示对待上载的请求。

PendingUploadResponse

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

PickPropertiesVoiceAgentAudioConfig

选择房产的模板。

ProceduralMemoryItem

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

ProgrammaticToolCallingParam

model interface ProgrammaticToolCallingParam

PromptAgentDefinition

提示代理定义

PromptAgentDefinitionTextOptions

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

PromptBasedEvaluatorDefinition

基于提示的评估器

PromptDataGenerationJobSource

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

PromptEvaluatorGenerationJobSource

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

PromptOptimizationConfiguration

用于一次提示变换的配置,无需比较评估。

ProtocolConfiguration

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

ProtocolVersionRecord

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

PstnTelephonyTransferDestination

电话传输目标的PSTN目的地。

PublishToMicrosoft365OptionalParams

可选参数。

RaiConfig

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

RaiInvocationModeration

声明请求/响应文本所在位置,以便内容安全保护栏能够提取。

RaiSseTextSelector

一个 SSE 事件类型转文本字段选择器,用于流式调用输出。

RankingOptions

模型界面 RankingOptions

RealtimeAudioFormats

模型接口 RealtimeAudioFormats

RealtimeAudioFormatsAudioPcm

模型接口 实时音频格式音频 PCM

RealtimeAudioFormatsAudioPcma

模型接口 实时音频格式音频 Pcma

RealtimeAudioFormatsAudioPcmu

模型接口 RealtimeAudioFormatsAudioPcmu

RealtimeClientEvent

一个实时客户端事件。

RealtimeClientEventConversationItemCreate

在对话上下文中添加一个新的项目,包括消息、函数调用和函数调用响应。 该事件既可用于填充对话的“历史”,也可以在直播中添加新项目,但目前的限制是无法填充助理音频消息。 如果成功,服务器将通过事件进行响应 conversation.item.created ,否则 error 会发送事件。

RealtimeClientEventConversationItemDelete

当你想从对话记录中删除任何内容时,发送此事件。 服务器会以事件回应 conversation.item.deleted ,除非该项目不存在于对话历史中,此时服务器会以错误回应。

RealtimeClientEventConversationItemRetrieve

当你想获取服务器对对话历史中特定项目的表示时,发送该事件。 例如,这对于在降噪和VAD后检查用户音频非常有用。 服务器会以事件回应 conversation.item.retrieved ,除非该项目不存在于对话历史中,此时服务器会以错误回应。

RealtimeClientEventConversationItemTruncate

发送此事件以截断之前助手消息的音频。 服务器产生的音频速度比实时快,因此当用户中断以截断已发送到客户端但尚未播放的音频时,这个事件非常有用。 这将使服务器对音频的理解与客户端的回放同步。 截断音频会删除服务器端文本文字记录,以确保上下文中没有用户未听到的文本。 如果成功,服务器将以事件响应 conversation.item.truncated 。

RealtimeClientEventInputAudioBufferAppend

发送此事件,将音频字节附加到输入音频缓冲区。 音频缓冲区是一个可以写入和稍后提交的临时存储。 “提交”会从缓冲区内容在对话历史中创建新的用户消息项,并清除缓冲区。 当缓冲区提交时,输入音频转录(如果启用)将被生成。 如果启用了VAD,音频缓冲区用于检测语音,服务器将决定何时提交。 当服务器VAD被禁用时,你必须手动提交音频缓冲区。 输入音频降噪在写入音频缓冲区时进行操作。 客户端可以选择每个事件中放入多少音频,最多可达15 MiB,例如从客户端流式传输较小的音频块可能使VAD响应更快。 与大多数客户端事件不同,服务器不会对该事件发送确认回复。

RealtimeClientEventInputAudioBufferClear

发送此事件以清除缓冲区中的音频字节。 服务器会通过事件进行响应 input_audio_buffer.cleared 。

RealtimeClientEventInputAudioBufferCommit

发送此事件提交用户输入音频缓冲区,这将在对话中创建一个新的用户消息项。 如果输入音频缓冲区为空,该事件将产生错误。 在服务器VAD模式下,客户端无需发送该事件,服务器会自动提交音频缓冲区。 提交输入音频缓冲区会触发输入音频转录(如果在会话配置中启用),但不会从模型中生成响应。 服务器会通过事件进行响应 input_audio_buffer.committed 。

RealtimeClientEventOutputAudioBufferClear

仅限WebRTC/SIP: 发射以切断当前音频响应。 这会触发服务器停止生成音频并发出 output_audio_buffer.cleared 事件。 此事件之前应是 response.cancel 客户端事件,以停止生成当前响应。 了解详细信息。

RealtimeClientEventResponseCancel

发送此事件以取消正在进行的回复。 服务器将使用状态为 <a0/a0> 的事件进行响应。 如果没有取消的响应,服务器将以错误回应。 即使没有响应,也可以安全地拨打 response.cancel ,错误会被返回,但会话不会受到影响。

RealtimeClientEventResponseCreate

该事件指示服务器创建响应,即触发模型推理。 在服务器VAD模式下,服务器会自动生成响应。 响应至少包含一个项目,可能包含两个,此时第二个项目将是函数调用。 这些项目默认会附加到对话历史中。 服务器会通过事件、 response.created 物品和内容创建事件,最后 response.done 通过事件表示响应已完成。 该 response.create 事件包含如 instructions 和 tools的推理配置。 如果这些设置被设置,它们将覆盖会话对该响应的配置。 响应可以在默认会话的带外生成,这意味着它们可以有任意输入,并且可以关闭写入对话的输出。 一次只能写入一个响应给默认会话,但除此之外可以并行创建多个响应。 字段 metadata 是区分多个同时响应的好方法。 客户端可以设置为 conversation , none 创建不写入默认对话的响应。 可以通过字段 input 提供任意输入,字段是一个数组,接受原始项目和对现有项目的引用。

RealtimeConversationItem

实时对话中的单个项。

RealtimeConversationItemFunctionCall

实时对话中的函数调用项。

RealtimeConversationItemFunctionCallOutput

一个函数调用实时对话中的输出项。

RealtimeConversationItemMessage

模型接口 RealtimeConversationItemMessage

RealtimeConversationItemMessageAssistant

实时对话中的助理消息项目。

RealtimeConversationItemMessageAssistantContent

模型接口 RealtimeConversationItemMessageAssistantContent

RealtimeConversationItemMessageSystem

实时对话中的系统消息可以用来为模型提供额外的上下文或指令。 这与对话开始时提供的指令提示类似但不同,因为系统消息可以在对话的任何时刻添加。 对于对话行为的重大变化,使用指令;对于较小的更新(例如“用户现在正在询问另一个话题”),则使用系统消息。

RealtimeConversationItemMessageSystemContent

模型接口 实时对话 物品 消息系统内容

RealtimeConversationItemMessageUser

实时对话中的用户消息项。

RealtimeConversationItemMessageUserContent

模型接口 RealtimeConversationItemMessageUserContent

RealtimeFunctionTool

模型接口 RealtimeFunctionTool

RealtimeMCPApprovalRequest

一个实时请求人类批准工具调用的项目。

RealtimeMCPApprovalResponse

一个实时响应MCP审批请求的项目。

RealtimeMCPError

模型接口 RealtimeMCPError

RealtimeMCPHttpError

模型接口 RealtimeMCPHttpError

RealtimeMCPListTools

一个实时的物品列表工具,存在于MCP服务器上。

RealtimeMCPProtocolError

模型接口 RealtimeMCPProtocolError

RealtimeMCPToolCall

一个表示MCP服务器上工具调用的实时项。

RealtimeMCPToolExecutionError

model interface RealtimeMCPToolExecutionError

RealtimeReasoning

为具备推理能力的实时模型配置,如 gpt-realtime-2。

RealtimeResponseStatusDetails

模型接口 RealtimeResponseStatusDetails(实时响应状态详情)

RealtimeResponseStatusDetailsError

模型接口 RealtimeResponseStatusDetailsError(模型接口)

RealtimeResponseUsage

模型接口 实时响应使用

RealtimeResponseUsageInputTokenDetails

model interface RealtimeResponseUsageInputTokenDetails

RealtimeResponseUsageInputTokenDetailsCachedTokensDetails

model interface RealtimeResponseUsageInputTokenDetails缓存TokensDetails。

RealtimeResponseUsageOutputTokenDetails

model interface RealtimeResponseUsageOutputTokenDetails

RealtimeServerEvent

一个实时服务器事件。

RealtimeServerEventConversationItemAdded

当物品被添加到默认对话时,服务器会发送。 这种情况可能发生在几种情况下:

  • 当客户发送事件 conversation.item.create 时。
  • 当输入音频缓冲区提交时, 在这种情况下,该项目将是包含缓冲区音频的用户消息。
  • 当模型生成响应时, 在这种情况下 conversation.item.added ,事件会在模型开始生成特定物品时发送,因此它还没有任何内容(并且 status 会有 in_progress)。 事件将包含该项目的完整内容(除非模型正在生成响应),音频数据则可在必要时通过 conversation.item.retrieve 事件单独检索。
RealtimeServerEventConversationItemCreated

当创建对话项目时返回。 有多种方案可生成此事件:

  • 服务器正在生成一个响应,如果成功,将产生一个或两个物品,这些物品的类型 message (角色 assistant)或类型 function_call。
  • 输入音频缓冲区已被提交,无论是客户端还是服务器(模式)。server_vad 服务器会将输入音频缓冲区的内容添加到新的用户消息 Item 中。
  • 客户发送了一个 conversation.item.create 事件,将新项目添加到对话中。
RealtimeServerEventConversationItemDeleted

当客户端删除对话中的某个项目并触发 conversation.item.delete 事件时,返回。 此事件用于将服务器的会话历史记录与客户端视图的了解同步。

RealtimeServerEventConversationItemDone

当对话项目最终确定时返回。 活动将包含物品的完整内容,音频数据可在必要时通过 conversation.item.retrieve 事件单独检索。

RealtimeServerEventConversationItemInputAudioTranscriptionCompleted

该事件是为用户音频写入的用户音频缓冲区的音频转录输出。 当客户端或服务器提交输入音频缓冲区时(在启用 VAD 的情况下),将开始转录。 转录与响应创建异步运行,因此该事件可能发生在响应事件之前或之后。 实时API模型原生接受音频,因此输入转录是一个独立过程,运行在另一个自动语音识别(ASR)模型上。 该记录可能与模型的解释有所不同,应视为粗略参考。

RealtimeServerEventConversationItemInputAudioTranscriptionDelta

当输入音频转录内容部分的文本值通过增量转录结果更新时返回。

RealtimeServerEventConversationItemInputAudioTranscriptionFailed

当输入音频转录配置完成,且用户消息的转录请求失败时返回。 这些事件与其他事件分开 error ,以便客户端识别相关物品。

RealtimeServerEventConversationItemInputAudioTranscriptionFailedError

model interface RealtimeServerEventConversationItemInputAudioTranscriptionFailedError

RealtimeServerEventConversationItemInputAudioTranscriptionSegment

当识别到输入音频转录片段时返回。

RealtimeServerEventConversationItemRetrieved

当对话项目被检索时返回。conversation.item.retrieve 这作为获取服务器对某项表示的方式提供,例如通过降噪和VAD访问后处理后的音频数据。 它包含了物品的完整内容,包括音频数据。

RealtimeServerEventConversationItemTruncated

当客户端 conversation.item.truncate 用事件截断了之前的助理音频消息项时,返回该项。 该事件用于同步服务器对音频的理解与客户端的回放。 此作会截断音频并删除服务器端文本文字记录,以确保上下文中没有用户未听到的文本。

RealtimeServerEventError

当发生错误时返回,错误可能是客户端或服务器问题。 大多数错误是可恢复的,会话会保持开放,我们建议实现者默认监控并记录错误信息。

RealtimeServerEventErrorError

model interface RealtimeServerEventErrorError

RealtimeServerEventInputAudioBufferCleared

当客户端 input_audio_buffer.clear 通过事件清除输入音频缓冲区时返回。

RealtimeServerEventInputAudioBufferCommitted

当输入音频缓冲区提交时返回,无论是客户端还是服务器VAD模式下自动提交。 属性 item_id 是将要创建的用户消息项的ID,因此 conversation.item.created 事件也会发送给客户端。

RealtimeServerEventInputAudioBufferSpeechStarted

服务器在处于 server_vad 模式时发送,表示音频缓冲区中检测到语音。 只要音频加入缓冲区,就会发生这种情况(除非已经检测到语音)。 客户端可能想利用此事件中断音频播放或向用户提供视觉反馈。 客户应预期在语言停止时接收 input_audio_buffer.speech_stopped 到一个事件。 该 item_id 属性是用户消息项的ID,当语音停止时将被创建,并且也会包含 input_audio_buffer.speech_stopped 在事件中(除非客户端在VAD激活时手动提交音频缓冲区)。

RealtimeServerEventInputAudioBufferSpeechStopped

当服务器检测到音频缓冲区中的语音结束时,返回为 server_vad 模式。 服务器还会发送 conversation.item.created 一个包含从音频缓冲区创建的用户消息项的事件。

RealtimeServerEventInputAudioBufferTimeoutTriggered

当服务器VAD超时触发输入音频缓冲区时返回。 这在会话设置中配置idle_timeout_msturn_detection,表示在配置的持续时间内没有检测到任何语音。 最后一个模型响应和触发时间之后的音频段由audio_start_ms和audio_end_ms字段表示,作为从音频写入到输入音频缓冲区起点的偏移量。 这意味着它会划定静音的音频段,起始和结束值之间的差值大致匹配配置的超时。 空音频将作为一个项目提交到对话 input_audio 中(会有一个 input_audio_buffer.committed 事件),并生成一个模型响应。 可能有些语音没有触发VAD,但模型仍能检测到,因此模型可能会回应与对话相关的内容或继续说话的提示。

RealtimeServerEventMCPListToolsCompleted

当商品的 MCP 工具已完成时,会被退回。

RealtimeServerEventMCPListToolsFailed

当商品上架MCP工具失败时,会被退回。

RealtimeServerEventMCPListToolsInProgress

当某项的 MCP 工具列表正在处理时返回。

RealtimeServerEventOutputAudioBufferCleared

仅 WebRTC/SIP: 当输出音频缓冲区清除时发出。 当用户中断(input_audio_buffer.speech_started)或客户端发出 output_audio_buffer.clear 事件以手动切断当前音频响应时,就会在 VAD 模式下发生这种情况。 了解详细信息。

RealtimeServerEventRateLimitsUpdated

在回复开头发出,以表示更新的速率限制。 当响应创建时,会有部分令牌被“保留”给输出令牌,这里显示的速率限制反映了该预留,响应完成后会相应调整。

RealtimeServerEventRateLimitsUpdatedRateLimits

model interface RealtimeServerEventRateLimitsUpdatedRateLimits

RealtimeServerEventResponseAudioDelta

模型生成音频更新后返回。

RealtimeServerEventResponseAudioDone

模型生成音频完成后返回。 当响应被中断、不完整或取消时也会发出。

RealtimeServerEventResponseAudioTranscriptDelta

模型生成的音频输出转录更新后返回。

RealtimeServerEventResponseAudioTranscriptDone

当模型生成的音频输出转录完成后返回。 当响应被中断、不完整或取消时也会发出。

RealtimeServerEventResponseContentPartAdded

当在响应生成过程中向助理消息项中添加新内容部分时返回。

RealtimeServerEventResponseContentPartAddedPart

model interface RealtimeServerEventResponseContentPartAddedPart

RealtimeServerEventResponseContentPartDone

当内容部分在助理消息项目中完成流式传输时,会返回。 当响应被中断、不完整或取消时也会发出。

RealtimeServerEventResponseContentPartDonePart

model interface RealtimeServerEventResponseContentPartDonePart

RealtimeServerEventResponseCreated

当新回复创建时会返回。 响应创建的第一个事件,响应处于初始状态。in_progress

RealtimeServerEventResponseDone

回复完成流媒体后返回。 无论最终状态如何,都会被释放。 事件中包含的 response.done 响应对象会包含所有输出的 Items,但会省略原始音频数据。 客户端应检查 status 响应字段,以确定是否成功(completed)或是否存在其他结果: cancelled、 failed、或 incomplete。 响应将包含响应过程中生成的所有输出项,但不包括任何音频内容。

RealtimeServerEventResponseFunctionCallArgumentsDelta

当模型生成函数调用参数更新时返回。

RealtimeServerEventResponseFunctionCallArgumentsDone

当模型生成函数调用参数流式传输完成后返回。 当响应被中断、不完整或取消时也会发出。

RealtimeServerEventResponseMCPCallArgumentsDelta

当响应生成过程中更新MCP工具调用参数时返回。

RealtimeServerEventResponseMCPCallArgumentsDone

当响应生成过程中MCP工具调用参数最终确定时返回。

RealtimeServerEventResponseMCPCallCompleted

当MCP工具调用成功完成后返回。

RealtimeServerEventResponseMCPCallFailed

当MCP工具调用失败时返回。

RealtimeServerEventResponseMCPCallInProgress

当MCP工具调用开始并正在进行时返回。

RealtimeServerEventResponseOutputItemAdded

在响应生成过程中创建新物品时返回。

RealtimeServerEventResponseOutputItemDone

当物品完成流式传输后返回。 当响应被中断、不完整或取消时也会发出。

RealtimeServerEventResponseTextDelta

当“output_text”内容部分的文本值更新时返回。

RealtimeServerEventResponseTextDone

当“output_text”内容部分的文本值流式传输完成后返回。 当响应被中断、不完整或取消时也会发出。

RealtimeServerEventSessionCreated

会话创建时返回。 当建立新连接作为第一个服务器事件时,会自动发出。 该事件将包含默认的会话配置。

RealtimeServerEventSessionUpdated

当会话更新事件 session.update 时返回,除非出现错误。

Reasoning

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

RecurrenceSchedule

定期计划模型。

RecurrenceTrigger

基于重复的触发器。

RedTeam

红队详情。

RedTeamTargetConfig

目标配置的抽象类。

ReinforcementFineTuningDataGenerationJob

强化、微调数据生成、作业资源。 这是一项预览功能。

ReinforcementFineTuningDataGenerationJobInputs

呼叫者提供的输入,用于强化微调数据生成作业。 这是一项预览功能。

ReinforcementFineTuningDataGenerationJobOutputConfiguration

强化微调数据生成作业的文件输出配置。 这是一项预览功能。

ReminderPreviewToolboxTool

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

ResponseUsageInputTokensDetails

model interface ResponseUsageInputTokensDetails

ResponseUsageOutputTokensDetails

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

ResponsesProtocolConfiguration

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

Routine

服务返回的常规定义。

RoutineAction

例行动作的基础模型。

RoutineAuthorization

可选的常规调度授权配置。

RoutineDispatchPayload

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

RoutineRun

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

RoutineTrigger

例行触发器的基础模型。

RubricBasedEvaluatorDefinition

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

RubricGenerationInputQualityWarning

在评分标准评估器生成过程中,当已解决的输入技术有效但可能过于薄弱,无法生成高质量评分标准时,生成的非致命性建议。 只读;服务生成。 继续使用终端EvaluatorGenerationJob。

RunOperationState

操作状态,用于创建运行资源的长期运行操作。

自定义:SDK 改进:发射的轮询器解析到运行的终端 result 有效载荷,该负载不携带标识符; runId 保持创建的运行可访问性。

SASTokenCredentials

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

SasCredential

SAS 凭证定义

Schedule

计划模型。

ScheduleRoutineTrigger

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

ScheduleRun

计划运行模型。

ScheduleTask

计划任务模型。

SessionConfiguration

会话默认值适用于为托管代理版本创建的会话。

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 工具的输入定义信息。

ShellToolboxTool

一个存放在工具箱里的壳体工具。 该模型是对工具箱配置的加法,不修改OpenAI工具合同或现有工具箱工具定义。

SimpleQnADataGenerationJobConfiguration

数据生成作业的配置,SimpleQnA 类型。

SimulationSeedDataGenerationJobConfiguration

任务生成数据生成作业的配置。 可配合多回合评估场景以及提示词、文件或代理源使用。 生成的数据集行包括诸 id如 、 category、 test_case_description和 desired_num_turns等字段。

SipTelephonyTransferDestination

电话传输目标的SIP目的地。

Skill

一个技能资源。

SkillInlineContent

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

SkillReference

(预览)这是对一个版本化铸造厂技能的致敬。

SkillReferenceParam

model interface SkillReferenceParam

SkillVersion

某种技能的具体版本。

SpecificApplyPatchParam

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

SpecificFunctionShellParam

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

SpecificProgrammaticToolCallingParam

model interface SpecificProgrammaticToolCallingParam

SteeringPromptOptimizationContext

为实现理想优化提供自然语言指导。

StructuredInputDefinition

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

StructuredOutputDefinition

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

SupervisedFineTuningDataGenerationJob

监督微调数据生成作业资源。 这是一项预览功能。

SupervisedFineTuningDataGenerationJobInputs

呼叫者提供的输入,用于监督式微调数据生成作业。 这是一项预览功能。

SupervisedFineTuningDataGenerationJobOutputConfiguration

监督式微调数据生成作业的文件输出配置。 这是一项预览功能。

TaxonomyCategory

分类类别定义。

TaxonomySubCategory

分类学子类别定义。

TeamsPhoneExtensibilityTelephonyBinding

一个由语音代理拥有的 Microsoft Teams 电话 扩展绑定。

TeamsPhoneExtensibilityTelephonyBindingListItem

Microsoft Teams 电话 扩展绑定在列表中返回,包括其实体标签。

TeamsTelephonyTransferDestination

Microsoft Teams 的电话转移目标目的地。

TelemetryConfig

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

TelemetryEndpoint

遥测导出端点配置。

TelemetryEndpointAuth

遥测终端的认证配置。

TelemetryOperations

表示遥测作的接口

TelephonyBinding

一个由语音代理人拥有的电话装订器。

TelephonyBindingListItem

电话绑定在列表中返回,包括其实体标签。

TelephonyCallJob

持久的直接或活动创建的外呼意向。

TelephonyCallJobCancellation

一个外呼任务的取消请求被记录。

TelephonyCallJobSchedule

直接外呼调用的可选执行窗口。

TelephonyCallLifecycleEvent

一个电话通话生命周期中的有界持久观察。

TelephonyCallRecord

针对持久的语音代理来电进行详细诊断。

TelephonyCallSummary

一段持久的语音代理来电摘要。

TelephonyCallTiming

详细的与提供商中立的来电电话时间安排。

TelephonyCallTrace

从持久电话通话记录到面向客户的Foundry跟踪的相关性。

TelephonyOutboundDestination

外拨电话的目的地。

TelephonyOutboundFixedIntervalRetryPolicy

一个带有固定间隔的重试策略。

TelephonyOutboundRetryPolicy

一次持久外呼意图的重试政策。 max_attempts 包括第一次尝试。 策略特定的设置由派生的策略定义。

TelephonyTransferDestination

电话转接目标的目的地。

TelephonyTransferTarget

语音代理可以转接电话的指定目的地。

TelephonyTransferTargets

电话传输目标配置为一个语音代理。

TextResponseFormat

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

TextResponseFormatConfiguration

生成文本回复格式的基础配置。

TextResponseFormatConfigurationResponseFormatJsonObject

将生成的响应配置为使用 JSON 对象格式。

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

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

ToolSearchToolboxTool

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

ToolUseFineTuningDataGenerationJobConfiguration

ToolUse 类型的数据生成作业配置。 这是一个仅用于微调场景的预览功能。

ToolboxObject

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

ToolboxPolicies

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

ToolboxSearchPreviewToolboxTool

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

ToolboxShellContainerAutoEnvironment

一个自动配置的容器环境,用于存储在工具箱中的壳级工具。

ToolboxShellContainerReferenceEnvironment

一个存储在工具箱中的现有容器环境,用于 shell 工具。

ToolboxShellEnvironment

一个存储在工具箱中的壳级工具执行环境。 该环境模型的范围是工具箱配置,不修改 OpenAI 壳层环境合同。

ToolboxShellNetworkPolicy

自动配置工具箱壳容器的网络访问策略。

ToolboxShellNetworkPolicyDisabled

一个网络策略,禁用来自工具箱壳容器的出站访问。

ToolboxSkill

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

ToolboxSkillReference

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

ToolboxTool

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

ToolboxVersionObject

一个特定版本的工具箱。

ToolboxVersions

与工具箱相关的版本。

ToolboxesCreateVersionOptionalParams

可选参数。

ToolboxesDeleteOptionalParams

可选参数。

ToolboxesDeleteVersionOptionalParams

可选参数。

ToolboxesGetOptionalParams

可选参数。

ToolboxesGetVersionOptionalParams

可选参数。

ToolboxesInvokeLatestToolboxMcpOptionalParams

可选参数。

ToolboxesListOptionalParams

可选参数。

ToolboxesListVersionsOptionalParams

可选参数。

ToolboxesOperations

表示工具箱操作的接口。

ToolboxesUpdateOptionalParams

可选参数。

TracesDataGenerationJobConfiguration

带有 Traces 类型的数据生成作业配置。

TracesDataGenerationJobSource

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

TracesEvaluatorGenerationJobSource

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

TranscriptTextUsageDuration

按音频输入时长计费的型号使用统计数据。

TranscriptTextUsageTokens

按代币使用量计费的模型使用统计数据。

TranscriptTextUsageTokensInputTokenDetails

model interface TranscriptTextUsageTokensInputTokenDetails

TranscriptionLanguage

一种在转录音频中检测到的语言。

Trigger

计划触发器的基本模型。

TwilioTelephonyBinding

一本由配音代理拥有的Twilio装订。

TwilioTelephonyBindingListItem

Twilio 绑定在列表中返回,包括其实体标签。

UpdateModelVersionRequest

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

UpdateTelephonyBindingRequest

请求更新现有的电话绑定。 每个属性都是可选的,绑定的提供者是不可变的。

UpdateToolboxRequest

model interface UpdateToolboxRequest

UserConversationSimulationAudioEffectsConfiguration

配置应用于模拟对话音频的效果。

UserConversationSimulationConfiguration

配置对话的数量、时长、音频效果和模拟用户行为。

UserConversationSimulationDefaultInterruptionConfiguration

配置模拟用户的默认中断行为。

UserConversationSimulationInterruptionConfiguration

模拟用户中断行为的配置。

UserConversationSimulationTestCase

定义了一个测试场景。 这里指定的仿真配置属性覆盖了相应的数据源默认值。

UserConversationSimulationUserBehaviorConfiguration

为模拟用户配置对话行为。

UserProfileMemoryItem

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

VersionIndicator

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

VersionRefIndicator

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

VersionSelectionRule

model interface VersionSelectionRule

VersionSelector

模型接口版本选择器

VoiceAgentAnimationConfig

语音代理会话的动画设置。

VoiceAgentAudioConfig

语音代理的音频配置。 这些值是会话默认值,连接时可能会被覆盖。

VoiceAgentAudioInputConfig

输入语音代理的音频配置。

VoiceAgentAudioOutputConfig

语音代理的输出音频配置。 提供者专用字段由以下 voice_type方式选择:

  • openai:voice 和 speed。
  • azure-standard: voice, voice_locale, speed, voice_temperaturecustom_lexicon_url, custom_text_normalization_url, prefer_locales。volumestylepitch
  • azure-custom:除 style,custom_voice_endpoint_id外加 外的所有azure-standard域。
  • azure-personal:除 style,personal_voice_model外加 外的所有azure-standard域。
  • avatar-voice-sync:除 和 之外的所有azure-standard字段 ,加personal_voice_model;声音名称源自化身。stylevoice
  • azure-realtime-native:voice 和 speed。 format 适用于 output_audio_timestamp_types 所有声部类型。
VoiceAgentAvatarConfig

语音代理的化身配置。 这些值是会话默认值,连接时可能会被覆盖。

VoiceAgentAvatarIceServer

一台用于虚拟化身WebRTC谈判的ICE服务器。

VoiceAgentAvatarScene

头像位置和动作设置。

VoiceAgentAvatarVideoBackground

头像视频背景。

VoiceAgentAvatarVideoCrop

矩形裁剪应用于头像视频。

VoiceAgentAvatarVideoParams

Avatar视频编码器和演示设置。

VoiceAgentAvatarVideoResolution

头像视频分辨率。

VoiceAgentAzureSemanticVadEnTurnDetection

英文优化的 Azure 语义语音活动检测。

VoiceAgentAzureSemanticVadMultilingualTurnDetection

多语言Azure语义语音活动检测。

VoiceAgentAzureSemanticVadTurnDetection

Azure语义语音活动检测。

VoiceAgentCancelResponseOptions

取消回复的选项。

VoiceAgentClientEventRtcCallSdpCreate

rtc.call.sdp.create客户端事件:以SDP报价开始WebRTC信令。

VoiceAgentClientEventSessionAvatarConnect

session.avatar.connect客户事件。

VoiceAgentClientEventSessionUpdate

session.update客户事件。

VoiceAgentCloseResult

语音代理连接关闭时提供结果。

VoiceAgentConnection

一个连接的双向语音代理流。

支持服务器 for await 事件的一次迭代;第二次尝试则丢弃。 提前退出环路(break或 return环体未被捕捉的错误)会作为副作用关闭连接。 未识别的服务器事件类型以 VoiceAgentUnknownEvent 形式传递,且不会中断流。 畸形事件仍然会因协议错误而失败。

VoiceAgentDefinition

语音代理的定义。 其配置(模型、说明、音频、工具及可选头像)驱动了受管语音转语音体验。 通过 建立实时语音会话 GET /agents/{agent_name}/endpoint/protocols/voice。 每次创建或更新都会产生一个新的不可变版本。

VoiceAgentEchoCancellation

服务器端输入音频的回声消除设置。

VoiceAgentEndConversationSystemTool

一个服务管理控制,结束当前对话。

VoiceAgentEndOfUtteranceDetection

语义语句尾检测配置。

VoiceAgentEventOptions

由代表调用者构建协议事件的操作共享的选项。

VoiceAgentFunctionTool

客户端执行的原生函数工具。

VoiceAgentGreetingConfig

语音代理的会话启动问候配置。

VoiceAgentInputTranscription

输入音频转录设置,包括转录模型、自定义语音部署和短语提示。 当 model 时 ,转录仅支持级联文本模型对话(不支持实时语音转语音模型),需要非空项languageen-US ,如(支持逗号分隔位置),支持 custom_speech、 和 phrase_listprofanity_filter。azure-speech-streaming

VoiceAgentInterimResponseConfig

由临时响应配置共享的场。

VoiceAgentLlmGeneratedGreetingConfig

这是会话模型根据一个有范围的开场回合提示创作的问候语。

VoiceAgentLlmInterimResponseConfig

由语言模型生成的临时反应。

VoiceAgentMcpTool

语音代理可用的MCP工具。 服务器端点使用 server_url;不支持连接器和隧道标识符。

VoiceAgentNoiseReduction

输入音频降噪配置。

VoiceAgentRealtimeClientConnectOptions

连接实时客户端与语音代理的选项。

VoiceAgentRealtimeClientOptions

语音代理实时客户端的选项。

VoiceAgentRealtimeResponse

语音代理服务在两场response.createdresponse.done事件中均有实时响应。

VoiceAgentResponseCreateParams

语音代理 response.create 事件接受的参数。

VoiceAgentResponseOptions

创建回应的选项。

VoiceAgentRtcCallErrorDetails

WebRTC信号错误详情。

VoiceAgentSemanticVadTurnDetection

OpenAI 语义 VAD 转向检测设置。

VoiceAgentSendItemOptions

由添加对话项目的操作共享选项,默认情况下请求响应。

VoiceAgentSendOptions

实时发送操作共享的选项。

VoiceAgentSendTextOptions

发送文本输入的选项。

VoiceAgentSendToolOutputOptions

返回函数结果的选项。

VoiceAgentServerEventResponseAnimationBlendshapesDelta

response.animation_blendshapes.delta服务器活动。

VoiceAgentServerEventResponseAnimationBlendshapesDone

response.animation_blendshapes.done服务器活动。

VoiceAgentServerEventResponseAnimationVisemeDelta

response.animation_viseme.delta服务器活动。

VoiceAgentServerEventResponseAnimationVisemeDone

response.animation_viseme.done服务器活动。

VoiceAgentServerEventResponseAudioTimestampDelta

response.audio_timestamp.delta服务器活动。

VoiceAgentServerEventResponseAudioTimestampDone

response.audio_timestamp.done服务器活动。

VoiceAgentServerEventResponseVideoDelta

response.video.delta服务器活动。

VoiceAgentServerEventRtcCallError

rtc.call.error服务器事件:WebRTC 信令失败。

VoiceAgentServerEventRtcCallSdpCreated

rtc.call.sdp.created服务器事件:完成WebRTC协商的SDP答案。

VoiceAgentServerEventSessionAvatarConnecting

session.avatar.connecting服务器活动。

VoiceAgentServerEventSessionAvatarSwitchToIdle

session.avatar.switch_to_idle服务器活动。

VoiceAgentServerEventSessionAvatarSwitchToSpeaking

session.avatar.switch_to_speaking服务器活动。

VoiceAgentServerEventSessionSubagentAborted

session.subagent.aborted服务器活动。

VoiceAgentServerEventSessionSubagentCompleted

session.subagent.completed服务器活动。

VoiceAgentServerEventSessionSubagentStarted

session.subagent.started服务器活动。

VoiceAgentServerEventWarning

warning服务器活动。

VoiceAgentServerEventWarningDetails

非致命警告的详细信息。

VoiceAgentServerVadTurnDetection

服务器端语音活动检测。

VoiceAgentSessionAvatarConfig

头像设置被稳定语音代理WebSocket合同接受。

VoiceAgentSessionResponseConfig

语音代理服务返回的有效稳定实时会话设置。

VoiceAgentSessionUpdateConfig

客户端事件中接受 session.update 的稳定实时会话设置。

VoiceAgentSessionUpdateOptions

实时会话更新选项。

VoiceAgentSoundscapeConfig

由经纪人拥有的背景氛围和事件提示。所有被省略的轨道都被禁用。 该服务拒绝未知字段;不支持自定义上传、URL 和内联音频。

VoiceAgentSoundscapeSourceConfig

从服务管理目录中挑选的包装音效。 该服务拒绝未知的源字段和判别值。

VoiceAgentSoundscapeTrackConfig

一个带有独立音频源和播放音量的音景轨道。

VoiceAgentSoundscapeWorkingTrackConfig

一个工作环轨道,延迟从第一个待处理的非呼叫控制工具开始测量。

VoiceAgentStaticInterimResponseConfig

从配置好的文本中选择静态的临时回复。

VoiceAgentSubagent

一位兄弟Foundry的短信代理,语音代理可以作为背景专家咨询。

VoiceAgentSubagentConfig

为兄弟 Foundry 文本代理提供的配置,语音代理可以咨询。

VoiceAgentSubagentResponsePolicy

语音代理等待子代理时交付响应的政策。

VoiceAgentSystemTool

一个服务托管控制,在没有客户代码或外部认证的情况下,对主动语音会话进行操作。

VoiceAgentTemplateGreetingConfig

一种确定性问候语,基于语音代理的结构化输入渲染,并未经过模型自创生成而合成。

VoiceAgentTool

一个语音代理可以使用的工具。

VoiceAgentToolboxTool

这是对 Foundry 工具箱的引用,该工具箱是通过其 MCP 端点执行的版本化工具包。

VoiceAgentTranscriptionPhrase

一段带有时间信息的转录短语。

VoiceAgentTranscriptionWord

输入音频转录中的一个带时间戳的单词。

VoiceAgentTurnDetectionConfig

语音代理的回合检测配置。

VoiceAgentUnknownEvent

该版本SDK不识别其线路类型的服务器事件。

SDK在不关闭连接或应用已知事件验证或规范化的情况下,直接传递这些事件。 使用前检查并验证原始字段。

VoiceAgentWebSocketConnectOptions

选项传递给 VoiceAgentWebSocketTransport.connect。

VoiceAgentWebSocketFactory

为 VoiceAgentRealtimeClient 创建 VoiceAgentWebSocketTransport 实例。

VoiceAgentWebSocketHandlers

当连接事件发生时, VoiceAgentWebSocketTransport 调用回调。

VoiceAgentWebSocketTransport

VoiceAgentRealtimeClient 使用的可插拔 WebSocket 传输工具。 实现此接口以自定义实时连接的建立方式,例如通过认证中继路由。

VoiceAudioItem

单个对话项目音频片段的元数据。 对于自带存储(BYOS),响应包括 blob_uri,一个直接面向客户的存储URI,无需SAS令牌,客户需凭自己的凭证访问。 对于Foundry管理的存储,不存在, blob_uri 字节通过该项目 /audio/content 的路由流式传输。

VoiceConversation

持续的语音对话。 拥有语音代理存储的文字记录、回复、每回合指标和音频的Foundry信封。 它是父、保留和删除的边界:删除它会连锁到它的回复、项目、指标和音频。 当最终验证失败时,任何部分持续的回复、项目和项目音频仍然可读。

VoiceConversationEngine

一个拥有语音代理对话处理的引擎。

VoiceGeneratedAudioItem

对话项目生成音频的元数据。 对于自带存储(BYOS),响应包括 blob_uri,一个直接面向客户的存储URI,无需SAS令牌,客户需凭自己的凭证访问。 对于Foundry管理的存储,不存在, blob_uri 字节通过该项目 /audio/generated/content 的路由流式传输。

VoiceHostedAgentConversationEngine

这是一个闭合的引用,指的是拥有语音代理会话处理的托管文本代理。 托管代理在同一项目内解析,必须支持 invocations_ws 协议、Voice Live 兼容性和桥接协议 1.0。

VoiceRecording

用于合并的全通话立体声录音的元数据(用户音频在左声道,代理音频在右声道)。 会话结束后,每回合的片段构建一次,并能持久缓存。 Foundry管理和自带存储(BYOS)录制时,都会返回通用元数据(格式、采样率、通道、通道布局、时长)。 对于 BYOS,响应还包括 blob_uri,即用户自身存储(无 SAS 令牌)中录制的 URI,客户通过自身存储凭证下载。 对于Foundry管理的存储 blob_uri ,没有存储,字节通过路由流式传输 /audio/content 。

VoiceRecordingChannelLayout

分配给合并立体声录音中每个声道的角色。

VoiceResponse

持续的语音回复代表对话中的一个模型推断回合。 在列表结果 output 中可以省略投影;获取完整的响应(GET .../responses/{response_id})或其输出项的分页响应项路径(GET .../responses/{response_id}/items)。 created_at / completed_at 是铸造厂的耐用订购扩展。

VoiceResponseAudio

音频配置用于回答。 遵循OpenAI实时GA audio 对象形状。

VoiceResponseAudioOutput

平坦响应的音频输出投影,可选 voice配置 、 voice_type、 voice_locale和 format 场。

WebIQPreviewTool

一个WebIQ服务器端工具。

WebIQPreviewToolboxTool

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

WebSearchApproximateLocation

用户的大致位置。

WebSearchConfiguration

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

WebSearchPreviewTool

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

WebSearchTool

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

WebSearchToolFilters

模型界面 WebSearchToolFilters

WebSearchToolboxTool

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

WeeklyRecurrenceSchedule

每周重复计划。

WorkIQPreviewTool

一个WorkIQ服务器端工具。

WorkIQPreviewToolboxTool

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

WorkflowAgentDefinition

工作流代理定义。

类型别名

A2AProtocolVersion

支持A2A协议版本。

ActivityProtocolAccessBoundary

活动协议的访问边界。

AgentBlueprintReferenceType

代理类型:BlueprintReferenceType

AgentBlueprintReferenceUnion

AgentBlueprintReferenceUnion 的别名

AgentDefinitionOptInKeys

支持条件预览功能的代理定义操作的功能选择加入键。

AgentDefinitionUnion

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

AgentEndpoint

在代理端点进行路由、协议和授权配置。

AgentEndpointAuthorizationSchemeType

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

AgentEndpointAuthorizationSchemeUnion

AgentEndpointAuthorizationSchemeUnion 的别名

AgentHarnessUnion

AgentHarnessUnion 的别名

AgentIdentityStatus

代理身份的状态,适用于代理实例身份和代理蓝图。

AgentInsightJsonValue

一个用于Agent Insights有效载荷的JSON值。

AgentInsightOverviewSource

识别Agent Insights概览的来源。

AgentInsightPromptSurface

提示表面因拟议修复而发生了变化。

AgentInsightProposedFixKind

客户可渲染的那种,是客服洞察提出的解决方案。

AgentInsightRunTrigger

触发了一次特工洞察通关。

AgentInsightSeverity

一个特工洞察的严重性。

AgentInsightStatus

代理洞察的生命周期状态。

AgentKind

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

AgentOptimizationCandidateExpand

候选LIST端点查询参数的词汇 expand 表。 这种开放联盟让 SDK 在新扩展密钥部署服务器端时依然可用。 多个值被序列化为一个逗号分隔的查询参数。

AgentOptimizationCandidateOutputUnion

AgentOptimizationCandidateOutputUnion 的别名

AgentOptimizationCandidateStatus

候选人的生命周期状态。

AgentOptimizationConfigurationBaseUnion

AgentOptimizationConfigurationBaseUnion 的别名

AgentOptimizationConfigurationType

优化工作配置类型。

AgentOptimizationDataSourceType

由优化评估集支持的源类型。

AgentOptimizationEvaluationSetType

由优化评估集支持的逻辑行格式。

AgentOptimizationEvaluationSetUnion

AgentOptimizationEvaluationSetUnion 的别名

AgentOptimizationGoal

代理优化任务的目标。

AgentOptimizationMutationUnion

AgentOptimizationMutationUnion 的别名

AgentOptimizationStage

消耗模型资源的优化阶段。

AgentOptimizationTargetCompletionDataSourceUnion

AgentOptimizationTargetCompletionDataSourceUnion 的别名

AgentOptimizationTargetConfigurationType

优化作业支持的目标配置类型。

AgentOptimizationTargetConfigurationUnion

AgentOptimizationTargetConfigurationUnion 的别名

AgentOptimizationTerminationReason

优化过程结束的原因。 提前解雇的原因仍表明工作成功;完成的候选人仍然可用。

AgentOptimizationUserConversationSimulationDataSourceUnion

AgentOptimizationUserConversationSimulationDataSourceUnion 的别名

AgentProtocol

代理协议类型

AgentSessionStatus

代理会话状态。

AgentState

特工的操作状态。

AgentStateSource

表示代理操作状态的来源。 当该状态不是源自特定来源时,则为空。

AgentType

代理类型类型

AgentVersionStatus

代理版本的配置状态。

AgentsDownloadAgentCodeResponse

下载的ZIP压缩包包含托管代理代码,作为浏览器Blob或 Node.js 可读流暴露。

AgentsDownloadSessionFileResponse

下载的代理会话文件,以浏览器Blob或可读流的形式暴露 Node.js。

AgentsPatchAgentObjectOptionalParams

可选参数。

AttackStrategy

攻击策略。

AzureAISearchQueryType

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

BaseCredentialsUnion

BaseCredentialsUnion 的别名

BetaSkillsDownloadResponse

技能默认版本的ZIP压缩包,以浏览器Blob或 Node.js 可读流的形式公开。

BetaVoiceAgentsConversationsDownloadAudioItemResponse

对话项目的WAV音频,以浏览器Blob或 Node.js 可读流的形式暴露。

BetaVoiceAgentsConversationsDownloadAudioResponse

合并后的立体声WAV语音录音,以浏览器Blob或可读流的形式显示 Node.js。

BetaVoiceAgentsConversationsDownloadGeneratedAudioItemResponse

为中断的对话项目生成的WAV音频,作为浏览器Blob或可读流 Node.js 显示。

CallableToolAllowedCaller

CallableToolAllowedCaller 类型

CodeDependencyResolution

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

ComparisonFilterValueItems

ComparisonFilterValueItems 的别名

ComputerEnvironment

计算机环境类型

ConnectionType

连接的类型(或类别)

ContainerMemoryLimit

容器内存限制类型

ContainerNetworkPolicyParamType

容器网络政策ParamType类型类型

ContainerNetworkPolicyParamUnion

Alias for ContainerNetworkPolicyParamUnion

ContainerSkillType

容器类型技能类型

ContainerSkillUnion

ContainerSkillUnion 的别名

ContinuablePage

描述结果页的接口。

CreateTelephonyBindingRequestUnion

Alias for CreateTelephonyBindingRequestUnion

CreateTranscriptionResponseJsonUsageType

Type of CreateTranscriptionResponseJsonUsageType

CreateTranscriptionResponseJsonUsageUnion

Alias for CreateTranscriptionResponseJsonUsageUnion

CredentialType

连接使用的凭证类型

CustomToolParamFormatType

CustomToolParamFormatType 类型

CustomToolParamFormatUnion

Alias for CustomToolParamFormatUnion

DataGenerationJobConfigurationUnion

DataGenerationJobConfigurationUnion 的别名

DataGenerationJobInputsUnion

Alias for DataGenerationJobInputsUnion

DataGenerationJobOutputType

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

DataGenerationJobOutputUnion

DataGenerationJobOutputUnion 的别名

DataGenerationJobOutputWriteMode

支持的数据生成作业输出写入模式。

DataGenerationJobScenario

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

DataGenerationJobSourceType

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

DataGenerationJobSourceUnion

DataGenerationJobSourceUnion 的别名

DataGenerationJobType

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

DataGenerationJobUnion

DataGenerationJobUnion 的别名

DatasetType

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

DatasetVersionUnion

DatasetVersionUnion 的别名

DayOfWeek

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

DeploymentType

DeploymentType 类型

DeploymentUnion

DeploymentUnion 的别名

DigitalWorkerType

数字工作者的类型。

DownloadVersionResponse

指定技能版本的ZIP压缩包,以浏览器Blob或 Node.js 可读流的形式暴露。

EvaluationLevel

评估进行的层级。

EvaluationRuleActionType

评估作的类型。

EvaluationRuleActionUnion

EvaluationRuleActionUnion 的别名

EvaluationRuleEventType

评估规则事件的类型。

EvaluationTargetUnion

评估别名TargetUnion

EvaluationTaxonomyInputType

评估分类输入的类型。

EvaluationTaxonomyInputUnion

评估的别名TaxonomyInputUnion

EvaluationVoiceModelConfigurationUnion

Alias for EvaluationVoiceModelConfigurationUnion

EvaluatorCategory

评估者的类别

EvaluatorDefinitionType

评估器定义的类型

EvaluatorDefinitionUnion

EvaluatorDefinitionUnion 的别名

EvaluatorGenerationJobSourceType

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

EvaluatorGenerationJobSourceUnion

EvaluatorGenerationJobSourceUnion 的别名

EvaluatorMetricDirection

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

EvaluatorMetricType

评估器的类型

EvaluatorType

评估器的类型

FileContents

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

Filters

过滤器的别名

FoundryFeaturesOptInKeys

铸造厂类型功能选择键

FoundryModelArtifactProfileCategory

文物档案类别。

FoundryModelArtifactProfileSignal

模型伪影中检测到信号。

FoundryModelSourceType

模型的来源类型。

FoundryModelWarningCode

模型伪影的警告代码。

FoundryModelWeightType

模型的重量类型。

FunctionShellToolParamEnvironmentType

函数类型ShellToolParamEnvironmentType

FunctionShellToolParamEnvironmentUnion

Alias for FunctionShellToolParamEnvironmentUnion

GenerateAgentRequest

用于生成和创建智能体的具体类型输入。

GenerationWarningType

警告类别出现在生成的评估器版本中。 可扩展,以便引入新的警告类别(如安全、输出质量)而不会产生破坏性变更。

GetMicrosoft365PackageResponse

为 Foundry 代理生成的二进制 Microsoft 365 应用包。

GitHubCopilotBuiltInTool

保留了原有的 GitHub Copilot 内置工具名称以保证兼容性。 用于 MicrosoftCopilotBuiltInTool 新的集成。

GitHubIssueEvent

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

GrammarSyntax

语法类型句法

ImageGenAction

图像GenAction类型

IndexType

IndexType 的类型

IndexUnion

IndexUnion 的别名

InputFidelity

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

InsightRequestUnion

InsightRequestUnion 的别名

InsightResultUnion

InsightResultUnion 的别名

InsightSampleUnion

InsightSampleUnion 的别名

InsightType

见解的请求。

JobPoller

一个用于长期运行操作的轮询器,创建一个作业资源。

JobStatus

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

MemoryItemKind

记忆项种类。

MemoryItemUnion

MemoryItemUnion 的别名

MemoryOperationKind

内存作类型。

MemoryStoreDefinitionUnion

MemoryStoreDefinitionUnion 的别名

MemoryStoreKind

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

MemoryStoreType

存储类型

MemoryStoreUpdateStatus

内存存储更新作的状态。

Microsoft365PublishScope

生成的 Microsoft Teams 应用的发布范围。

MicrosoftCopilotBuiltInTool

一个客户可配置的 Microsoft Copilot 内置工具。

MisalignmentErrorType

一种可能与用户意图不符的行为分类。 可能会返回额外的数值。

NodeReadableStream

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

OpenApiAuthDetailsUnion

OpenApiAuthDetailsUnion 的别名

OpenApiAuthType

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

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

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

OptimizationCandidate

配置变更及对代理优化候选的汇总评估结果。

OptimizationContextType

为优化工作流程提供的上下文类型。

OptimizationContextUnion

Alis for optimizationContextUnion

OptimizationJob

一个跟踪输入、进度、状态和候选人评估结果的代理优化任务。

OptimizationJobResult

评估过的候选人和优化作业中最佳候选人的标识符。

PageOrder

页序类型

PendingUploadType

待上传的类型。

PublishApprovalStatus

Microsoft代理认证审核状态,Microsoft 365代理发布的店铺标题。

RaiInvocationContentType

调用请求/响应主体如何解析以定位内容安全管理的文本。

RaiInvocationMode

调用协议的作者声明响应形态。

RankerVersionType

排名者类型版本类型

RealtimeAudioFormatsType

实时音频格式类型类型

RealtimeAudioFormatsUnion

RealtimeAudioFormatsUnion 的别名

RealtimeClientEventType

RealtimeClientEventType 类型

RealtimeClientEventUnion

RealtimeClientEventUnion 的别名

RealtimeConversationItemMessageType

实时对话项目消息类型类型

RealtimeConversationItemMessageUnion

RealtimeConversationItemMessageUnion 的别名

RealtimeConversationItemType

RealtimeConversationItemType 类型

RealtimeConversationItemUnion

RealtimeConversationItemUnion 的别名

RealtimeFunctionToolParameters

模型接口 RealtimeFunctionToolParameters(实时功能工具参数)

RealtimeMCPErrorType

RealtimeMCPErrorType 类型

RealtimeMCPErrorUnion

RealtimeMCPErrorUnion 的别名

RealtimeReasoningEffort

限制了推理能力强的实时模型(如 gpt-realtime-2)。

RealtimeServerEventType

RealtimeServerEventType 类型

RealtimeServerEventUnion

RealtimeServerEventUnion 的别名

ReasoningEffort

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

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

ReasoningModeEnum 的别名

RecurrenceScheduleUnion

RecurrenceScheduleUnion 的别名

RecurrenceType

重复类型。

RedTeamTargetConfigUnion

RedTeamTargetConfigUnion 的别名

RiskCategory

攻击目标的风险类别。

RoutineActionType

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

RoutineActionUnion

RoutineActionUnion 的别名

RoutineAttemptSource

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

RoutineDispatchIdentity

支持例行调度授权的身份。

RoutineDispatchPayloadType

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

RoutineDispatchPayloadUnion

RoutineDispatchPayloadUnion 的别名

RoutineRunPhase

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

RoutineRunStatus

例行跑的状态。

RoutineTriggerType

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

RoutineTriggerUnion

RoutineTriggerUnion 的别名

RubricGenerationInputQualityWarningCode

稳定的可搜索、机器可读的警告代码,用于评分标准生成输入质量警告。 值为 snake_case;客户端必须容忍额外的服务定义标识符。

RubricGenerationInputQualityWarningSeverity

评分标准生成输入质量警告的警告严重度。 初始值集: warning。

RubricGenerationInputQualityWarningSource

用于评分标准生成输入质量警告的警告来源。 每个源的值(prompt, agent, dataset)与生成运行时可见的源类别匹配。 aggregate 是仅用于跨成功解析源计算的警告的合成值。 traces 不会被暴露,因为追踪源会解析到上游的数据集内容中。

RunPoller

一个用于长期运行操作的轮询器,该操作创建运行资源。

SampleType

分析中使用的样品类型。

ScheduleProvisioningStatus

计划配置状态。

ScheduleTaskType

任务的类型。

ScheduleTaskUnion

ScheduleTaskUnion 的别名

SearchContentType

搜索类型内容类型

SearchContextSize

搜索类型ContextSize

SessionLogEventType

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

SimpleQnAFineTuningQuestionType

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

TargetAttribute

可以优化的代理属性。

TelemetryDataKind

导出的遥测数据类型。

TelemetryEndpointAuthType

遥测端点的认证类型。

TelemetryEndpointAuthUnion

Alias for TelemetryEndpointAuthUnion

TelemetryEndpointKind

那种遥测导出终端。

TelemetryEndpointUnion

Alias for TelemetryEndpointUnion

TelemetryTransportProtocol

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

TelephonyBindingListItemUnion

Alias for TelephonyBindingListItemUnion

TelephonyBindingStatus

电话绑定的生命周期状态。

TelephonyBindingUnion

TelephonyBindingUnion 的别名

TelephonyCallDurationBasis

时间戳作为通话时长的基础。

TelephonyCallEndReason

已知的服务生成原因导致某次电话通话结束,而非整体外呼任务的原因。 可能会返回额外的字符串代码。

TelephonyCallJobStatus

持久外呼任务的生命周期状态。

TelephonyCallJobTerminalReason

整体外呼任务的已知终端原因,该任务可能跨越多个提供商尝试。 这些原因不同于单个呼叫生命周期的原因。 可能会返回额外的字符串代码。

TelephonyCallLifecycleEventName

一个与提供者无关的生命周期事件名称。 已知值是稳定的;随着时间推移,可能会添加更多值。

TelephonyCallLifecycleEventOutcome

一次电话生命周期观察的结果。

TelephonyCallLifecycleEventReason

已知的服务生成原因导致电话生命周期事件。 事件原因不一定能描述通话的最终结果。 可能会返回额外的字符串代码。

TelephonyCallLifecycleEventSource

提供电话生命周期观测的组件。

TelephonyCallPhase

进入电话呼叫所达到的提供商中立阶段。

TelephonyCallStatus

入线电话的生命周期状态。

TelephonyCallTimestampSource

电话生命周期时间戳的来源。

TelephonyCallTraceMode

该模式用于将电话通话暴露为面向客户的Foundry追踪。

TelephonyCallTraceStatus

面向客户的电话呼叫追踪的可用性状态。

TelephonyOutboundDestinationType

外拨电话的目的地类型。

TelephonyOutboundRetryPolicyType

外拨电话的重试策略。

TelephonyOutboundRetryPolicyUnion

电话外呼别名RetryPolicyUnion

TelephonyProvider

一个由代理人绑定支持的电话服务提供商。 已知值是稳定的;随着时间推移,可能会添加更多值。

TelephonyTransferDestinationKind

那种电话转接目的地。 已知值是稳定的;随着时间推移,可能会添加更多值。

TelephonyTransferDestinationUnion

TelephonyTransferDestinationUnion 的别名

TextResponseFormatConfigurationType

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

TextResponseFormatConfigurationUnion

支持纯文本和结构化JSON响应的配置。

TextResponseFormatUnion

TextResponseFormatUnion 的别名

ToolChoiceOptions

控制模型调用哪些工具(如有)。 none 表示模型不会调用任何工具,而是生成消息。 auto 表示模型可以在生成消息和调用一个或多个工具之间进行选择。 required 表示模型必须调用一个或多个工具。

ToolChoiceParamType

工具选择类型参数类型

ToolChoiceParamUnion

ToolChoiceParamUnion 的别名

ToolSearchExecutionType

工具类型搜索执行类型

ToolType

工具类型类型

ToolUnion

ToolUnion 的别名

ToolboxShellEnvironmentUnion

ToolboxShellEnvironmentUnion 的别名

ToolboxShellNetworkPolicyUnion

Alias for ToolboxShellNetworkPolicyUnion

ToolboxSkillUnion

ToolboxSkillUnion 的别名

ToolboxToolType

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

ToolboxToolUnion

ToolboxToolUnion 的别名

ToolboxesInvokeLatestToolboxMcpResponse

最新的工具箱 MCP 端点返回了响应。

TreatmentEffectType

治疗效果类型。

TriggerType

触发器的类型。

TriggerUnion

TriggerUnion 的别名

UserConversationSimulationAudioEffect

这种效果可以应用于模拟对话音频。 并集可扩展以产生额外效果。

UserConversationSimulationInterruptionConfigurationUnion

UserConversationSimulationInterruptionConfigurationUnion 的别名

VersionIndicatorType

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

VersionIndicatorUnion

VersionIndicatorUnion 的别名

VersionSelectionRuleType

版本选择规则类型类型

VersionSelectionRuleUnion

VersionSelectionRuleUnion 的别名

VoiceAgentAnimationOutputType

由语音代理会话产生的动画输出。

VoiceAgentAudioTimestampType

由语音代理支持的输出音频时间戳类型。

VoiceAgentAvatarOutputProtocol

用于传输阿凡达视频流的交通工具。

VoiceAgentAvatarType

那种阿凡达类型。

VoiceAgentClientEvent

客户端通过语音代理WebSocket发送的稳定v1消息。

VoiceAgentConnectionState

连接状态由语音代理实时报告。

VoiceAgentConnectionStateChangedHandler

当语音代理连接状态发生变化时调用。

VoiceAgentEchoCancellationReferenceSource

用于回声消除的参考音频来源。

VoiceAgentEndOfUtteranceDetectionModel

语义语句尾检测模型。

VoiceAgentEndOfUtteranceThresholdLevel

语义末尾检测的敏感阈值。

VoiceAgentGreetingConfigUnion

Alias for VoiceAgentGreetingConfigUnion

VoiceAgentInputTranscriptionModel

输入音频转录模型标识符。 这是一个型号名称,不是Foundry部署名称。 镜像托管语音后端支持的转录模型,涵盖OpenAI实时转录模型以及Azure和MAI模型。 azure-speech-streaming 仅支持级联文本模型对话(不支持实时语音转语音模型),需要非空, languageen-US 如(支持逗号分隔的区域),并支持 custom_speech、、 phrase_list和 profanity_filter。 可能会随着时间的推移添加其他值。

VoiceAgentInterimResponseConfigUnion

VoiceAgentInterimResponseConfigUnion 的别名

VoiceAgentInterimResponseTrigger

一种可能触发临时反应的状况。

VoiceAgentMaxOutputTokens

最大输出令牌数或字面值 inf。

VoiceAgentNoiseReductionType

输入音频降噪模式。

  • azure_deep_noise_suppression_headset:Azure 耳机优化的噪声抑制功能,用于本地语音活动检测。 针对低采样率音频优化,包括8 kHz电话音频。 增强检测音频,同时不改变用于识别的音频。 该模式不限于头显设备。
  • azure_personal_noise_suppression:Azure 个性化噪声抑制,用于本地语音活动检测。 从耳机抑制开始,自动注册扬声器后实现个性化检测。 识别音频保持不变;当个性化不可用时,耳机抑制依然有效。
VoiceAgentProfanityFilterMode

支持输入转录的脏话过滤模式。

VoiceAgentRealtimeErrorCode

语音代理实时客户端发出错误代码。

VoiceAgentRealtimeEvent

从语音代理实时连接接收到的事件。

已知事件保留其生成的类型和归一化。 未识别的线类型被 VoiceAgentUnknownEvent包裹。 切换 type 到狭窄的已知事件,或 type === "unknown" 在将事件传递给已知事件处理程序前排除。

VoiceAgentServerEvent

服务通过语音代理WebSocket发送的稳定v1消息。

VoiceAgentSessionIncludeOption

语音代理会话可能包含在服务输出中的额外字段。

VoiceAgentSessionResponse

有效会话配置在语音代理会话生命周期事件中返回。

VoiceAgentSessionUpdate

会话配置被语音代理会话更新事件接受。

VoiceAgentSoundscapeSound

内置音景源可接受包装的声音。

VoiceAgentSubagentAbortReason

为什么一次子代理人咨询被取消。

VoiceAgentSystemToolName

服务管理的语音会话控制操作。 已知值是稳定的;随着时间推移,可能会添加更多值。

VoiceAgentSystemToolUnion

VoiceAgentSystemToolUnion 的别名

VoiceAgentToolChoice

语音代理的工具选择行为。

VoiceAgentToolResponseScheduling

当工具调用产生后续响应时, 可能会随着时间的推移添加其他值。

VoiceAgentToolUnion

VoiceAgentToolUnion 的别名

VoiceAgentTransport

用于语音代理连接的传输方式。

VoiceAgentTurnDetectionConfigUnion

Alias for VoiceAgentTurnDetectionConfigUnion

VoiceAgentTurnDetectionType

转向检测策略。 可能会随着时间的推移添加其他值。

VoiceAgentWebSocketMessage

通过已建立的语音代理WebSocket交换的JSON文本消息。 音频字节在 JSON 事件字段中以 base64 编码。

VoiceAgentWebSocketSubprotocol

WebSocket子协议由语音代理连接支持。

VoiceAudioCodec

一个音频编解码器。 可能会随着时间的推移添加其他值。

VoiceAudioContainerFormat

音频容器格式。 可能会随着时间的推移添加其他值。

VoiceAudioRole

一个语音-音频参与者的角色。 可能会随着时间的推移添加其他值。

VoiceConversationEngineUnion

VoiceConversationEngineUnion 的别名

VoiceConversationStatus

持久语音对话的生命周期状态:

  • in_progress:实时会话处于活跃状态,或会话后持久化最终确定待处理。
  • completed:在正常或客户端关闭 end_conversation后,完成了,达到最大时长 1001 关闭,或服务仍可完成的客户端或网络断开。
  • failed:终端服务、桥接器、存储或无法恢复的传输故障阻止了最终确定。
VoiceModelType

支持语音代理的模型是如何被服务的。 这与服务从所选模型衍生的架构(实时或级联)无关。

VoiceOutputModality

代理人可能产生的一种输出模态。 animation 并且 avatar 在配置化身时使用。

VoiceType

语音实现。 可能会随着时间的推移添加其他值。

枚举

KnownApiVersions

Microsoft Foundry API 版本

函数

isRestError(unknown)

RestError 的 Typeguard

变量

RestError

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

KnownVoiceAgentConnectionState

语音代理实时连接报告的 VoiceAgentConnectionState 已知值。

函数详细信息

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e is RestError

参数

e

unknown

catch 子句捕获的内容。

返回

e is RestError

变量详细信息

RestError

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

RestError: RestErrorConstructor

类型

KnownVoiceAgentConnectionState

语音代理实时连接报告的 VoiceAgentConnectionState 已知值。

KnownVoiceAgentConnectionState: { Closing: "closing", Connected: "connected", Connecting: "connecting", Disconnected: "disconnected" }

类型

{ Closing: "closing", Connected: "connected", Connecting: "connecting", Disconnected: "disconnected" }