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

ToolSet class

包:: @azure/ai-agents

表示一组具有其定义和资源的工具。

属性

toolDefinitions	已添加到工具集的工具定义列表。
toolResources	与工具集中的工具关联的资源集合。

方法

addAzureAISearchTool(string, string)	将 Azure AI 搜索工具添加到工具集。
addBingGroundingTool(BingGroundingSearchConfiguration[])	将 Bing 接地搜索工具添加到工具集中。
addCodeInterpreterTool(string[], VectorStoreDataSource[])	将代码解释器工具添加到工具集。
addConnectedAgentTool(string, string, string)	将连接的代理工具添加到工具集。
addConnectionTool(connectionToolType, string[])	将连接工具添加到工具集。
addFabricTool(string)	将 Microsoft Fabric 工具添加到工具集。
addFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	将文件搜索工具添加到工具集。
addOpenApiTool(OpenApiFunctionDefinition)	将 OpenApi 工具添加到工具集。
addSharepointGroundingTool(string)	将 SharePoint 接地搜索工具添加到工具集中。

属性详细信息

toolDefinitions

已添加到工具集的工具定义列表。

toolDefinitions: ToolDefinition[]

属性值

ToolDefinition[]

toolResources

与工具集中的工具关联的资源集合。

toolResources: ToolResources

属性值

ToolResources

方法详细信息

addAzureAISearchTool(string, string)

将 Azure AI 搜索工具添加到工具集。

function addAzureAISearchTool(indexConnectionId: string, indexName: string): { definition: AzureAISearchToolDefinition, resources: ToolResources }

参数

indexConnectionId: string

Azure AI 搜索索引的连接 ID。

indexName: string

Azure AI 搜索索引的名称。

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

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

addBingGroundingTool(BingGroundingSearchConfiguration[])

将 Bing 接地搜索工具添加到工具集中。

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

参数

searchConfigurations: BingGroundingSearchConfiguration[]

{ definition: BingGroundingToolDefinition }

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

addCodeInterpreterTool(string[], VectorStoreDataSource[])

将代码解释器工具添加到工具集。

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

参数

fileIds: string[]

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

dataSources: VectorStoreDataSource[]

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

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

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

addConnectedAgentTool(string, string, string)

将连接的代理工具添加到工具集。

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

参数

id: string

连接的代理的 ID。

name: string

连接的代理的名称。

description: string

连接的代理的描述。

{ definition: ConnectedAgentToolDefinition }

包含 connected agent 工具定义的对象

addConnectionTool(connectionToolType, string[])

将连接工具添加到工具集。

function addConnectionTool(toolType: connectionToolType, connectionIds: string[]): { definition: ToolDefinition }

参数

toolType: connectionToolType

连接工具的类型。

connectionIds: string[]

要使用的连接的 ID 列表。

{ definition: ToolDefinition }

包含连接工具定义的对象

addFabricTool(string)

将 Microsoft Fabric 工具添加到工具集。

function addFabricTool(connectionId: string): { definition: MicrosoftFabricToolDefinition }

参数

connectionId: string

要使用的 Fabric 连接的 ID。

{ definition: MicrosoftFabricToolDefinition }

包含 Microsoft Fabric 工具定义的对象

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

将文件搜索工具添加到工具集。

function addFileSearchTool(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 }

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

addOpenApiTool(OpenApiFunctionDefinition)

将 OpenApi 工具添加到工具集。

function addOpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition): { definition: OpenApiToolDefinition }

参数

openApiFunctionDefinition: OpenApiFunctionDefinition

要使用的 OpenApi 函数定义。

{ definition: OpenApiToolDefinition }

包含 OpenApi 工具定义的对象

addSharepointGroundingTool(string)

将 SharePoint 接地搜索工具添加到工具集中。

function addSharepointGroundingTool(connectionId: string): { definition: SharepointToolDefinition }

参数

connectionId: string

SharePoint 搜索连接的 ID。

{ definition: SharepointToolDefinition }

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

通过

属性

方法