@azure/ai-projects package

類別

AIProjectClient

獲得 OpenAI 客戶端,並可選 OpenAI 客戶端選項

介面

@azure/ai-projects.Index
A2APreviewTool

實作 A2A 通訊協定的代理程式。

A2APreviewToolboxTool

一個存放在工具箱裡的A2A工具。

A2AProtocolConfiguration

針對 A2A 協定的專屬配置。

AIProjectClientOptionalParams

用戶端的選擇性參數。

AISearchIndexResource

AI 搜尋索引資源。

ActivityProtocolConfiguration

針對活動協定的專屬設定。

Agent

模型介面代理

AgentBlueprintReference

模型介面 AgentBlueprintReference

AgentCard

模型介面 AgentCard

AgentCardSkill

model interface AgentCardSkill

AgentClusterInsightRequest

對代理評估結果集的見解

AgentClusterInsightResult

來自代理程式叢集分析的見解。

AgentDataGenerationJobSource

資料產生任務的代理來源 — 參考代理以擷取指令與元資料。

AgentDefinition

代理程式的基本定義介面。 包含代理程式種類和選用 RAI 組態。

AgentEndpointAuthorizationScheme

模型介面 AgentEndpointAuthorizationScheme

AgentEndpointConfig

model interface AgentEndpointConfig

AgentEvaluatorGenerationJobSource

評估器產生任務的代理來源 — 參考代理以擷取指令與元資料。

AgentIdentity

模型介面代理識別碼

AgentSessionResource

一個提供長期計算沙盒的代理會話,用於託管代理調用。

AgentTaxonomyInput

當輸入類型為代理程式時,評估分類的輸入組態。

AgentVersion

代表代理程式的特定版本。 包括中繼資料、版本設定、建立時間和代理程式定義。

AgenticIdentityPreviewCredentials

代理程式身分認證定義

AgentsCreateAgentFromManifestOptionalParams

選擇性參數。

AgentsCreateAgentVersionFromManifestOptionalParams

選擇性參數。

AgentsCreateOptionalParams

選擇性參數。

AgentsCreateSessionOptionalParams

選擇性參數。

AgentsCreateVersionFromCodeOptionalParams

選擇性參數。

AgentsCreateVersionOptionalParams

選擇性參數。

AgentsDeleteOptionalParams

選擇性參數。

AgentsDeleteSessionFileOptionalParams

選擇性參數。

AgentsDeleteSessionOptionalParams

選擇性參數。

AgentsDeleteVersionOptionalParams

選擇性參數。

AgentsDisableOptionalParams

選擇性參數。

AgentsDownloadAgentCodeOptionalParams

選擇性參數。

AgentsDownloadSessionFileOptionalParams

選擇性參數。

AgentsEnableOptionalParams

選擇性參數。

AgentsGetOptionalParams

選擇性參數。

AgentsGetSessionLogStreamOptionalParams

選擇性參數。

AgentsGetSessionOptionalParams

選擇性參數。

AgentsGetVersionOptionalParams

選擇性參數。

AgentsListOptionalParams

選擇性參數。

AgentsListSessionFilesOptionalParams

選擇性參數。

AgentsListSessionsOptionalParams

選擇性參數。

AgentsListVersionsOptionalParams

選擇性參數。

AgentsOperations

代表代理程式作業的介面。

AgentsStopSessionOptionalParams

選擇性參數。

AgentsUpdateAgentFromManifestOptionalParams

選擇性參數。

AgentsUpdateAgentObjectOptionalParams

選擇性參數。

AgentsUpdateOptionalParams

選擇性參數。

AgentsUploadSessionFileOptionalParams

選擇性參數。

ApiErrorResponse

API 失敗的錯誤回應。

ApiKeyCredentials

API Key 憑證定義

ApplyPatchToolParam

允許助理使用統一差異來建立、刪除或更新檔案。

ApproximateLocation

模型介面 近似位置

ArtifactProfile

模型的工件剖面

AutoCodeInterpreterToolParam

程式代碼解釋器容器的設定。 選擇性地指定要執行程式碼之檔案的識別碼。

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 model configuration. API 版本將由服務選擇以查詢模型。

BaseCredentials

連接憑證的基類

BetaAgentsCancelOptimizationJobOptionalParams

選擇性參數。

BetaAgentsCreateOptimizationJobOptionalParams

選擇性參數。

BetaAgentsDeleteOptimizationJobOptionalParams

選擇性參數。

BetaAgentsGetOptimizationJobOptionalParams

選擇性參數。

BetaAgentsListOptimizationJobsOptionalParams

選擇性參數。

BetaAgentsOperations

介面代表 BetaAgents 的操作。

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

選擇性參數。

BingCustomSearchConfiguration

一個 bing 自訂搜尋設定。

BingCustomSearchPreviewTool

Bing 自訂搜尋工具的輸入定義資訊,用於設定代理。

BingCustomSearchToolParameters

bing 自訂搜尋工具的參數。

BingGroundingSearchConfiguration

搜尋 Bing 接地設定

BingGroundingSearchToolParameters

bing 接地搜尋工具的參數。

BingGroundingTool

bing 接地搜尋工具的輸入定義資訊,用於設定代理。

BlobReference

Blob 引用詳細資訊。

BotServiceAuthorizationScheme

模型介面 BotServiceAuthorizationScheme

BotServiceRbacAuthorizationScheme

模型介面 BotServiceRbacAuthorizationScheme

BotServiceTenantAuthorizationScheme

模型介面 BotServiceTenantAuthorizationScheme

BrowserAutomationPreviewTool

瀏覽器自動化工具的輸入定義資訊,用於設定代理程式。

BrowserAutomationPreviewToolboxTool

一個儲存在工具箱中的瀏覽器自動化工具。

BrowserAutomationToolConnectionParameters

「瀏覽器自動化工具」所使用連線的輸入參數定義。

BrowserAutomationToolParameters

瀏覽器自動化工具的輸入參數定義。

CaptureStructuredOutputsTool

用於捕獲結構化輸出的工具

ChartCoordinate

分析圖表的座標。

ChatSummaryMemoryItem

包含從對話中提取的摘要的記憶項目。

ClusterInsightResult

來自叢集分析的見解。

ClusterTokenUsage

叢集分析的記號使用量

CodeBasedEvaluatorDefinition

使用 python 程式碼的程式碼型評估器定義

CodeConfiguration

託管代理的程式碼部署配置。

CodeInterpreterTool

一個能執行 Python 程式碼以協助生成回應提示的工具。

CodeInterpreterToolboxTool

一個儲存在工具箱中的程式碼直譯工具。

ComparisonFilter

篩選器用於使用定義的比較操作將指定的屬性鍵與給定值進行比較。

CompoundFilter

使用 andor結合多個篩選。

ComputerTool

控制虛擬電腦的工具。 了解 有關計算機工具的更多信息。

ComputerUsePreviewTool

控制虛擬電腦的工具。 了解 有關計算機工具的更多信息。

Connection

來自清單的回應和獲取連接作

ConnectionsGetOptionalParams

選擇性參數。

ConnectionsGetWithCredentialsOptionalParams

選擇性參數。

ConnectionsListOptionalParams

選擇性參數。

ConnectionsOperations

表示 Connections作的介面。

ContainerAutoParam

model interface ContainerAutoParam

ContainerConfiguration

基於容器的託管代理部署配置。

ContainerNetworkPolicyAllowlistParam

model interface ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyDisabledParam

model interface ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDomainSecretParam

model interface ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyParam

容器的網路存取政策。

ContainerSkill

模型介面 ContainerSkill

ContinuousEvaluationRuleAction

持續評估的評估規則動作。

CosmosDBIndex

CosmosDB 向量存儲索引定義

CreateAgentVersionFromCodeContent

多部分請求機構,用於更新或設定基於程式碼的代理程式(POST /agents/{name} 及 POST /agents/{name}/versions)。

CreateAgentVersionFromCodeMetadata

用於程式碼驅動代理操作(建立、更新、建立版本)的 JSON 元資料。 代理名稱來自 URL 路徑參數或 x-ms-agent-name 標頭,因此不包含在此模型中。 內容雜湊(zip 的 SHA-256)會被載入 x-ms-code-zip-sha256 標頭。

CreateSkillVersionFromFilesBody

多部分請求文,用於從檔案建立技能版本。 可接受單一壓縮檔或多個技能檔案(目錄上傳)。 對於壓縮檔上傳,伺服器會解壓並驗證內容。 對於目錄上傳,檔案會被驗證 as-is。

CronTrigger

基於 Cron 的觸發器。

CustomCredential

自定義憑證定義

CustomGrammarFormatParam

一種由使用者定義的文法。

CustomRoutineTrigger

一個自訂事件例程觸發器。

CustomTextFormatParam

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

CustomToolParam

一個自訂工具,能依照指定格式處理輸入。 了解更多關於 custom 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 追蹤。 每個用戶端實例都維護其獨立的追蹤設定。

GitHubIssueRoutineTrigger

一個 GitHub 問題例程觸發器。

HeaderTelemetryEndpointAuth

基於標頭的遙測端點秘密認證。 解析後的秘密值會以 HTTP 標頭形式注入。

HostedAgentDefinition

託管代理程式定義。

HourlyRecurrenceSchedule

每小時週期計劃。

HumanEvaluationPreviewRuleAction

人工評估的評估規則動作。

HybridSearchOptions

模型介面 HybridSearchOptions

ImageGenTool

一個利用 GPT 影像模型生成影像的工具。

ImageGenToolInputImageMask

模型介面 ImageGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

選擇性參數。

IndexesDeleteOptionalParams

選擇性參數。

IndexesGetOptionalParams

選擇性參數。

IndexesListOptionalParams

選擇性參數。

IndexesListVersionsOptionalParams

選擇性參數。

IndexesOperations

表示 Indexes作的介面。

InlineSkillParam

model interface InlineSkillParam

InlineSkillSourceParam

線上技能載荷

Insight

叢集深入解析的回應內文。

InsightCluster

分析樣本的叢集。

InsightGenerationRequest

請求機構以產生洞察。

InsightModelConfiguration

深入解析產生中使用的模型的組態。

InsightRequest

深入解析報告的要求。

InsightResult

見解的結果。

InsightSample

分析樣本。

InsightScheduleTask

排程的洞察任務。

InsightSummary

錯誤叢集分析的摘要。

InsightsMetadata

有關見解的中繼資料。

InvocationsProtocolConfiguration

針對呼叫協定的專屬設定。

InvocationsWsProtocolConfiguration

專為基於 WebSocket 的呼叫協定設定。

InvokeAgentInvocationsApiDispatchPayload

手動有效載荷用於測試呼叫 API 例程派遣。

InvokeAgentInvocationsApiRoutineAction

透過原始調用 API 派遣例程。 必須提供agent_name或agent_endpoint_id中的一個。

InvokeAgentResponsesApiDispatchPayload

手動有效載荷用於測試回應的 API 例程派遣。

InvokeAgentResponsesApiRoutineAction

透過回應 API 派遣例程。 必須提供agent_name或agent_endpoint_id中的一個。

LocalShellToolParam

允許模型在本機環境中執行殼層命令的工具。

LocalSkillParam

model interface LocalSkillParam

LoraConfig

LoRA 模型專用的轉接器元資料。 驅動在部署時執行引擎配置。

MCPTool

透過遠端模型情境協定(MCP)伺服器,讓模型能夠存取更多工具。 了解更多關於MCP

MCPToolFilter

一個篩選物件用來指定允許使用哪些工具。

MCPToolRequireApproval

model interface MCPToolRequireApproval

MCPToolboxTool

一個存放在工具箱中的 MCP 工具。

ManagedAgentIdentityBlueprintReference

model interface ManagedAgentIdentityBlueprintReference

ManagedAzureAISearchIndex

Managed Azure AI 搜尋服務 Index Definition

McpProtocolConfiguration

針對 MCP 協定的專屬配置。

MemoryItem

儲存在記憶體存放區中的單一記憶體項目,包含內容和中繼資料。

MemoryOperation

代表對記憶體項目執行的單一記憶體作業 (建立、更新或刪除)。

MemorySearchItem

從記憶體搜尋擷取的記憶體項目。

MemorySearchOptions

記憶體搜尋選項。

MemorySearchPreviewTool

將記憶整合到智能體中的工具。

MemoryStore

可以儲存和檢索使用者記憶的記憶體儲存。

MemoryStoreDefaultDefinition

預設記憶體存放區實作。

MemoryStoreDefaultOptions

預設記憶體存放區組態。

MemoryStoreDefinition

記憶體存放區組態的基本定義。

MemoryStoreDeleteScopeResponse

從範圍中刪除記憶體的回應。

MemoryStoreOperationUsage

記憶體存放區作業的使用統計資料。

MemoryStoreSearchResponse

記憶體搜尋回應。

MemoryStoreUpdateCompletedResult

記憶體更新結果。

MemoryStoreUpdateResponse

提供記憶體存放區更新作業的狀態。

MicrosoftFabricPreviewTool

Microsoft Fabric 工具的輸入定義資訊,用於配置代理。

ModelCredentialRequest

請求取得模型資產的憑證。

ModelDeployment

模型部署定義

ModelDeploymentSku

Sku 資訊

ModelPendingUploadRequest

代表一個待上傳模型版本的請求。

ModelPendingUploadResponse

代表模型待上傳請求的回應。

ModelSamplingParams

代表一組用於控制語言模型在文字生成過程中取樣行為的參數。

ModelSourceData

模型來源資訊

ModelVersion

模型版本定義

MonthlyRecurrenceSchedule

每月週期排程。

NamespaceToolParam

群組功能/自訂工具在共享命名空間下。

NoAuthenticationCredentials

不需要身份驗證的憑據

OneTimeTrigger

一次性觸發。

OpenAIClientOptionsWithAzureAgent

擴展 OpenAI 客戶端選項可包含 Azure Agent 端點配置。

OpenApiAnonymousAuthDetails

OpenApi 匿名驗證的安全性詳細數據

OpenApiAuthDetails

OpenApiFunctionDefinition 的驗證詳細數據

OpenApiFunctionDefinition

openapi 函式的輸入定義資訊。

OpenApiManagedAuthDetails

OpenApi managed_identity驗證的安全性詳細數據

OpenApiManagedSecurityScheme

OpenApi managed_identity 驗證的安全性配置

OpenApiProjectConnectionAuthDetails

OpenApi project 連線驗證的安全細節

OpenApiProjectConnectionSecurityScheme

OpenApi managed_identity 驗證的安全性配置

OpenApiTool

OpenAPI 工具的輸入定義資訊,用來設定代理程式。

OpenApiToolboxTool

一個儲存在工具箱中的 OpenAPI 工具。

OptimizationAgentIdentifier

識別註冊的 Foundry 代理進行優化(僅限請求)。 技能、工具與system_prompt在options.optimization_config中明確規定。

OptimizationCandidate

針對單一候選代理配置在所有任務中的彙整評估結果。

OptimizationDatasetCriterion

評估標準:用於逐題評分的名稱+指令對。

OptimizationDatasetInput

以基準區分模型輸入資料集。 要麼是內嵌項目,要麼是註冊的參考資料。

OptimizationDatasetItem

內嵌資料集中的單一項目。

OptimizationEvaluatorRef

參考一個命名的評估器,可選擇性地釘選到某個版本。

OptimizationInlineDatasetInput

內嵌資料集 — 直接在請求主體中提供的項目。

OptimizationJob

代理優化工作資源 — 一個長期執行的工作,優化代理的配置(指令、模型、技能、工具)以最大化評估分數。 成功後,結果包含評分過的候選人。

OptimizationJobInputs

呼叫者提供的優化輸入。

OptimizationJobListItem

LIST 端點回傳的 Slim 工作表示。

OptimizationJobProgress

飛行進度;只有在狀態排隊或in_progress時才會被填入。

OptimizationJobResult

終端狀態結果機構。 當地位成功或失敗時即被填入。

OptimizationOptions

調校旋鈕和運行模式以進行優化工作。

OptimizationReferenceDatasetInput

參考已註冊的 Foundry 資料集。

OtlpTelemetryEndpoint

一個 OTLP(OpenTelemetry 協定)遙測匯出端點。

PageSettings

追蹤分頁反覆運算設定的介面

PagedAsyncIterableIterator

介面,可讓異步反覆運算同時完成和逐頁執行。

PendingUploadRequest

表示對待上載的請求。

PendingUploadResponse

表示待處理上傳請求的回應

ProceduralMemoryItem

一個包含從對話中擷取的程序的記憶項目。

PromotionInfo

當候選人被部署到 Foundry 代理時所記錄的晉升元資料。

PromptAgentDefinition

提示代理人定義

PromptAgentDefinitionTextOptions

來自模型的文字回應組態選項。 可以是純文字或結構化 JSON 數據。

PromptBasedEvaluatorDefinition

基於提示的評估器

PromptDataGenerationJobSource

資料產生任務的提示來源 — 使用者提供的內嵌文字。

PromptEvaluatorGenerationJobSource

評估器產生任務的提示來源 — 使用者提供的內嵌文字。

ProtocolConfiguration

代理端點的每個協定設定。

ProtocolVersionRecord

單一通訊協定及其版本的記錄對映。

RaiConfig

負責任 AI (RAI) 內容篩選和安全功能的設定。

RankingOptions

模型介面 RankingOptions

Reasoning

僅限 GPT-5 與 O 系列車型理模型的配置選項。

RecurrenceSchedule

週期性排程模型。

RecurrenceTrigger

基於週期的觸發器。

RedTeam

紅隊詳情。

RedTeamTargetConfig

目標配置的抽象類。

ReminderPreviewToolboxTool

一個儲存在工具箱裡的提醒工具。

ResponseUsageInputTokensDetails

model interface 回應使用輸入代幣詳細資料

ResponseUsageOutputTokensDetails

model interface ResponseUsageOutputTokensDetails

ResponsesProtocolConfiguration

針對回應協定的專屬設定。

Routine

服務回傳的例行定義。

RoutineAction

例行動作的基礎模型。

RoutineDispatchPayload

手動調度有效載荷的基礎模型。

RoutineRun

從執行歷史 API 回傳的單一例程執行。

RoutineTrigger

例行觸發器的基礎模型。

RubricBasedEvaluatorDefinition

基於評分標準的評估器定義——儲存由產生 API 產生的維度。 同時用於品質與安全評估者。

SASTokenCredentials

共用存取簽名 (SAS) 認證定義

SasCredential

SAS 憑證定義

Schedule

排程模型。

ScheduleRoutineTrigger

一個反覆出現的基於克隆的例行程序觸發器。

ScheduleRun

排程執行模型。

ScheduleTask

排程任務模型。

SessionDirectoryEntry

目錄中只有一個條目。

SessionDirectoryListResponse

在會話沙盒中列出目錄的回應。

SessionFileWriteResponse

上傳檔案到會話沙盒時的回應。

SessionLogEvent

由託管代理會話日誌串流發出的單一 Server-Sent 事件框架。

每個影格包含 event 一個識別事件類型的欄位,以及 data 一個以純文字形式載有效載荷的欄位。 雖然目前 data 的有效載荷是 JSON 格式,但其結構並非合約性質——可能會出現額外的金鑰,格式也可能隨時間改變。 用戶端應視為 data 不透明字串,並可選擇嘗試 JSON 解析。

未來可能會新增新的事件類型。 客戶應優雅地忽略未被識別的事件類型。

線材格式:

event: log
data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting server on port 18080"}

event: log
data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"}
SharepointGroundingToolParameters

SharePoint 接地工具參數。

SharepointPreviewTool

用來設定代理程式的 Sharepoint 工具輸入定義資訊。

SimpleQnADataGenerationJobOptions

關於 SimpleQnA 類型的資料產生工作的選項。

Skill

一個技能資源。

SkillInlineContent

內嵌內容,幫助定義一個簡單技能,但不需要上傳檔案。 遵循 agentskills.io SKILL.md 規範。

SkillReferenceParam

模型介面 SkillReferenceParam

SkillVersion

某種技能的特定版本。

SpecificApplyPatchParam

執行工具呼叫時,強制模型呼叫apply_patch工具。

SpecificFunctionShellParam

當需要工具呼叫時,強制模型呼叫 shell 工具。

StructuredInputDefinition

可參與提示範本替換和工具引數繫結的結構化輸入。

StructuredOutputDefinition

一個由代理人能產生的結構化輸出。

TaxonomyCategory

分類類別定義。

TaxonomySubCategory

分類學子類別定義。

TelemetryConfig

客戶提供的遙測設定,用於匯出容器日誌、追蹤資料及指標。

TelemetryEndpoint

遙測匯出端點配置。

TelemetryEndpointAuth

遙測端點的認證設定。

TelemetryOperations

表示遙測作的介面

TextResponseFormat

物件,指定模型必須輸出的格式。 { "type": "json_schema" }設定會啟用結構化輸出,以確保模型符合您提供的 JSON 架構。 在結構 化輸出指南中進一步了解。 預設格式為 { "type": "text" },且沒有其他選項。 不建議用於 gpt-4o 及較新型號:* 設定啟用 { "type": "json_object" } 舊版 JSON 模式,確保模型產生的訊息是有效的 JSON。 對於支援它的模型,最好使用 。json_schema

TextResponseFormatConfiguration
TextResponseFormatConfigurationResponseFormatJsonObject
TextResponseFormatConfigurationResponseFormatText
TextResponseFormatJsonObject

JSON 物件回應格式。 產生 JSON 回應的較舊方法。 針對支援它的模型,建議使用 json_schema 。 請注意,模型不會產生 JSON,除非有系統或使用者訊息指示它這樣做。

TextResponseFormatJsonSchema

JSON 結構的回應格式。 用來產生結構化 JSON 回應。 進一步了解 結構化輸出

TextResponseFormatText

默認回應格式。 用來產生文字回應。

TimerRoutineTrigger

一個一次性計時器的例行觸發。

Tool

可用來產生回應的工具。

ToolChoiceAllowed

限制模型可用的工具於預先定義的集合。

ToolChoiceCodeInterpreter

指出模型應該使用內建工具來產生回應。 了解更多內建工具

ToolChoiceComputer

指出模型應該使用內建工具來產生回應。 了解更多內建工具

ToolChoiceComputerUse

指出模型應該使用內建工具來產生回應。 了解更多內建工具

ToolChoiceComputerUsePreview

指出模型應該使用內建工具來產生回應。 了解更多內建工具

ToolChoiceCustom

用這個選項強制模型呼叫特定的自訂工具。

ToolChoiceFileSearch

指出模型應該使用內建工具來產生回應。 了解更多內建工具

ToolChoiceFunction

使用此選項可強制模型呼叫特定函式。

ToolChoiceImageGeneration

指出模型應該使用內建工具來產生回應。 了解更多內建工具

ToolChoiceMCP

使用此選項可強制模型在遠端 MCP 伺服器上呼叫特定工具。

ToolChoiceParam

模型應該如何選取產生回應時要使用的工具(或工具)。 tools請參閱 參數,以瞭解如何指定模型可以呼叫的工具。

ToolChoiceWebSearchPreview

指出模型應該使用內建工具來產生回應。 了解更多內建工具

ToolChoiceWebSearchPreview20250311

指出模型應該使用內建工具來產生回應。 了解更多內建工具

ToolConfig

依工具設定,控制工具的可見性與搜尋行為。

ToolDescription

客服專員可以使用的工具說明。

ToolProjectConnection

一個 project 連線資源。

ToolSearchToolParam

延遲工具的託管或自帶自帶工具搜尋設定。

ToolUseFineTuningDataGenerationJobOptions

關於 ToolUse 類型資料產生工作的選項。 僅用於微調場景。

ToolboxObject

一個儲存代理人可重複使用工具定義的工具箱。

ToolboxPolicies

工具箱的政策配置,包括內容安全及其他治理設定。

ToolboxSearchPreviewToolboxTool

一個儲存在工具箱中的工具箱搜尋工具。

ToolboxSkill

這是工具箱中包含的技能來源。

ToolboxSkillReference

指的是現有技能,可以納入工具箱。

ToolboxTool

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

ToolboxVersionObject

一個特定版本的工具箱。

ToolboxesCreateVersionOptionalParams

選擇性參數。

ToolboxesDeleteOptionalParams

選擇性參數。

ToolboxesDeleteVersionOptionalParams

選擇性參數。

ToolboxesGetOptionalParams

選擇性參數。

ToolboxesGetVersionOptionalParams

選擇性參數。

ToolboxesListOptionalParams

選擇性參數。

ToolboxesListVersionsOptionalParams

選擇性參數。

ToolboxesOperations

介面代表工具箱操作。

ToolboxesUpdateOptionalParams

選擇性參數。

TracesDataGenerationJobOptions

關於 Traces 類型資料產生工作的選項。

TracesDataGenerationJobSource

資料產生工作的追蹤來源——來自 Application Insights 的對話追蹤。

TracesEvaluatorGenerationJobSource

評估員產生工作來源的追蹤來源——來自 Application Insights。

Trigger

排程觸發程式的基礎模型。

UpdateModelVersionRequest

請求更新模型版本的身體。 只能修改描述和標籤。

UpdateToolboxRequest

模型介面 UpdateToolboxRequest

UserProfileMemoryItem

專門包含從對話中提取的用戶個人資料信息的記憶項目,例如偏好、興趣和個人詳細信息。

VersionIndicator

版本指示器決定支援該會話的代理版本。

VersionRefIndicator

版本指示器,會以名稱參考特定代理版本。

VersionSelectionRule

model interface VersionSelectionRule

VersionSelector

model interface 版本選擇器

WebSearchApproximateLocation

使用者的大致位置。

WebSearchConfiguration

bing 自訂搜尋的網頁搜尋設定

WebSearchPreviewTool

此工具會在網路上搜尋相關結果,以供回應使用。 了解更多關於 web 搜尋工具

WebSearchTool

在網路上搜尋與該題目的相關來源。 了解更多關於 web 搜尋工具

WebSearchToolFilters

模型介面 WebSearchToolFilters

WebSearchToolboxTool

一個儲存在工具箱中的網路搜尋工具。

WeeklyRecurrenceSchedule

每週週期排程。

WorkIQPreviewTool

一個 WorkIQ 伺服器端工具。

WorkIQPreviewToolboxTool

一個儲存在工具箱中的 WorkIQ 工具。

WorkflowAgentDefinition

工作流程代理程式定義。

類型別名

AgentBlueprintReferenceType

代理藍圖參考類型

AgentBlueprintReferenceUnion

AgentBlueprintReferenceUnion 的別名

AgentDefinitionOptInKeys

功能選擇加入鍵,用於支援託管或工作流程代理的代理定義操作。

AgentDefinitionUnion

所有代理程式定義類型的聯合類型。 支援工作流程、託管、容器應用程式、提示音及外部代理。

AgentEndpoint
AgentEndpointAuthorizationSchemeType

Agent EndpointAuthorizationSchemeType 類型

AgentEndpointAuthorizationSchemeUnion

AgentEndpointAuthorizationSchemeUnion 的別名

AgentKind

定義代理的類型/種類。 決定使用哪個代理程式定義結構。

AgentProtocol

AgentProtocol 的類型

AgentSessionStatus

代理會話狀態。

AgentState

代理人的運作狀態。

AgentType

代理類型

AgentVersionStatus

代理版本的配置狀態。

AgentsDownloadAgentCodeResponse
AgentsDownloadSessionFileResponse
AttackStrategy

攻擊策略。

AzureAISearchQueryType

Azure AI 搜尋服務 工具可用的查詢類型。

BaseCredentialsUnion

BaseCredentialsUnion 的別名

BetaSkillsDownloadResponse
CodeDependencyResolution

如何在部署時解決套件相依性,針對基於程式碼的託管代理。

ComparisonFilterValueItems

ComparisonFilterValueItems 的別名

ComputerEnvironment

電腦環境類型

ConnectionType

線上類型(或類別)

ContainerMemoryLimit

容器記憶體限制類型

ContainerNetworkPolicyParamType

容器網路政策參數類型

ContainerNetworkPolicyParamUnion

Alias for ContainerNetworkPolicyParamUnion

ContainerSkillType

容器類型技能類型

ContainerSkillUnion

ContainerSkillUnion 的別名

ContinuablePage

描述結果頁面的介面。

CredentialType

連接使用的憑證類型

CustomToolParamFormatType

CustomToolParamFormatType 類型

CustomToolParamFormatUnion

Alias for CustomToolParamFormatUnion

DataGenerationJobOptionsUnion

DataGenerationJobOptionsUnion 的別名

DataGenerationJobOutputType

支援的資料產生工作輸出檔案類型。

DataGenerationJobOutputUnion

DataGenerationJobOutputUnion 的別名

DataGenerationJobScenario

支援的資料產生工作情境。

DataGenerationJobSourceType

支援的資料產生工作來源類型。

DataGenerationJobSourceUnion

DataGenerationJobSourceUnion 的別名

DataGenerationJobType

支援的資料產生工作類型。

DatasetType

要判斷數據類型的列舉。

DatasetVersionUnion

DatasetVersionUnion 的別名

DayOfWeek

週期性排程的星期幾。

DeploymentType

DeploymentType 類型

DeploymentUnion

DeploymentUnion 的別名

DownloadVersionResponse
EvaluationLevel

評估所進行的層級。

EvaluationRuleActionType

評估動作的類型。

EvaluationRuleActionUnion

EvaluationRuleActionUnion 的別名

EvaluationRuleEventType

評估規則事件的類型。

EvaluationTargetUnion

評估別名TargetUnion

EvaluationTaxonomyInputType

評估分類輸入的類型。

EvaluationTaxonomyInputUnion

評估的別名TaxonomyInputUnion

EvaluatorCategory

評估者的類別

EvaluatorDefinitionType

評估者定義的類型

EvaluatorDefinitionUnion

EvaluatorDefinitionUnion 的別名

EvaluatorGenerationJobSourceType

評估器產生工作所支援的原始碼類型。

EvaluatorGenerationJobSourceUnion

EvaluatorGenerationJobSourceUnion 的別名

EvaluatorMetricDirection

指標的方向,指出值越高越好、值越低越好,還是中性

EvaluatorMetricType

評估者的類型

EvaluatorType

評估者的類型

FileContents

二進位檔內容的有效值。

Filters

過濾器別名

FoundryFeaturesOptInKeys

鑄造廠類型功能OptInKeys

FoundryModelArtifactProfileCategory

文物輪廓分類。

FoundryModelArtifactProfileSignal

在模型偽影中偵測到的訊號。

FoundryModelSourceType

模型的來源類型。

FoundryModelWarningCode

模型文物警告代碼。

FoundryModelWeightType

模型的重量類型。

FunctionShellToolParamEnvironmentType

功能類型ShellToolParamEnvironmentType

FunctionShellToolParamEnvironmentUnion

FunctionShellToolParamEnvironmentUnion 的別名

GitHubIssueEvent

已知的 GitHub 議題事件,可以觸發例行程序。

GrammarSyntax

文法句法類型

ImageGenAction

ImageGenAction 類型

IndexType

IndexType 的類型

IndexUnion

IndexUnion 的別名

InputFidelity

控制模型將發揮多少努力來比對輸入影像的樣式和特徵,尤其是臉部特徵。 此參數僅支援 gpt-image-1gpt-image-1.5 及 後續模型,不支援 gpt-image-1-mini。 支援 highlow。 預設為 low

InsightRequestUnion

InsightRequestUnion 的別名

InsightResultUnion

InsightResultUnion 的別名

InsightSampleUnion

InsightSampleUnion 的別名

InsightType

見解的要求。

JobStatus

鑄造廠職缺共享的可擴充狀態值。

MemoryItemKind

記憶體項目種類。

MemoryItemUnion

MemoryItemUnion 的別名

MemoryOperationKind

記憶體操作種類。

MemoryStoreDefinitionUnion

MemoryStoreDefinitionUnion 的別名

MemoryStoreKind

要使用的記憶體存放區實作類型。

MemoryStoreType

記憶體儲存類型

MemoryStoreUpdateStatus

記憶體存放區更新作業的狀態。

NodeReadableStream

輸入別名 Node.js ReadableStream。 在節點目標上,這會解析成實際的 NodeJS.ReadableStream 類型。 在瀏覽器/react-native 目標上,平台變體會解析為 never,這會自然退出聯集類型。

OpenApiAuthDetailsUnion

OpenApiAuthDetailsUnion 的別名

OpenApiAuthType

OpenApi 終端節點的身份驗證類型。 可使用的型別如下:

  • 匿名(無需身份驗證)
  • Project 連線(需project_connection_id端點,依照 AI Foundry 設定)
  • Managed_Identity (需要受眾進行基於身份的身份驗證)
OperationState

列舉描述允許的作業狀態。

OptimizationDatasetInputType

資料集輸入聯集的判別值。

OptimizationDatasetInputUnion

Alias for OptimizationDatasetInputUnion

PageOrder

頁面順序類型

PendingUploadType

待上傳的類型。

RankerVersionType

排名者類型版本類型

ReasoningEffort

限制 推理模型的推理工作。 目前支援的值為 noneminimallowmediumhighxhigh和 。 減少推理工作可能會導致回應更快,以及回應中用於推理的權杖較少。

  • gpt-5.1 預設為 none,但不執行推理。 支持的 gpt-5.1 推理值為 nonelowmediumhigh和 。 GPT-5.1 中支援所有推理值的工具呼叫。
  • 所有模型在預設推gpt-5.1理努力之前medium皆不支援none
  • gpt-5-pro 模型預設(且僅支持) high 推理努力。
  • xhigh 支援所有之後 gpt-5.1-codex-max的模型。
RecurrenceScheduleUnion

RecurrenceScheduleUnion 的別名

RecurrenceType

週期類型。

RedTeamTargetConfigUnion

Alias for RedTeamTargetConfigUnion

RiskCategory

攻擊目標的風險類別。

RoutineActionType

用於例行動作的判別值。

RoutineActionUnion

RoutineActionUnion 的別名

RoutineAttemptSource

已知的來源路徑,可以產生例行執行。

RoutineDispatchPayloadType

識別器值支援手動例行派遣有效載荷。

RoutineDispatchPayloadUnion

RoutineDispatchPayloadUnion 的別名

RoutineRunPhase

例行運行記錄的已知生命週期階段。

RoutineRunStatus

例行跑的狀態。

RoutineTriggerType

例行觸發器所支援的判別器值。

RoutineTriggerUnion

RoutineTriggerUnion 的別名

SampleType

分析中使用的樣本類型。

ScheduleProvisioningStatus

排程佈建狀態。

ScheduleTaskType

任務的類型。

ScheduleTaskUnion

ScheduleTaskUnion 的別名

SearchContentType

搜尋內容類型

SearchContextSize

搜尋類型ContextSize

SessionLogEventType

由託管代理會話日誌串流所發出的已知 SSE 事件類型。 未來版本可能會引入更多事件類型。

SimpleQnAFineTuningQuestionType

用於微調情境的 SimpleQnA 資料產生工作所支援的問題類型。

TelemetryDataKind

要匯出的遙測資料類型。

TelemetryEndpointAuthType

遙測端點的認證類型。

TelemetryEndpointAuthUnion

Alias for TelemetryEndpointAuthUnion

TelemetryEndpointKind

那種遙測匯出端點。

TelemetryEndpointUnion

Alias for TelemetryEndpointUnion

TelemetryTransportProtocol

遙測匯出的傳輸協定。

TextResponseFormatConfigurationType

文字類型回應格式配置類型

TextResponseFormatConfigurationUnion
TextResponseFormatUnion

TextResponseFormatUnion 的別名

ToolChoiceParamType

工具選擇類型參數類型

ToolChoiceParamUnion

ToolChoiceParamUnion 別名

ToolSearchExecutionType

工具類型搜尋執行類型

ToolType

工具類型

ToolUnion

ToolUnion 的別名

ToolboxSkillUnion

ToolboxSkillUnion 的別名

ToolboxToolType

支援存放在工具箱中的工具類型。

ToolboxToolUnion

ToolboxToolUnion 的別名

TreatmentEffectType

治療效果類型。

TriggerType

觸發程式的類型。

TriggerUnion

TriggerUnion 的別名

VersionIndicatorType

用於判斷支援會話代理版本的版本指示器類型。

VersionIndicatorUnion

VersionIndicatorUnion 的別名

VersionSelectionRuleType

版本選擇規則類型類型

VersionSelectionRuleUnion

VersionSelectionRuleUnion 的別名

列舉

KnownApiVersions

Microsoft Foundry API 版本

函式

isRestError(unknown)

RestError 的 Typeguard

變數

RestError

失敗管線要求的自定義錯誤類型。

函式詳細資料

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

參數

e

unknown

catch 子句攔截到的東西。

傳回

e

變數詳細資料

RestError

失敗管線要求的自定義錯誤類型。

RestError: RestErrorConstructor

類型