@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	模型介面 AgentCard
AgentCardSkill	model interface AgentCardSkill
AgentClusterInsightRequest	對代理評估結果集的見解
AgentClusterInsightResult	來自代理程式叢集分析的見解。
AgentDataGenerationJobSource	資料產生任務的代理來源 — 參考代理以擷取指令與元資料。
AgentDefinition	代理程式的基本定義介面。包含代理程式種類和選用 RAI 組態。
AgentEndpointAuthorizationScheme	模型介面 AgentEndpointAuthorizationScheme
AgentEndpointConfig	model interface AgentEndpointConfig
AgentEvaluatorGenerationJobSource	評估器產生任務的代理來源 — 參考代理以擷取指令與元資料。
AgentHarness	（預覽）一個受管理的執行時與代理迴圈，用於執行提示代理。
AgentIdentity	模型介面代理識別碼
AgentInsight	一個持續存在的問題，從一名代理人的痕跡中被發現。
AgentInsightDetails	更多洞察細節。除非要求細節，否則省略。
AgentInsightEstimatedCost	預估代理人洞察費用。
AgentInsightHighlightedTrace	一個標示出來的痕跡，提供代理人洞察的證據。
AgentInsightJsonObject	一個用於 Agent Insights payload 的 JSON 物件。
AgentInsightLinkedTrace	一個輕量級的痕跡參考，連結到代理人的洞察作為支持證據。
AgentInsightMonitor	一個針對每位代理的代理洞察監控器，負責設定、執行並發現洞察。
AgentInsightMonitorCreate	建立代理人洞察監控器時，接受欄位。
AgentInsightMonitorListItem	由清單操作回傳的代理洞察監控摘要。
AgentInsightMonitorUpdate	這些欄位可以在 Agent Insights 監控器上更新。
AgentInsightProposedFix	推薦的解決方案，提供給客服人員的洞察。
AgentInsightProposedFixChange	一個客戶可呈現的修正變更。
AgentInsightRecommendedAction	建議的補救措施，作為代理人洞察。
AgentInsightRun	一個長期連載，分析一名代理人的追蹤並更新該代理人的洞察。
AgentInsightRunCreate	建立代理洞察執行時使用的輸入。
AgentInsightRunResult	當代理洞察執行成功時產生的結果統計數據。
AgentInsightSuspension	為何預定發電會暫停監控器的結構性原因。
AgentInsightTokenUsage	Agent Insights 執行時的代幣使用情況。
AgentInsightUpdate	這些欄位可以根據代理洞察更新。
AgentInsightsOverview	Agent Insights 監控器的有效概覽。
AgentInsightsOverviewOverride	使用者提供的總覽，立即生效，並為下一代提供種子。
AgentOptimizationCandidate	針對單一候選代理配置在所有任務中的彙整評估結果。
AgentOptimizationDatasetCriterion	評估標準：用於逐題評分的名稱+指令對。
AgentOptimizationDatasetInput	以基準區分模型輸入資料集。要麼是內嵌項目，要麼是註冊的參考資料。
AgentOptimizationDatasetItem	內嵌資料集中的單一項目。
AgentOptimizationEvaluatorRef	參考一個命名的評估器，可選擇性地釘選到某個版本。
AgentOptimizationInlineDatasetInput	內嵌資料集 — 直接在請求主體中提供的項目。
AgentOptimizationJob	代理優化工作資源 — 一個長期執行的工作，優化代理的配置（指令、模型、技能、工具）以最大化評估分數。成功後，結果包含評分過的候選人。
AgentOptimizationJobInputs	呼叫者提供的優化輸入。
AgentOptimizationJobListItem	LIST 端點回傳的 Slim 工作表示。
AgentOptimizationJobProgress	飛行進度;只有在狀態排隊或in_progress時才會被填入。
AgentOptimizationJobResult	終端狀態結果機構。當地位成功或失敗時即被填入。
AgentOptimizationOptions	調校旋鈕和運行模式以進行優化工作。
AgentOptimizationReferenceDatasetInput	參考已註冊的 Foundry 資料集。
AgentSessionResource	一個提供長期計算沙盒的代理會話，用於託管代理調用。
AgentTaxonomyInput	當輸入類型為代理程式時，評估分類的輸入組態。
AgentVersion	代表代理程式的特定版本。包括中繼資料、版本設定、建立時間和代理程式定義。
AgenticIdentityPreviewCredentials	代理程式身分認證定義
AgentsCreateAgentFromManifestOptionalParams	選擇性參數。
AgentsCreateAgentVersionFromManifestOptionalParams	選擇性參數。
AgentsCreateOptionalParams	選擇性參數。
AgentsCreateSessionOptionalParams	選擇性參數。
AgentsCreateTelephonyBindingOptionalParams	選擇性參數。
AgentsCreateVersionFromCodeOptionalParams	選擇性參數。
AgentsCreateVersionOptionalParams	選擇性參數。
AgentsDeleteOptionalParams	選擇性參數。
AgentsDeleteSessionFileOptionalParams	選擇性參數。
AgentsDeleteSessionOptionalParams	選擇性參數。
AgentsDeleteTelephonyBindingOptionalParams	選擇性參數。
AgentsDeleteVersionOptionalParams	選擇性參數。
AgentsDisableOptionalParams	選擇性參數。
AgentsDownloadAgentCodeOptionalParams	選擇性參數。
AgentsDownloadSessionFileOptionalParams	選擇性參數。
AgentsEnableOptionalParams	選擇性參數。
AgentsGetOptionalParams	選擇性參數。
AgentsGetSessionLogStreamOptionalParams	選擇性參數。
AgentsGetSessionOptionalParams	選擇性參數。
AgentsGetTelephonyBindingOptionalParams	選擇性參數。
AgentsGetVersionOptionalParams	選擇性參數。
AgentsListOptionalParams	選擇性參數。
AgentsListSessionFilesOptionalParams	選擇性參數。
AgentsListSessionsOptionalParams	選擇性參數。
AgentsListTelephonyBindingsOptionalParams	選擇性參數。
AgentsListTelephonyCallsOptionalParams	選擇性參數。
AgentsListVersionsOptionalParams	選擇性參數。
AgentsOperations	代表代理程式作業的介面。
AgentsStopSessionOptionalParams	選擇性參數。
AgentsUpdateAgentFromManifestOptionalParams	選擇性參數。
AgentsUpdateAgentObjectOptionalParams	選擇性參數。
AgentsUpdateOptionalParams	選擇性參數。
AgentsUpdateTelephonyBindingOptionalParams	選擇性參數。
AgentsUploadSessionFileOptionalParams	選擇性參數。
ApiErrorResponse	API 失敗的錯誤回應。
ApiKeyCredentials	API Key 憑證定義
ApplyPatchToolParam	允許助理使用統一差異來建立、刪除或更新檔案。
ApproximateLocation	模型介面近似位置
ArtifactProfile	模型的工件剖面
AutoCodeInterpreterToolParam	程式代碼解釋器容器的設定。選擇性地指定要執行程式碼之檔案的識別碼。
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	輸入定義資訊，用於配置代理程式的 Azure 函式工具。
AzureOpenAIModelConfiguration	Azure OpenAI 模型配置。 API 版本將由服務選擇以查詢模型。
BaseCredentials	連接憑證的基類
BetaAgentInsightMonitorsCancelRunOptionalParams	選擇性參數。
BetaAgentInsightMonitorsCreateOptionalParams	選擇性參數。
BetaAgentInsightMonitorsCreateRunOptionalParams	選擇性參數。
BetaAgentInsightMonitorsDeleteOptionalParams	選擇性參數。
BetaAgentInsightMonitorsGetInsightOptionalParams	選擇性參數。
BetaAgentInsightMonitorsGetOptionalParams	選擇性參數。
BetaAgentInsightMonitorsGetRunOptionalParams	選擇性參數。
BetaAgentInsightMonitorsListInsightsOptionalParams	選擇性參數。
BetaAgentInsightMonitorsListOptionalParams	選擇性參數。
BetaAgentInsightMonitorsListRunsOptionalParams	選擇性參數。
BetaAgentInsightMonitorsOperations	代表 BetaAgentInsightMonitors 操作的介面。
BetaAgentInsightMonitorsResetOptionalParams	選擇性參數。
BetaAgentInsightMonitorsUpdateInsightOptionalParams	選擇性參數。
BetaAgentInsightMonitorsUpdateOptionalParams	選擇性參數。
BetaAgentsCancelOptimizationJobOptionalParams	選擇性參數。
BetaAgentsCreateFromPromptOptionalParams	選擇性參數。
BetaAgentsCreateOptimizationJobOptionalParams	選擇性參數。
BetaAgentsDeleteOptimizationJobOptionalParams	選擇性參數。
BetaAgentsGetOptimizationJobOptionalParams	選擇性參數。
BetaAgentsListOptimizationJobsOptionalParams	選擇性參數。
BetaAgentsOperations	管理代理人的營運。
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	介面代表 BetaMemoryStores 操作。
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	一個儲存在工具箱中的瀏覽器自動化工具。
BrowserAutomationToolConnectionParameters	「瀏覽器自動化工具」所使用連線的輸入參數定義。
BrowserAutomationToolParameters	瀏覽器自動化工具的輸入參數定義。
CaptureStructuredOutputsTool	用於捕獲結構化輸出的工具
ChartCoordinate	分析圖表的座標。
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	模型介面 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。
CreateTeamsPhoneExtensionTelephonyBindingRequest	建立 Microsoft Teams 電話分機綁定的請求。
CreateTelephonyBindingRequest	請求建立電話綁定。
CreateTelephonyCallJobRequest	一個建立一個持久直接外撥通話工作的請求。
CreateTranscriptionResponseJsonUsage	請求的代幣使用統計數據。
CreateTwilioTelephonyBindingRequest	請求製作 Twilio 綁定書。
CronTrigger	基於 Cron 的觸發器。
CustomCredential	自定義憑證定義
CustomGrammarFormatParam	一種由使用者定義的文法。
CustomRoutineTrigger	一個自訂事件例程觸發器。
CustomTextFormatParam	不受限制的自由形式文字。
CustomToolParam	一個自訂工具，能依照指定格式處理輸入。了解更多關於 custom tools
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	模型介面錯誤模型
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 追蹤。每個用戶端實例都維護其獨立的追蹤設定。
GenerateVoiceAgentRequest	產生語音代理的輸入。只有 `kind` 和 `name` 都是必須的。著作服務會將這些輸入擴展成完整且可 `VoiceAgentDefinition`編輯的，然後透過來建立 `POST /agents`。產生 `instructions` 的與音訊/語音設定會分別儲存在後面的客服定義中，呼叫者可透過標準客服版本控制編輯或覆寫其中任何欄位。
GetMicrosoft365PackageOptionalParams	選擇性參數。
GetMicrosoft365PublishDefaultsOptionalParams	選擇性參數。
GitHubCopilotHarness	（預覽）GitHub Copilot 管理提示代理的架構。
GitHubCopilotToolsetConfig	針對 GitHub Copilot 內建工具的啟用覆寫。
GitHubCopilotToolsetDefaultConfig	GitHub Copilot 內建工具的預設啟用設定。
GitHubCopilotToolsetPreview	（預覽）GitHub Copilot 內建工具的設定覆蓋。
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	允許模型在本機環境中執行殼層命令的工具。
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 的回應。
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 工具。
OptimizedAgentIdentifier	識別註冊的 Foundry 代理進行優化（僅限請求）。技能、工具與system_prompt在options.optimization_config中明確規定。
OtlpTelemetryEndpoint	一個 OTLP（OpenTelemetry 協定）遙測匯出端點。
PageSettings	追蹤分頁反覆運算設定的介面
PagedAsyncIterableIterator	介面，可讓異步反覆運算同時完成和逐頁執行。
PendingUploadRequest	表示對待上載的請求。
PendingUploadResponse	表示待處理上傳請求的回應
PickPropertiesVoiceAgentAudioConfig	選擇房產的範本。
ProceduralMemoryItem	一個包含從對話中擷取的程序的記憶項目。
ProgrammaticToolCallingParam	model interface ProgrammaticToolCallingParam
PromotionInfo	當候選人被部署到 Foundry 代理時所記錄的晉升元資料。
PromptAgentDefinition	提示代理人定義
PromptAgentDefinitionTextOptions	來自模型的文字回應組態選項。可以是純文字或結構化 JSON 數據。
PromptBasedEvaluatorDefinition	基於提示的評估器
PromptDataGenerationJobSource	資料產生任務的提示來源 — 使用者提供的內嵌文字。
PromptEvaluatorGenerationJobSource	評估器產生任務的提示來源 — 使用者提供的內嵌文字。
ProtocolConfiguration	代理端點的每個協定設定。
ProtocolVersionRecord	單一通訊協定及其版本的記錄對映。
PstnTelephonyTransferDestination	電話轉接目標的 PSTN 目的地。
PublishToMicrosoft365OptionalParams	選擇性參數。
RaiConfig	負責任 AI （RAI）內容篩選和安全功能的設定。
RaiInvocationModeration	宣告請求/回應文字所在位置，以便內容安全欄杆能擷取。
RaiSseTextSelector	一個 SSE 事件類型轉為文字欄位選擇器，用於串流調用輸出。
RankingOptions	模型介面 RankingOptions
RealtimeAudioFormats	模型介面 RealtimeAudioFormats
RealtimeAudioFormatsAudioPcm	模型介面 RealtimeAudioFormatsAudioPcm
RealtimeAudioFormatsAudioPcma	模型介面 RealtimeAudioFormatsAudioPcma
RealtimeAudioFormatsAudioPcmu	model interface RealtimeAudioFormatsAudioPcmu
RealtimeClientEvent	一個即時客戶事件。
RealtimeClientEventConversationItemCreate	在對話的上下文中新增一個項目，包括訊息、函式呼叫和函式呼叫回應。此事件可用於填寫對話的「歷史紀錄」或在串流中新增項目，但目前的限制是無法填充助理語音訊息。若成功，伺服器會以事件回應 `conversation.item.created` ，否則 `error` 會傳送事件。
RealtimeClientEventConversationItemDelete	當你想從對話紀錄中移除任何項目時，發送此事件。伺服器會回應事件 `conversation.item.deleted` ，除非該項目不存在於對話紀錄中，否則伺服器會以錯誤回應。
RealtimeClientEventConversationItemRetrieve	當你想取得伺服器對對話歷史中特定項目的表示時，發送此事件。例如，這對於在降噪和 VAD 後檢查使用者音訊非常有用。伺服器會回應事件 `conversation.item.retrieved` ，除非該項目不存在於對話紀錄中，否則伺服器會以錯誤回應。
RealtimeClientEventConversationItemTruncate	發送此事件以截斷先前助理訊息的音訊。伺服器產生的音訊速度會比即時快，因此當使用者中斷以截斷已傳送到客戶端但尚未播放的音訊時，此事件非常有用。這將使伺服器對音訊的理解與用戶端的播放同步。截斷音訊會刪除伺服器端的文字逐字稿，以確保上下文中沒有使用者未聽過的文字。若成功，伺服器將以事件回應 `conversation.item.truncated` 。
RealtimeClientEventInputAudioBufferAppend	傳送此事件，將音訊位元組附加到輸入音訊緩衝區。音訊緩衝區是一個暫時的儲存空間，可供寫入並在之後提交。「commit」會從緩衝區內容在對話歷史中建立新的使用者訊息項目，並清除緩衝區。當緩衝區被提交時，會產生輸入音訊轉錄（若啟用）。若啟用 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	發送此事件以取消正在進行中的回應。伺服器將以狀態`response.done`為的事件進行`response.status=cancelled`回應。若無取消回應，伺服器將以錯誤回應。即使沒有回應，也可以安全地撥打 `response.cancel` ，錯誤會被回傳，該會話不會受影響。
RealtimeClientEventResponseCreate	此事件指示伺服器建立回應，意即觸發模型推理。在伺服器 VAD 模式下，伺服器會自動產生回應。回應至少包含一個項目，且可能包含兩個項目，此時第二個項目將是函式呼叫。這些項目預設會附加到對話紀錄中。伺服器會回應一個 `response.created` 事件、一個關於物品與內容的事件，最後 `response.done` 一個事件來表示回應已完成。該 `response.create` 事件包含推論配置，如 `instructions` 和 `tools`。若設定為此，則僅會覆蓋該回應的 Session 設定。回應可以在預設對話的帶外產生，意即它們可以有任意輸入，且可以停用寫入該對話的輸出。一次只能寫入一個回應給預設對話，但除此之外可以同時建立多個回應。這個 `metadata` 欄位是區分多個同時回應的好方法。用戶端可以設定 `conversation` 為來 `none` 建立一個不會寫入預設對話的回應。可透過 `input` 欄位提供任意輸入，該欄位是一個陣列，接受原始項目及對現有項目的參考。
RealtimeConversationItem	即時對話中的單一項目。
RealtimeConversationItemFunctionCall	即時對話中的函式呼叫項目。
RealtimeConversationItemFunctionCallOutput	一個函式呼叫即時對話中的輸出項目。
RealtimeConversationItemMessage	模型介面 RealtimeConversationItemMessage
RealtimeConversationItemMessageAssistant	即時對話中的助理訊息項目。
RealtimeConversationItemMessageAssistantContent	模型介面 RealtimeConversationItemMessageAssistantContent
RealtimeConversationItemMessageSystem	即時對話中的系統訊息可用來為模型提供額外的上下文或指令。這與對話開始時提供的指令提示相似但不同，因為系統訊息可以在對話的任何時刻加入。對於對話行為的重大變更，請使用指令;但對於較小的更新（例如「使用者現在正在詢問另一個主題」），則使用系統訊息。
RealtimeConversationItemMessageSystemContent	模型介面 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（模型介面）RealtimeResponseStatusDetailsError（錯誤）
RealtimeResponseUsage	模型介面 RealtimeResponseUsage
RealtimeResponseUsageInputTokenDetails	模型介面 RealtimeResponseUsageInputTokenDetails
RealtimeResponseUsageInputTokenDetailsCachedTokensDetails	模型介面 RealtimeResponseUsageInputTokenDetailsCachedTokensDetails
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 逾時觸發輸入音訊緩衝區時，會回傳此訊息。這是在`turn_detection`會話設定中設定`idle_timeout_ms`的，顯示在設定期間內沒有偵測到語音。 `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` 回應物件會包含所有回應中的輸出項目，但會省略原始音訊資料。客戶端應檢查 `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	當 Session 建立時會回傳。當建立新連線作為第一個伺服器事件時，會自動發出。此事件將包含預設的會話設定。
RealtimeServerEventSessionUpdated	當會話更新事件 `session.update` 時回傳，除非有錯誤。
Reasoning	僅限 GPT-5 與 O 系列車型推理模型的配置選項。
RecurrenceSchedule	週期性排程模型。
RecurrenceTrigger	基於週期的觸發器。
RedTeam	紅隊詳情。
RedTeamTargetConfig	目標配置的抽象類。
ReminderPreviewToolboxTool	一個儲存在工具箱裡的提醒工具。
ResponseUsageInputTokensDetails	model interface 回應使用輸入代幣詳細資料
ResponseUsageOutputTokensDetails	model interface 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 工具合約或現有工具箱工具定義。
SimpleQnADataGenerationJobOptions	關於 SimpleQnA 類型的資料產生工作的選項。
SimulationSeedDataGenerationJobOptions	模擬種子資料產生工作的選項。可搭配多回合評估情境及提示、檔案或代理來源使用。產生的資料集列包含如 `id`、、 `categorytest_case_description`、 `desired_num_turns`和等欄位。
SipTelephonyTransferDestination	電話傳輸目標的 SIP 目的地。
Skill	一個技能資源。
SkillInlineContent	內嵌內容，幫助定義一個簡單技能，但不需要上傳檔案。遵循 agentskills.io SKILL.md 規範。
SkillReference	（預覽）這是對一個版本化的 Foundry 技能的致敬。
SkillReferenceParam	模型介面 SkillReferenceParam
SkillVersion	某種技能的特定版本。
SpecificApplyPatchParam	執行工具呼叫時，強制模型呼叫apply_patch工具。
SpecificFunctionShellParam	當需要工具呼叫時，強制模型呼叫 shell 工具。
SpecificProgrammaticToolCallingParam	model interface SpecificProgrammaticToolCallingParam
StructuredInputDefinition	可參與提示範本替換和工具引數繫結的結構化輸入。
StructuredOutputDefinition	一個由代理人能產生的結構化輸出。
TaskGenerationDataGenerationJobOptions	舊有任務產生工作的選項，包括產生的最大樣本數。
TaxonomyCategory	分類類別定義。
TaxonomySubCategory	分類學子類別定義。
TeamsPhoneExtensionTelephonyBinding	一個由語音代理擁有的 Microsoft Teams 電話分機綁定。
TeamsPhoneExtensionTelephonyBindingListItem	Microsoft Teams 電話 Extension 綁定在列表中回傳，包含其實體標籤。
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	一個儲存在工具箱中的工具箱搜尋工具。
ToolUseFineTuningDataGenerationJobOptions	關於 ToolUse 類型資料產生工作的選項。僅用於微調場景。
ToolboxObject	一個儲存代理人可重複使用工具定義的工具箱。
ToolboxPolicies	工具箱的政策配置，包括內容安全及其他治理設定。
ToolboxSearchPreviewToolboxTool	一個儲存在工具箱中的工具箱搜尋工具。
ToolboxShellContainerAutoEnvironment	一個自動配置的容器環境，用於儲存在工具箱中的殼層工具。
ToolboxShellContainerReferenceEnvironment	一個儲存在工具箱中的殼殼工具的現有容器環境。
ToolboxShellEnvironment	一個儲存在工具箱中的殼層工具執行環境。此環境模型僅限於工具箱配置，且不修改 OpenAI 殼層環境合約。
ToolboxShellNetworkPolicy	自動配置工具箱殼容器的網路存取政策。
ToolboxShellNetworkPolicyDisabled	一個網路政策，能停用工具箱殼容器的外出存取。
ToolboxSkill	這是工具箱中包含的技能來源。
ToolboxSkillReference	指的是現有技能，可以納入工具箱。
ToolboxTool	工具箱中儲存的工具的抽象表示。
ToolboxVersionObject	一個特定版本的工具箱。
ToolboxVersions	與工具箱相關的版本。
ToolboxesCreateVersionOptionalParams	選擇性參數。
ToolboxesDeleteOptionalParams	選擇性參數。
ToolboxesDeleteVersionOptionalParams	選擇性參數。
ToolboxesGetOptionalParams	選擇性參數。
ToolboxesGetVersionOptionalParams	選擇性參數。
ToolboxesInvokeLatestToolboxMcpOptionalParams	選擇性參數。
ToolboxesListOptionalParams	選擇性參數。
ToolboxesListVersionsOptionalParams	選擇性參數。
ToolboxesOperations	介面代表工具箱操作。
ToolboxesUpdateOptionalParams	選擇性參數。
TracesDataGenerationJobOptions	關於 Traces 類型資料產生工作的選項。
TracesDataGenerationJobSource	資料產生工作的追蹤來源——來自 Application Insights 的對話追蹤。
TracesEvaluatorGenerationJobSource	評估員產生工作來源的追蹤來源——來自 Application Insights。
TranscriptTextUsageDuration	依音訊輸入時長計費的模型使用統計數據。
TranscriptTextUsageTokens	以代幣使用量計費的模型使用統計數據。
TranscriptTextUsageTokensInputTokenDetails	model interface TranscriptTextUsageTokensInputTokenDetails
TranscriptionLanguage	一種在轉錄音頻中偵測到的語言。
Trigger	排程觸發程式的基礎模型。
TwilioTelephonyBinding	一本由語音經紀人擁有的 Twilio 裝訂。
TwilioTelephonyBindingListItem	Twilio 綁定在包含其實體標籤的清單中回傳。
UpdateModelVersionRequest	請求更新模型版本的身體。只能修改描述和標籤。
UpdateTelephonyBindingRequest	更新現有電話綁定的請求。每個屬性都是可選的，綁定的提供者是不變的。
UpdateToolboxRequest	模型介面 UpdateToolboxRequest
UserProfileMemoryItem	專門包含從對話中提取的用戶個人資料信息的記憶項目，例如偏好、興趣和個人詳細信息。
VersionIndicator	版本指示器決定支援該會話的代理版本。
VersionRefIndicator	版本指示器，會以名稱參考特定代理版本。
VersionSelectionRule	model interface VersionSelectionRule
VersionSelector	model interface 版本選擇器
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	非同步輸入-音訊轉錄配置。擴展 OpenAI 即時轉錄選項，加入 Azure 與 MAI 轉錄模型、自訂語音模型及短語提示。
VoiceAgentInterimResponseConfig	由中間反應配置共享的欄位。
VoiceAgentLlmGeneratedGreetingConfig	由會話模型根據有範圍的開場回合提示書撰寫的問候語。
VoiceAgentLlmInterimResponseConfig	由語言模型產生的臨時回應。
VoiceAgentMcpTool	語音代理可用的 MCP 工具。
VoiceAgentNoiseReduction	輸入音訊降噪配置。
VoiceAgentRealtimeClientConnectOptions	連接即時客戶端與語音代理的選項。
VoiceAgentRealtimeClientOptions	Voice Agents 即時客戶端的選項。
VoiceAgentRealtimeResponse	語音代理服務在兩場`response.createdresponse.done`賽事中即時回應。
VoiceAgentRealtimeResponseBase	語音代理服務回傳的即時回應所共享的屬性。
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	更新即時會話的選項。
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 信封擁有語音代理儲存的逐字稿、回應、每回合指標和音訊。它是父、保留和刪除的邊界：刪除會連帶到回應、項目、指標和音訊。當 finalization 失敗時，任何部分持續的回應、項目和項目音訊仍可讀取。
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` 是 Foundry 耐用排序延伸。
VoiceResponseAudio	回應的音訊設定。遵循 OpenAI 即時通用存取物 `audio` 的形狀。
VoiceResponseAudioOutput	平坦響應的音訊輸出投影，可選 `voice`的、 `voice_type`、 `voice_locale`和 `format` 場。
VoiceResponseBase	持續語音回應所共有的特性。
WebIQPreviewTool	一個 WebIQ 伺服器端工具。
WebIQPreviewToolboxTool	一個儲存在工具箱中的 WebIQ 工具。
WebSearchApproximateLocation	使用者的大致位置。
WebSearchConfiguration	bing 自訂搜尋的網頁搜尋設定
WebSearchPreviewTool	此工具會在網路上搜尋相關結果，以供回應使用。了解更多關於 web 搜尋工具。
WebSearchTool	在網路上搜尋與該題目的相關來源。了解更多關於 web 搜尋工具。
WebSearchToolFilters	模型介面 WebSearchToolFilters
WebSearchToolboxTool	一個儲存在工具箱中的網路搜尋工具。
WeeklyRecurrenceSchedule	每週週期排程。
WorkIQPreviewTool	一個 WorkIQ 伺服器端工具。
WorkIQPreviewToolboxTool	一個儲存在工具箱中的 WorkIQ 工具。
WorkflowAgentDefinition	工作流程代理程式定義。

類型別名

A2AProtocolVersion	支援 A2A 協定版本。
ActivityProtocolAccessBoundary	活動協定的存取邊界。
AgentBlueprintReferenceType	代理藍圖參考類型
AgentBlueprintReferenceUnion	AgentBlueprintReferenceUnion 的別名
AgentDefinitionOptInKeys	功能選擇加入鍵可用於支援條件預覽功能的代理定義操作。
AgentDefinitionUnion	所有代理程式定義類型的聯合類型。支援工作流程、託管、容器應用程式、提示詞及外部代理。
AgentEndpoint	在代理端點進行路由、協定與授權的配置。
AgentEndpointAuthorizationSchemeType	Agent EndpointAuthorizationSchemeType 類型
AgentEndpointAuthorizationSchemeUnion	AgentEndpointAuthorizationSchemeUnion 的別名
AgentHarnessUnion	AgentHarnessUnion 的別名
AgentIdentityStatus	代理身份的狀態，適用於代理實例身份與代理藍圖。
AgentInsightJsonValue	一個用於 Agent Insights payload 的 JSON 值。
AgentInsightOverviewSource	確認 Agent Insights 總覽的來源。
AgentInsightPromptSurface	提示表因提出的修正而改變。
AgentInsightProposedFixKind	客戶可渲染的那種客服洞察建議的解決方案。
AgentInsightRunTrigger	觸發了一次特工洞察跑法。
AgentInsightSeverity	代理人洞察的嚴重性。
AgentInsightStatus	代理洞察的生命週期狀態。
AgentKind	定義代理的類型/種類。決定使用哪個代理程式定義結構。
AgentOptimizationDatasetInputType	資料集輸入聯集的判別值。
AgentOptimizationDatasetInputUnion	AgentOptimizationDatasetInputUnion 別名
AgentProtocol	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	容器網路政策參數類型
ContainerNetworkPolicyParamUnion	Alias for ContainerNetworkPolicyParamUnion
ContainerSkillType	容器類型技能類型
ContainerSkillUnion	ContainerSkillUnion 的別名
ContinuablePage	描述結果頁面的介面。
CreateTelephonyBindingRequestUnion	Alias for CreateTelephonyBindingRequestUnion
CreateTranscriptionResponseJsonUsageType	CreateTranscriptionResponseJsonUsageType 的類型
CreateTranscriptionResponseJsonUsageUnion	Alias for CreateTranscriptionResponseJsonUsageUnion
CredentialType	連接使用的憑證類型
CustomToolParamFormatType	CustomToolParamFormatType 類型
CustomToolParamFormatUnion	Alias for CustomToolParamFormatUnion
DataGenerationJobOptionsUnion	DataGenerationJobOptionsUnion 的別名
DataGenerationJobOutputType	支援的資料產生工作輸出檔案類型。
DataGenerationJobOutputUnion	DataGenerationJobOutputUnion 的別名
DataGenerationJobOutputWriteMode	支援資料產生工作輸出的寫入模式。
DataGenerationJobScenario	支援的資料產生工作情境。
DataGenerationJobSourceType	支援的資料產生工作來源類型。
DataGenerationJobSourceUnion	DataGenerationJobSourceUnion 的別名
DataGenerationJobType	支援的資料產生工作類型。
DatasetType	要判斷數據類型的列舉。
DatasetVersionUnion	DatasetVersionUnion 的別名
DayOfWeek	週期性排程的星期幾。
DeploymentType	DeploymentType 類型
DeploymentUnion	DeploymentUnion 的別名
DigitalWorkerType	那種數位工作者。
DownloadVersionResponse	指定技能版本的 ZIP 壓縮檔，會以瀏覽器 Blob 或 Node.js 可讀串流形式公開。
EvaluationLevel	評估所進行的層級。
EvaluationRuleActionType	評估動作的類型。
EvaluationRuleActionUnion	EvaluationRuleActionUnion 的別名
EvaluationRuleEventType	評估規則事件的類型。
EvaluationTargetUnion	評估別名TargetUnion
EvaluationTaxonomyInputType	評估分類輸入的類型。
EvaluationTaxonomyInputUnion	評估的別名TaxonomyInputUnion
EvaluatorCategory	評估者的類別
EvaluatorDefinitionType	評估者定義的類型
EvaluatorDefinitionUnion	EvaluatorDefinitionUnion 的別名
EvaluatorGenerationJobSourceType	評估器產生工作所支援的原始碼類型。
EvaluatorGenerationJobSourceUnion	EvaluatorGenerationJobSourceUnion 的別名
EvaluatorMetricDirection	指標的方向，指出值越高越好、值越低越好，還是中性
EvaluatorMetricType	評估者的類型
EvaluatorType	評估者的類型
FileContents	二進位檔內容的有效值。
Filters	過濾器別名
FoundryFeaturesOptInKeys	鑄造廠類型功能OptInKeys
FoundryModelArtifactProfileCategory	文物輪廓分類。
FoundryModelArtifactProfileSignal	在模型偽影中偵測到的訊號。
FoundryModelSourceType	模型的來源類型。
FoundryModelWarningCode	模型文物警告代碼。
FoundryModelWeightType	模型的重量類型。
FunctionShellToolParamEnvironmentType	功能類型ShellToolParamEnvironmentType
FunctionShellToolParamEnvironmentUnion	FunctionShellToolParamEnvironmentUnion 的別名
GenerateAgentRequest	針對特定類型的輸入，用於產生和創建代理人。
GenerationWarningType	在生成的評估版本中出現警告類別。可擴充，因此能引入新的警示類別（例如安全、輸出品質）而不造成破壞性變更。
GetMicrosoft365PackageResponse	為 Foundry 代理產生的 Microsoft 365 二進位應用程式套件。
GitHubCopilotBuiltInTool	一個客戶可自訂的 GitHub Copilot 內建工具。
GitHubIssueEvent	已知的 GitHub 議題事件，可以觸發例行程序。
GrammarSyntax	文法句法類型
ImageGenAction	ImageGenAction 類型
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 應用程式的發佈範圍。
MisalignmentErrorType	一種行為的分類，可能與使用者的意圖不符。可能會回傳額外的數值。
NodeReadableStream	輸入別名 Node.js ReadableStream。在節點目標上，這會解析成實際的 NodeJS.ReadableStream 類型。在瀏覽器/react-native 目標上，平台變體會解析為 `never`，這會自然退出聯集類型。
OpenApiAuthDetailsUnion	OpenApiAuthDetailsUnion 的別名
OpenApiAuthType	OpenApi 終端節點的身份驗證類型。可使用的型別如下：匿名（無需身份驗證） Project 連線（需project_connection_id端點，依照 AI Foundry 設定） Managed_Identity （需要受眾進行基於身份的身份驗證）
OperationState	列舉描述允許的作業狀態。
OptimizationAgentIdentifier	識別註冊的 Foundry 代理及可選版本以進行優化。
OptimizationCandidate	配置變更及代理優化候選者的彙整評估結果。
OptimizationDatasetCriterion	一個命名的評估指令，用於評分優化資料集項目。
OptimizationDatasetInput	提供給代理優化作業的內嵌或註冊資料集的基礎描述。
OptimizationDatasetInputType	支援的優化資料集輸入形式：內嵌項目或註冊資料集參考。
OptimizationDatasetInputUnion	作為內嵌項目提供的優化資料集，或是註冊的 Foundry 資料集參考。
OptimizationDatasetItem	一個包含查詢、預期答案及評估標準的內嵌優化資料集項目。
OptimizationEvaluatorRef	以代理人優化工作中對評估器的名稱及可選版本的參考。
OptimizationInlineDatasetInput	優化資料集項目直接提供於請求主體中。
OptimizationJob	一個追蹤輸入、進度、狀態及候選人評估結果的代理優化工作。
OptimizationJobInputs	代理人、資料集、評估器及選項，提供給代理人優化作業。
OptimizationJobListItem	一個由列表操作返回的代理優化工作摘要。
OptimizationJobProgress	一個包含完成候選人數量、最佳分數及經過執行時間的進度快照。
OptimizationJobResult	評估過的候選人及基準與最佳候選人的識別碼，來自優化工作。
OptimizationOptions	控制代理人優化工作候選人產生、模型選擇及評估的設定。
OptimizationReferenceDatasetInput	以名稱及可選版本參考註冊的 Foundry 資料集，用於代理優化。
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`、 `lowmediumhighxhigh`和。減少推理工作可能會導致回應更快，以及回應中用於推理的權杖較少。 `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	Alias for 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 資料產生工作所支援的問題類型。
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	ToolboxShellNetworkPolicyUnion 的別名
ToolboxSkillUnion	ToolboxSkillUnion 的別名
ToolboxToolType	支援存放在工具箱中的工具類型。
ToolboxToolUnion	ToolboxToolUnion 的別名
ToolboxesInvokeLatestToolboxMcpResponse	最新的 Toolbox MCP 端點回覆了這個回應。
TreatmentEffectType	治療效果類型。
TriggerType	觸發程式的類型。
TriggerUnion	TriggerUnion 的別名
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 模型。隨著時間推移，可能會加入額外的數值。
VoiceAgentInterimResponseConfigUnion	VoiceAgentInterimResponseConfigUnion 的別名
VoiceAgentInterimResponseTrigger	一種可能觸發臨時反應的狀況。
VoiceAgentMaxOutputTokens	最大輸出標記數或字面 `inf`值。
VoiceAgentNoiseReductionType	輸入音訊降噪模式。
VoiceAgentRealtimeErrorCode	Voice Agents 即時客戶端所發出的錯誤代碼。
VoiceAgentRealtimeEvent	來自語音代理即時連線的事件。已知事件保留其產生的類型與正規化。未識別的線路類型會被 VoiceAgentUnknownEvent 包裹。切換 `type` 到窄範圍已知事件，或 `type === "unknown"` 在將事件交給已知事件處理者前排除。
VoiceAgentServerEvent	服務透過語音代理 WebSocket 傳送的穩定 v1 訊息。
VoiceAgentSessionIncludeOption	語音代理會話可能包含在服務輸出中的額外欄位。
VoiceAgentSessionResponse	有效的會話配置會在語音代理會話生命週期事件中回傳。
VoiceAgentSessionUpdate	語音代理會話更新事件接受會話設定。
VoiceAgentSubagentAbortReason	次級代理人諮詢被中止的原因。
VoiceAgentSystemToolName	一個服務管理的語音會話控制動作。已知值是穩定的;隨著時間推移，可能會增加更多值。
VoiceAgentSystemToolUnion	VoiceAgentSystemToolUnion 的別名
VoiceAgentToolChoice	語音代理工具選擇行為。
VoiceAgentToolResponseScheduling	當工具呼叫產生後續回應時，隨著時間推移，可能會加入額外的數值。
VoiceAgentToolUnion	VoiceAgentToolUnion 的別名
VoiceAgentTransport	用於語音代理連線的傳輸方式。
VoiceAgentTurnDetectionConfigUnion	VoiceAgentTurnDetectionConfigUnion 的別名
VoiceAgentTurnDetectionType	轉向偵測策略。隨著時間推移，可能會加入額外的數值。
VoiceAgentWebSocketMessage	一則透過已建立的語音代理 WebSocket 交換的 JSON 文字訊息。音訊位元組以 base64 編碼於 JSON 事件欄位中。
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

類型

RestErrorConstructor

KnownVoiceAgentConnectionState

語音代理即時連線報告的 VoiceAgentConnectionState 已知值。

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

類型

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