OpenApiTool class

套件:

@azure/ai-agents

使用 OpenAPI 規格擷取資訊的工具。 使用初始 API 定義（名稱、描述、規格、身份驗證）初始化，此類還支持動態添加和刪除其他 API 定義。

建構函式

OpenApiTool(OpenApiFunctionDefinition)

建構函式會使用主要 API 定義初始化工具。

屬性

definitions	取得工具的所有 API 定義清單。
resources	取得代理程式的工具資源。 OpenApiTool 沒有特定資源，因此會傳回空白物件。

方法

addDefinition(OpenApiFunctionDefinition)	動態新增 API 定義。 如果已存在具有相同名稱的定義，則擲回。
createDefinition(OpenApiFunctionDefinition)	建立新的 API 定義。
removeDefinition(string)	根據其名稱移除 API 定義。 如果定義不存在，則擲回。

建構函式詳細資料

OpenApiTool(OpenApiFunctionDefinition)

建構函式會使用主要 API 定義初始化工具。

new OpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition)

參數

openApiFunctionDefinition

OpenApiFunctionDefinition

屬性詳細資料

definitions

取得工具的所有 API 定義清單。

OpenApiToolDefinition[] definitions

屬性值

OpenApiToolDefinition[]

resources

取得代理程式的工具資源。 OpenApiTool 沒有特定資源，因此會傳回空白物件。

ToolResources resources

屬性值

ToolResources

方法詳細資料

addDefinition(OpenApiFunctionDefinition)

動態新增 API 定義。 如果已存在具有相同名稱的定義，則擲回。

function addDefinition(openApiFunctionDefinition: OpenApiFunctionDefinition)

參數

openApiFunctionDefinition

OpenApiFunctionDefinition

createDefinition(OpenApiFunctionDefinition)

建立新的 API 定義。

static function createDefinition(openapi: OpenApiFunctionDefinition): OpenApiToolDefinition

參數

openapi

OpenApiFunctionDefinition

OpenApi 函數定義

傳回

OpenApiToolDefinition

建立的 API 定義

removeDefinition(string)

根據其名稱移除 API 定義。 如果定義不存在，則擲回。

function removeDefinition(name: string)

參數

name

string