ToolSet class

Pacote:

@azure/ai-agents

Representa um conjunto de ferramentas com suas definições e recursos.

Propriedades

toolDefinitions	Uma lista de definições de ferramentas que foram adicionadas ao conjunto de ferramentas.
toolResources	Uma coleção de recursos associados às ferramentas no conjunto de ferramentas.

Métodos

addAzureAISearchTool(string, string)	Adiciona uma ferramenta de pesquisa de IA do Azure ao conjunto de ferramentas.
addBingGroundingTool(BingGroundingSearchConfiguration[])	Adiciona uma ferramenta de pesquisa de aterramento do bing ao conjunto de ferramentas.
addCodeInterpreterTool(string[], VectorStoreDataSource[])	Adiciona uma ferramenta de interpretação de código ao conjunto de ferramentas.
addConnectedAgentTool(string, string, string)	Adiciona uma ferramenta de agente conectado ao conjunto de ferramentas.
addConnectionTool(connectionToolType, string[])	Adiciona uma ferramenta de conexão ao conjunto de ferramentas.
addFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Adiciona uma ferramenta de pesquisa de arquivos ao conjunto de ferramentas.
addOpenApiTool(OpenApiFunctionDefinition)	Adiciona uma ferramenta OpenApi ao conjunto de ferramentas.

Detalhes de Propriedade

toolDefinitions

Uma lista de definições de ferramentas que foram adicionadas ao conjunto de ferramentas.

toolDefinitions: ToolDefinition[]

Valor de Propriedade

ToolDefinition[]

toolResources

Uma coleção de recursos associados às ferramentas no conjunto de ferramentas.

toolResources: ToolResources

Valor de Propriedade

ToolResources

Detalhes de Método

addAzureAISearchTool(string, string)

Adiciona uma ferramenta de pesquisa de IA do Azure ao conjunto de ferramentas.

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

Parâmetros

indexConnectionId

string

A ID de conexão do índice de pesquisa da IA do Azure.

indexName

string

O nome do índice de pesquisa da IA do Azure.

Devoluções

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

Um objeto que contém a definição e os recursos para a ferramenta de pesquisa de IA do Azure

addBingGroundingTool(BingGroundingSearchConfiguration[])

Adiciona uma ferramenta de pesquisa de aterramento do bing ao conjunto de ferramentas.

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

Parâmetros

searchConfigurations

BingGroundingSearchConfiguration[]

Devoluções

{ definition: BingGroundingToolDefinition }

Um objeto que contém a definição e os recursos para a ferramenta de pesquisa de aterramento do bing

addCodeInterpreterTool(string[], VectorStoreDataSource[])

Adiciona uma ferramenta de interpretação de código ao conjunto de ferramentas.

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

Parâmetros

fileIds

string[]

Uma lista de IDs de arquivo disponibilizados para a code_interpreter ferramenta. Pode haver um máximo de 20 arquivos associados à ferramenta.

dataSources

VectorStoreDataSource[]

As fontes de dados a utilizar. Esta opção é mutuamente exclusiva com fileIds.

Devoluções

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

Um objeto que contém a definição e os recursos para a ferramenta de interpretador de código

addConnectedAgentTool(string, string, string)

Adiciona uma ferramenta de agente conectado ao conjunto de ferramentas.

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

Parâmetros

id

string

A ID do agente conectado.

name

string

O nome do agente conectado.

description

string

A descrição do agente conectado.

Devoluções

{ definition: ConnectedAgentToolDefinition }

Um objeto que contém a definição para a ferramenta de agente conectado

addConnectionTool(connectionToolType, string[])

Adiciona uma ferramenta de conexão ao conjunto de ferramentas.

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

Parâmetros

toolType

connectionToolType

O tipo da ferramenta de conexão.

connectionIds

string[]

Uma lista dos IDs das conexões a serem usadas.

Devoluções

{ definition: ToolDefinition }

Um objeto que contém a definição para a ferramenta de conexão

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

Adiciona uma ferramenta de pesquisa de arquivos ao conjunto de ferramentas.

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

Parâmetros

vectorStoreIds

string[]

A ID do repositório de vetores anexado a esse agente. Pode haver um máximo de 1 armazenamento vetorial anexado ao agente.

vectorStores

VectorStoreConfigurations[]

A lista de objetos de configuração de armazenamento de vetores do Azure. Esta lista é limitada a um elemento. O único elemento desta lista contém a lista de IDs de ativos azure usados pela ferramenta de pesquisa.

definitionDetails

FileSearchToolDefinitionDetails

As informações de definição de entrada para uma ferramenta de pesquisa de arquivo como usado para configurar um agente.

Devoluções

{ definition: FileSearchToolDefinition, resources: ToolResources }

Um objeto que contém a definição e os recursos para a ferramenta de pesquisa de arquivos

addOpenApiTool(OpenApiFunctionDefinition)

Adiciona uma ferramenta OpenApi ao conjunto de ferramentas.

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

Parâmetros

openApiFunctionDefinition

OpenApiFunctionDefinition

A definição de função OpenApi a ser usada.

Devoluções

{ definition: OpenApiToolDefinition }

Um objeto que contém a definição para a ferramenta OpenApi