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

ToolUtility class

包:: @azure/ai-agents

用于创建各种工具的实用工具类。

方法

createAzureAISearchTool(string, string, AISearchIndexResource)	创建 Azure AI 搜索工具
createBingCustomSearchTool(BingCustomSearchConfiguration[])	创建必应自定义搜索工具
createBingGroundingTool(BingGroundingSearchConfiguration[])	创建 Bing 接地搜索工具
createCodeInterpreterTool(string[], VectorStoreDataSource[])	创建代码解释器工具
createConnectedAgentTool(string, string, string)	创建 Connected Agent 工具
createConnectionTool(connectionToolType, string[])	创建连接工具
createFabricTool(string)	创建 Microsoft Fabric 工具
createFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	创建文件搜索工具
createFunctionTool(FunctionDefinition)	创建函数工具
createOpenApiTool(OpenApiFunctionDefinition)	创建 OpenApi 工具
createSharepointGroundingTool(string)	创建 SharePoint 接地搜索工具

方法详细信息

createAzureAISearchTool(string, string, AISearchIndexResource)

创建 Azure AI 搜索工具

static function createAzureAISearchTool(indexConnectionId: string, indexName: string, options?: AISearchIndexResource): { definition: AzureAISearchToolDefinition, resources: ToolResources }

参数

indexConnectionId: string

Azure AI 搜索索引的连接 ID。

indexName: string

Azure AI 搜索索引的名称。

options: AISearchIndexResource

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

包含 Azure AI 搜索工具的定义和资源的对象。

createBingCustomSearchTool(BingCustomSearchConfiguration[])

创建必应自定义搜索工具

static function createBingCustomSearchTool(searchConfigurations: BingCustomSearchConfiguration[]): { definition: BingCustomSearchToolDefinition }

参数

searchConfigurations: BingCustomSearchConfiguration[]

必应搜索连接和 instanceName 的 ID。

{ definition: BingCustomSearchToolDefinition }

包含必应自定义搜索工具的定义和资源的对象

createBingGroundingTool(BingGroundingSearchConfiguration[])

创建 Bing 接地搜索工具

static function createBingGroundingTool(searchConfigurations: BingGroundingSearchConfiguration[]): { definition: BingGroundingToolDefinition }

参数

searchConfigurations: BingGroundingSearchConfiguration[]

{ definition: BingGroundingToolDefinition }

包含 bing 接地搜索工具的定义和资源的对象

createCodeInterpreterTool(string[], VectorStoreDataSource[])

创建代码解释器工具

static function createCodeInterpreterTool(fileIds?: string[], dataSources?: VectorStoreDataSource[]): { definition: CodeInterpreterToolDefinition, resources: ToolResources }

参数

fileIds: string[]

可供 code_interpreter 工具使用的文件 ID 列表。最多可以有 20 个与该工具关联的文件。

dataSources: VectorStoreDataSource[]

要使用的数据源。此选项与 fileId 互斥。

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

包含代码解释器工具的定义和资源的对象。

createConnectedAgentTool(string, string, string)

创建 Connected Agent 工具

static function createConnectedAgentTool(id: string, name: string, description: string): { definition: ConnectedAgentToolDefinition }

参数

id: string

name: string

description: string

{ definition: ConnectedAgentToolDefinition }

包含 connected agent 工具定义的对象。

createConnectionTool(connectionToolType, string[])

创建连接工具

static function createConnectionTool(toolType: connectionToolType, connectionIds: string[]): { definition: ToolDefinitionUnion }

参数

toolType: connectionToolType

连接工具的类型。

connectionIds: string[]

要使用的连接的 ID 列表。

{ definition: ToolDefinitionUnion }

包含连接工具定义的对象

createFabricTool(string)

创建 Microsoft Fabric 工具

static function createFabricTool(connectionId: string): { definition: MicrosoftFabricToolDefinition }

参数

connectionId: string

{ definition: MicrosoftFabricToolDefinition }

包含 Microsoft Fabric 工具定义的对象

createFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)

创建文件搜索工具

static function createFileSearchTool(vectorStoreIds?: string[], vectorStores?: VectorStoreConfigurations[], definitionDetails?: FileSearchToolDefinitionDetails): { definition: FileSearchToolDefinition, resources: ToolResources }

参数

vectorStoreIds: string[]

附加到此代理的向量存储的 ID。最多可以有 1 个向量存储附加到代理。

vectorStores: VectorStoreConfigurations[]

来自 Azure 的矢量存储配置对象列表。此列表限制为一个元素。此列表的唯一元素包含搜索工具使用的 Azure 资产 ID 列表。

definitionDetails: FileSearchToolDefinitionDetails

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

{ definition: FileSearchToolDefinition, resources: ToolResources }

包含文件搜索工具的定义和资源的对象

createFunctionTool(FunctionDefinition)

创建函数工具

static function createFunctionTool(functionDefinition: FunctionDefinition): { definition: FunctionToolDefinition }

参数

functionDefinition: FunctionDefinition

要使用的函数定义。

{ definition: FunctionToolDefinition }

一个对象，包含函数工具的定义。

createOpenApiTool(OpenApiFunctionDefinition)

创建 OpenApi 工具

static function createOpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition): { definition: OpenApiToolDefinition }

参数

openApiFunctionDefinition: OpenApiFunctionDefinition

要使用的 OpenApi 函数定义。

{ definition: OpenApiToolDefinition }

包含 OpenApi 工具定义的对象。

createSharepointGroundingTool(string)

创建 SharePoint 接地搜索工具

static function createSharepointGroundingTool(connectionId: string): { definition: SharepointToolDefinition }

参数

connectionId: string

SharePoint 搜索连接的 ID。

{ definition: SharepointToolDefinition }

包含 SharePoint 接地搜索工具的定义和资源的对象

通过

方法