@azure/ai-projects package

類別

AIProjectClient

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

介面

@azure/ai-projects.Index
A2APreviewTool

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

AIProjectClientOptionalParams

用戶端的選擇性參數。

AISearchIndexResource

AI 搜尋索引資源。

Agent

模型介面代理

AgentClusterInsightRequest

對代理評估結果集的見解

AgentClusterInsightResult

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

AgentDefinition

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

AgentTaxonomyInput

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

AgentVersion

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

AgenticIdentityPreviewCredentials

代理程式身分認證定義

AgentsCreateAgentFromManifestOptionalParams

選擇性參數。

AgentsCreateAgentVersionFromManifestOptionalParams

選擇性參數。

AgentsCreateOptionalParams

選擇性參數。

AgentsCreateVersionOptionalParams

選擇性參數。

AgentsDeleteOptionalParams

選擇性參數。

AgentsDeleteVersionOptionalParams

選擇性參數。

AgentsGetOptionalParams

選擇性參數。

AgentsGetVersionOptionalParams

選擇性參數。

AgentsListOptionalParams

選擇性參數。

AgentsListVersionsOptionalParams

選擇性參數。

AgentsOperations

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

AgentsUpdateAgentFromManifestOptionalParams

選擇性參數。

AgentsUpdateOptionalParams

選擇性參數。

Annotation

一個適用於輸出文字範圍的註解。

ApiErrorResponse

API 失敗的錯誤回應。

ApiKeyCredentials

API Key 憑證定義

ApplyPatchCreateFileOperationParam

透過 apply_patch 工具建立新檔案的說明。

ApplyPatchDeleteFileOperationParam

透過 apply_patch 工具刪除現有檔案的說明。

ApplyPatchOperationParam

這是提供給apply_patch工具的create_file、delete_file或update_file操作之一。

ApplyPatchToolParam

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

ApplyPatchUpdateFileOperationParam

透過apply_patch工具更新現有檔案的說明。

ApproximateLocation

模型介面 近似位置

AzureAIAgentTarget

代表指定 Azure AI 代理程式的目標。

AzureAIModelTarget

代表一個目標,指定一個 Azure AI 模型用於需要模型選擇的操作。

AzureAISearchIndex

Azure AI 搜尋索引定義

AzureAISearchTool

用來設定代理程式的 Azure AI 搜尋工具輸入定義資訊。

AzureAISearchToolResource

azure_ai_search 工具所使用的一組索引資源。

AzureFunctionBinding

保留記憶體佇列名稱和 URI 的結構。

AzureFunctionDefinition

Azure 函式的定義。

AzureFunctionStorageQueue

保留記憶體佇列名稱和 URI 的結構。

AzureFunctionTool

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

AzureOpenAIModelConfiguration

Azure OpenAI 模型配置。 API 版本將由服務選擇以查詢模型。

BaseCredentials

連接憑證的基類

BetaEvaluationTaxonomiesCreateOptionalParams

選擇性參數。

BetaEvaluationTaxonomiesDeleteOptionalParams

選擇性參數。

BetaEvaluationTaxonomiesGetOptionalParams

選擇性參數。

BetaEvaluationTaxonomiesListOptionalParams

選擇性參數。

BetaEvaluationTaxonomiesOperations

介面代表 BetaEvaluationTaxonomies 操作。

BetaEvaluationTaxonomiesUpdateOptionalParams

選擇性參數。

BetaEvaluatorsCreateVersionOptionalParams

選擇性參數。

BetaEvaluatorsDeleteVersionOptionalParams

選擇性參數。

BetaEvaluatorsGetVersionOptionalParams

選擇性參數。

BetaEvaluatorsListLatestVersionsOptionalParams

選擇性參數。

BetaEvaluatorsListVersionsOptionalParams

選擇性參數。

BetaEvaluatorsOperations

介面代表 BetaEvaluator 的操作。

BetaEvaluatorsUpdateVersionOptionalParams

選擇性參數。

BetaInsightsGenerateOptionalParams

選擇性參數。

BetaInsightsGetOptionalParams

選擇性參數。

BetaInsightsListOptionalParams

選擇性參數。

BetaInsightsOperations

介面代表 BetaInsights 作業。

BetaMemoryStoresCreateOptionalParams

選擇性參數。

BetaMemoryStoresDeleteOptionalParams

選擇性參數。

BetaMemoryStoresDeleteScopeOptionalParams

選擇性參數。

BetaMemoryStoresGetOptionalParams

選擇性參數。

BetaMemoryStoresGetUpdateResultOptionalParams

選擇性參數。

BetaMemoryStoresListOptionalParams

選擇性參數。

BetaMemoryStoresOperations

介面代表 BetaMemoryStores 操作。

BetaMemoryStoresSearchMemoriesOptionalParams

選擇性參數。

BetaMemoryStoresUpdateMemoriesOptionalParams

選擇性參數。

BetaMemoryStoresUpdateOptionalParams

選擇性參數。

BetaOperations

介面代表 Beta 作業。

BetaRedTeamsCreateOptionalParams

選擇性參數。

BetaRedTeamsGetOptionalParams

選擇性參數。

BetaRedTeamsListOptionalParams

選擇性參數。

BetaRedTeamsOperations

介面代表 BetaRedTeams 的運作。

BetaSchedulesCreateOrUpdateOptionalParams

選擇性參數。

BetaSchedulesDeleteOptionalParams

選擇性參數。

BetaSchedulesGetOptionalParams

選擇性參數。

BetaSchedulesGetRunOptionalParams

選擇性參數。

BetaSchedulesListOptionalParams

選擇性參數。

BetaSchedulesListRunsOptionalParams

選擇性參數。

BetaSchedulesOperations

介面代表 BetaSchedules 作業。

BingCustomSearchConfiguration

必應自定義搜索配置。

BingCustomSearchPreviewTool

用於配置代理的必應自定義搜尋工具的輸入定義資訊。

BingCustomSearchToolParameters

必應自定義搜索工具參數。

BingGroundingSearchConfiguration

搜索 Bing Grounding 的配置

BingGroundingSearchToolParameters

bing 接地搜索工具參數。

BingGroundingTool

用於設定代理程式的 bing 地面搜尋工具輸入定義資訊。

BlobReference

Blob 引用詳細資訊。

BrowserAutomationPreviewTool

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

BrowserAutomationToolConnectionParameters

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

BrowserAutomationToolParameters

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

CaptureStructuredOutputsTool

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

ChartCoordinate

分析圖表的座標。

ChatSummaryMemoryItem

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

ClickParam

按一下動作。

ClusterInsightResult

來自叢集分析的見解。

ClusterTokenUsage

叢集分析的記號使用量

CodeBasedEvaluatorDefinition

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

CodeInterpreterContainerAuto

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

CodeInterpreterOutputImage

程式碼解釋器生成的圖像輸出。

CodeInterpreterOutputLogs

程式碼解釋器的日誌輸出。

CodeInterpreterTool

執行 Python 程式代碼以協助產生提示回應的工具。

ComparisonFilter

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

CompoundFilter

使用 andor結合多個篩選。

ComputerAction

模型介面 ComputerAction

ComputerCallSafetyCheckParam

電腦呼叫的擱置安全性檢查。

ComputerScreenshotImage

計算機螢幕快照影像,與計算機使用工具搭配使用。

ComputerUsePreviewTool

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

Connection

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

ConnectionsGetOptionalParams

選擇性參數。

ConnectionsGetWithCredentialsOptionalParams

選擇性參數。

ConnectionsListOptionalParams

選擇性參數。

ConnectionsOperations

表示 Connections作的介面。

ContainerAppAgentDefinition

容器應用程式代理程式定義。

ContainerFileCitationBody

一個用於產生模型回應的容器檔案引用。

ContinuousEvaluationRuleAction

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

CosmosDBIndex

CosmosDB 向量存儲索引定義

CronTrigger

基於 Cron 的觸發器。

CustomCredential

自定義憑證定義

CustomGrammarFormatParam

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

CustomTextFormatParam

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

CustomToolParam

一個自訂工具,能依照指定格式處理輸入。 了解更多自訂 工具

CustomToolParamFormat

自訂工具的輸入格式。 預設是無限制文字。

DailyRecurrenceSchedule

每日重複時間表。

DatasetCredential

表示對 blob 的引用以供使用

DatasetUploadOptions

上傳數據集的選項

DatasetVersion

DatasetVersion 定義

DatasetsCreateOrUpdateOptionalParams

選擇性參數。

DatasetsDeleteOptionalParams

選擇性參數。

DatasetsGetCredentialsOptionalParams

選擇性參數。

DatasetsGetOptionalParams

選擇性參數。

DatasetsListOptionalParams

選擇性參數。

DatasetsListVersionsOptionalParams

選擇性參數。

DatasetsOperations

表示 Datasets作的介面。

DatasetsPendingUploadOptionalParams

選擇性參數。

DeleteAgentResponse

已刪除的代理程式物件

DeleteAgentVersionResponse

已刪除的代理程式版本物件

DeleteMemoryStoreResponse

模型介面 DeleteMemoryStoreResponse

Deployment

模型部署定義

DeploymentsGetOptionalParams

選擇性參數。

DeploymentsListOptionalParams

選擇性參數。

DeploymentsOperations

表示 Deployment作的介面。

DoubleClickAction

按兩下動作。

Drag

拖曳動作。

DragPoint

x/y 座標組,例如 { x: 100, y: 200 }

EasyInputMessage

具有角色的訊息輸入至模型,指出下列階層的指示。 由 developersystem 角色給出的指示優先於由角色 user 給出的指示。 具有 assistant 角色的訊息被認為是在先前交互作用中由模型產生的。

EmbeddingConfiguration

嵌入配置類

EntraIDCredentials

EntraID 憑證定義

ErrorModel

模型介面錯誤模型

EvalResult

評估結果。

EvalRunResultCompareItem

治療與基線的度量比較。

EvalRunResultComparison

治療運行與基線的比較結果。

EvalRunResultSummary

評估執行中計量的摘要統計資料。

EvaluationComparisonInsightRequest

評估比較請求

EvaluationComparisonInsightResult

評估比較的見解。

EvaluationResultSample

評估結果中的樣本。

EvaluationRule

評估規則模型。

EvaluationRuleAction

評估行動模型。

EvaluationRuleFilter

評估篩選器模型。

EvaluationRulesCreateOrUpdateOptionalParams

選擇性參數。

EvaluationRulesDeleteOptionalParams

選擇性參數。

EvaluationRulesGetOptionalParams

選擇性參數。

EvaluationRulesListOptionalParams

選擇性參數。

EvaluationRulesOperations

代表 EvaluationRules 作業的介面。

EvaluationRunClusterInsightRequest

對評估結果集的見解

EvaluationRunClusterInsightResult

來自評估的深入解析會執行叢集分析。

EvaluationScheduleTask

排程的評估任務。

EvaluationTaxonomy

評估分類定義

EvaluationTaxonomyInput

評估分類法的輸入組態。

EvaluatorDefinition

具有鑑別器的基本評估器配置

EvaluatorMetric

評估者指標

EvaluatorVersion

評估者定義

FabricDataAgentToolParameters

Fabric 數據代理工具參數。

FieldMapping

欄位映射配置類

FileCitationBody

檔案的引文。

FileDatasetVersion

FileDatasetVersion 定義

FilePath

檔案的路徑。

FileSearchTool

從上傳的檔案搜尋相關內容的工具。 進一步瞭解 檔案搜尋工具

FileSearchToolCallResults

模型介面 FileSearchToolCallResults

FolderDatasetVersion

FileDatasetVersion 定義

FunctionAndCustomToolCallOutput

model interface FunctionAndCustomToolCallOutput

FunctionAndCustomToolCallOutputInputFileContent

模型的檔案輸入。

FunctionAndCustomToolCallOutputInputImageContent

輸入至模型的影像 瞭解 影像輸入

FunctionAndCustomToolCallOutputInputTextContent

模型的文字輸入。

FunctionShellActionParam

描述如何執行 shell 工具呼叫的指令與限制。

FunctionShellCallOutputContentParam

擷取 shell 工具呼叫輸出的一部分 stdout 和 stderr。

FunctionShellCallOutputExitOutcomeParam

表示 shell 指令已完成並回傳一個退出代碼。

FunctionShellCallOutputOutcomeParam

與此 shell 呼叫相關的退出或超時結果。

FunctionShellCallOutputTimeoutOutcomeParam

表示 shell 呼叫已超過設定時間限制。

FunctionShellToolParam

一個讓模型能執行 shell 指令的工具。

FunctionTool

在您自己的程式代碼中定義函式,模型可以選擇呼叫。 深入瞭解 函式呼叫

HostedAgentDefinition

託管代理程式定義。

HourlyRecurrenceSchedule

每小時週期計劃。

HumanEvaluationPreviewRuleAction

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

HybridSearchOptions

模型介面 HybridSearchOptions

ImageGenTool

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

ImageGenToolInputImageMask

模型介面 ImageGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

選擇性參數。

IndexesDeleteOptionalParams

選擇性參數。

IndexesGetOptionalParams

選擇性參數。

IndexesListOptionalParams

選擇性參數。

IndexesListVersionsOptionalParams

選擇性參數。

IndexesOperations

表示 Indexes作的介面。

InputContent

模型介面 InputContent

InputContentInputFileContent

模型的檔案輸入。

InputContentInputImageContent

輸入至模型的影像 瞭解 影像輸入

InputContentInputTextContent

模型的文字輸入。

InputFileContentParam

模型的檔案輸入。

InputImageContentParamAutoParam

輸入至模型的影像 了解 影像輸入

InputItem

一個代表部分情境的項目,供模型產生回應。 可包含文字、圖片與音訊輸入,以及先前的助理回應與工具呼叫輸出。

InputItemApplyPatchToolCallItemParam

一個工具呼叫,代表使用差異補丁建立、刪除或更新檔案的請求。

InputItemApplyPatchToolCallOutputItemParam

由 apply 修補工具呼叫所輸出的串流輸出。

InputItemCodeInterpreterToolCall

執行程式代碼的工具呼叫。

InputItemCompactionSummaryItemParam

API產生v1/responses/compact的壓縮項目。

InputItemComputerCallOutputItemParam

電腦工具呼叫的輸出。

InputItemComputerToolCall

對電腦使用工具發出的工具呼叫。 有關更多信息,請參閱 計算機使用指南

InputItemCustomToolCall

呼叫模型建立的自訂工具。

InputItemCustomToolCallOutput

你程式碼中自訂工具呼叫的輸出,會回傳給模型。

InputItemFileSearchToolCall

檔案搜尋工具呼叫的結果。 如需詳細資訊,請參閱 檔案搜尋指南

InputItemFunctionCallOutputItemParam

函式工具呼叫的輸出。

InputItemFunctionShellCallItemParam

一個代表執行一個或多個 shell 指令請求的工具。

InputItemFunctionShellCallOutputItemParam

由 shell 工具呼叫所輸出的串流輸出項目。

InputItemFunctionToolCall

執行函式的工具呼叫。 如需詳細資訊,請參閱 函式呼叫指南

InputItemImageGenToolCall

模型提出的圖像生成要求。

InputItemLocalShellToolCall

在本機殼層上執行命令的工具呼叫。

InputItemLocalShellToolCallOutput

本機 Shell 工具呼叫的輸出。

InputItemMcpApprovalRequest

要求人工核准工具叫用。

InputItemMcpApprovalResponse

對 MCP 核准申請的回應。

InputItemMcpListTools

MCP 伺服器上可用的工具清單。

InputItemMcpToolCall

MCP 伺服器上的工具叫用。

InputItemOutputMessage

來自模型的輸出訊息。

InputItemReasoningItem

產生回應時,推理模型所使用之思想鏈結的描述。 如果你手動input,務必將這些項目納入後續對話的回應 API。

InputItemWebSearchToolCall

網路搜尋工具呼叫的結果。 如需詳細資訊,請參閱 網路搜尋指南

InputTextContentParam

模型的文字輸入。

Insight

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

InsightCluster

分析樣本的叢集。

InsightModelConfiguration

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

InsightRequest

深入解析報告的要求。

InsightResult

見解的結果。

InsightSample

分析樣本。

InsightScheduleTask

排程的洞察任務。

InsightSummary

錯誤叢集分析的摘要。

InsightsMetadata

有關見解的中繼資料。

ItemReferenceParam

要參考之項目的內部識別碼。

KeyPressAction

模型想要執行的按鍵集合。

LocalShellExecAction

在伺服器上執行殼層命令。

LocalShellToolParam

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

LogProb

詞元的對數機率。

MCPListToolsTool

MCP 伺服器上可用的工具。

MCPListToolsToolAnnotations

模型介面 MCPListToolsToolAnnotations

MCPListToolsToolInputSchema

模型介面 MCPListToolsToolInputSchema

MCPTool

透過遠端模型內容通訊協定 (MCP) 伺服器,為模型提供其他工具的存取權。 進一步瞭解 MCP

MCPToolFilter

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

MCPToolRequireApproval

model interface MCPToolRequireApproval

ManagedAzureAISearchIndex

託管 Azure AI 搜索索引定義

MemoryItem

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

MemoryOperation

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

MemorySearchItem

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

MemorySearchOptions

記憶體搜尋選項。

MemorySearchPreviewTool

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

MemoryStore

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

MemoryStoreDefaultDefinition

預設記憶體存放區實作。

MemoryStoreDefaultOptions

預設記憶體存放區組態。

MemoryStoreDefinition

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

MemoryStoreDeleteScopeResponse

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

MemoryStoreOperationUsage

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

MemoryStoreSearchResponse

記憶體搜尋回應。

MemoryStoreUpdateCompletedResult

記憶體更新結果。

MemoryStoreUpdateResponse

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

MicrosoftFabricPreviewTool

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

ModelDeployment

模型部署定義

ModelDeploymentSku

Sku 資訊

ModelSamplingParams

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

MonthlyRecurrenceSchedule

每月週期排程。

Move

滑鼠移動動作。

NoAuthenticationCredentials

不需要身份驗證的憑據

OneTimeTrigger

一次性觸發。

OpenApiAnonymousAuthDetails

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

OpenApiAuthDetails

OpenApiFunctionDefinition 的驗證詳細數據

OpenApiFunctionDefinition

openapi 函式的輸入定義資訊。

OpenApiManagedAuthDetails

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

OpenApiManagedSecurityScheme

OpenApi managed_identity 驗證的安全性配置

OpenApiProjectConnectionAuthDetails

OpenApi 專案連線驗證的安全性詳細資料

OpenApiProjectConnectionSecurityScheme

OpenApi managed_identity 驗證的安全性配置

OpenApiTool

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

OutputMessageContent

模型介面 OutputMessageContent

OutputMessageContentOutputTextContent

模型的文字輸出。

OutputMessageContentRefusalContent

模型拒絕回應。

PageSettings

byPage 方法的選項

PagedAsyncIterableIterator

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

PendingUploadRequest

表示對待上載的請求。

PendingUploadResponse

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

PromptAgentDefinition

提示代理人定義

PromptAgentDefinitionTextOptions

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

PromptBasedEvaluatorDefinition

基於提示的評估器

ProtocolVersionRecord

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

RaiConfig

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

RankingOptions

模型介面 RankingOptions

Reasoning

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

ReasoningTextContent

模型的推理文本。

RecurrenceSchedule

週期性排程模型。

RecurrenceTrigger

基於週期的觸發器。

RedTeam

紅隊詳情。

ResponseUsageInputTokensDetails

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

ResponseUsageOutputTokensDetails

model interface ResponseUsageOutputTokensDetails

RestorePollerOptions
SASTokenCredentials

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

SasCredential

SAS 憑證定義

Schedule

排程模型。

ScheduleRun

排程執行模型。

ScheduleTask

排程任務模型。

Screenshot

螢幕擷取畫面動作。

Scroll

捲動動作。

SharepointGroundingToolParameters

SharePoint 接地工具參數。

SharepointPreviewTool

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

SpecificApplyPatchParam

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

SpecificFunctionShellParam

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

StructuredInputDefinition

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

StructuredOutputDefinition

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

Summary

模型的摘要文字。

Target

具有鑑別器支援的目標基底類別。

TargetConfig

目標配置的抽象類。

TaxonomyCategory

分類類別定義。

TaxonomySubCategory

分類學子類別定義。

TelemetryOperations

代表遙測操作的介面

TextResponseFormatConfiguration

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

TextResponseFormatConfigurationResponseFormatJsonObject

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

TextResponseFormatConfigurationResponseFormatText

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

TextResponseFormatJsonSchema

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

Tool

可用來產生回應的工具。

ToolChoiceAllowed

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

ToolChoiceCodeInterpreter

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

ToolChoiceComputerUsePreview

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

ToolChoiceCustom

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

ToolChoiceFileSearch

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

ToolChoiceFunction

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

ToolChoiceImageGeneration

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

ToolChoiceMCP

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

ToolChoiceParam

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

ToolChoiceWebSearchPreview

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

ToolChoiceWebSearchPreview20250311

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

ToolDescription

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

ToolProjectConnection

專案連線資源。

TopLogProb

詞元的最高對數機率。

Trigger

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

Type

要輸入文字的動作。

UrlCitationBody

用來產生模型回應之 Web 資源的引文。

UserProfileMemoryItem

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

VectorStoreFileAttributes

可附加至物件的索引鍵/值組 (16 個為一組)。 這很適合用來以結構化格式儲存物件的其他資訊,以及透過 API 或儀錶板查詢物件。 索引鍵是長度上限為64個字元的字串。 值是長度上限為 512 個字元、布爾值或數位的字串。

Wait

等候動作。

WebSearchActionFind

動作類型 「find」:在載入的頁面內搜尋模式。

WebSearchActionOpenPage

動作類型 「open_page」 - 從搜尋結果開啟特定的 URL。

WebSearchActionSearch

動作類型 「search」 - 執行 Web 搜尋查詢。

WebSearchActionSearchSources

模型介面 WebSearchActionSearchSources

WebSearchApproximateLocation

使用者的大致位置。

WebSearchConfiguration

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

WebSearchPreviewTool

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

WebSearchTool

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

WebSearchToolFilters

模型介面 WebSearchToolFilters

WeeklyRecurrenceSchedule

每週週期排程。

WorkflowAgentDefinition

工作流程代理程式定義。

類型別名

AgentDefinitionUnion

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

AgentKind

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

AgentProtocol

AgentProtocol 的類型

AgentType

代理類型

AnnotationType

註解類型類型

AnnotationUnion

AnnotationUnion 的別名

ApplyPatchCallOutputStatusParam

apply_patch工具呼叫輸出的結果值報告。

ApplyPatchCallStatusParam

apply_patch工具呼叫的狀態值報告。

ApplyPatchOperationParamType

ApplyPatchOperationParamType 的類型

ApplyPatchOperationParamUnion

ApplyPatchOperationParamUnion 的別名

AttackStrategy

攻擊策略。

AzureAISearchQueryType

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

BaseCredentialsUnion

BaseCredentialsUnion 的別名

ClickButtonType

ClickButtonType 類型

ComparisonFilterValueItems

ComparisonFilterValueItems 的別名

ComputerActionType

ComputerActionType 的類型

ComputerActionUnion

ComputerActionUnion 的別名

ComputerEnvironment

電腦環境類型

ConnectionType

線上類型(或類別)

ContainerMemoryLimit

容器記憶體限制類型

ContinuablePage

描述結果頁面的介面。

CredentialType

連接使用的憑證類型

CustomToolParamFormatType

CustomToolParamFormatType 類型

CustomToolParamFormatUnion

Alias for CustomToolParamFormatUnion

DatasetType

要判斷數據類型的列舉。

DatasetVersionUnion

DatasetVersionUnion 的別名

DayOfWeek

週期性排程的星期幾。

DeploymentType

DeploymentType 類型

DeploymentUnion

DeploymentUnion 的別名

DetailEnum

細節列舉類型

EvaluationRuleActionType

評估動作的類型。

EvaluationRuleActionUnion

EvaluationRuleActionUnion 的別名

EvaluationRuleEventType

評估規則事件的類型。

EvaluationTaxonomyInputType

評估分類輸入的類型。

EvaluationTaxonomyInputUnion

評估的別名TaxonomyInputUnion

EvaluatorCategory

評估者的類別

EvaluatorDefinitionType

評估者定義的類型

EvaluatorDefinitionUnion

EvaluatorDefinitionUnion 的別名

EvaluatorMetricDirection

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

EvaluatorMetricType

評估者的類型

EvaluatorType

評估者的類型

Filters

過濾器別名

FoundryFeaturesOptInKeys

鑄造廠類型功能OptInKeys

FunctionAndCustomToolCallOutputType

Type: of FunctionAndCustomToolCallOutputType

FunctionAndCustomToolCallOutputUnion

Alias for FunctionAndCustomToolCallOutputUnion

FunctionCallItemStatus

功能類型CallItemStatus

FunctionShellCallItemStatus

Shell 工具呼叫的狀態值報告。

FunctionShellCallOutputOutcomeParamType

功能類型ShellCallOutputOutcomeParamType

FunctionShellCallOutputOutcomeParamUnion

Alias for FunctionShellCallOutputOutcomeParamUnion

GrammarSyntax1

語法類型 語法

ImageDetail

影像細節類型

IndexType

IndexType 的類型

IndexUnion

IndexUnion 的別名

InputContentType

輸入內容類型

InputContentUnion

InputContentUnion 的別名

InputFidelity

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

InputItemType

輸入項目類型

InputItemUnion

InputItemUnion 的別名

InsightRequestUnion

InsightRequestUnion 的別名

InsightResultUnion

InsightResultUnion 的別名

InsightSampleUnion

InsightSampleUnion 的別名

InsightType

見解的要求。

MCPToolCallStatus

MCPToolCallStatus 類型

MemoryItemKind

記憶體項目種類。

MemoryItemUnion

MemoryItemUnion 的別名

MemoryOperationKind

記憶體操作種類。

MemoryStoreDefinitionUnion

MemoryStoreDefinitionUnion 的別名

MemoryStoreKind

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

MemoryStoreType

記憶體儲存類型

MemoryStoreUpdateStatus

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

OpenApiAuthDetailsUnion

OpenApiAuthDetailsUnion 的別名

OpenApiAuthType

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

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

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

OutputMessageContentType

輸出訊息內容類型

OutputMessageContentUnion

OutputMessageContentUnion 的別名

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

週期類型。

RiskCategory

攻擊目標的風險類別。

SampleType

分析中使用的樣本類型。

ScheduleProvisioningStatus

排程佈建狀態。

ScheduleTaskType

任務的類型。

ScheduleTaskUnion

ScheduleTaskUnion 的別名

SearchContextSize

搜尋類型ContextSize

TargetConfigUnion

TargetConfigUnion 的別名

TargetUnion

TargetUnion 的別名

TextResponseFormatConfigurationType

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

TextResponseFormatConfigurationUnion

TextResponseFormatConfigurationUnion 的別名

ToolChoiceParamType

工具選擇類型參數類型

ToolChoiceParamUnion

ToolChoiceParamUnion 別名

ToolType

工具類型

ToolUnion

ToolUnion 的別名

TreatmentEffectType

治療效果類型。

TriggerType

觸發程式的類型。

TriggerUnion

TriggerUnion 的別名

列舉

KnownApiVersions

Microsoft Foundry API 版本

函式

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

從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器,或在原始輪詢器不在範圍內之後建構投票器時,這非常有用。

函式詳細資料

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

從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器,或在原始輪詢器不在範圍內之後建構投票器時,這非常有用。

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

參數

serializedState

string

sourceOperation

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

傳回

PollerLike<OperationState<TResult>, TResult>