ToolSet class

Paquete:

@azure/ai-agents

Representa un conjunto de herramientas con sus definiciones y recursos.

Propiedades

toolDefinitions	Lista de definiciones de herramientas que se han agregado al conjunto de herramientas.
toolResources	Colección de recursos asociados a las herramientas del conjunto de herramientas.

Métodos

addAzureAISearchTool(string, string)	Agrega una herramienta de búsqueda de Azure AI al conjunto de herramientas.
addBingGroundingTool(BingGroundingSearchConfiguration[])	Agrega una herramienta de búsqueda de conexión a tierra de Bing al conjunto de herramientas.
addCodeInterpreterTool(string[], VectorStoreDataSource[])	Agrega una herramienta de intérprete de código al conjunto de herramientas.
addConnectedAgentTool(string, string, string)	Agrega una herramienta de agente conectada al conjunto de herramientas.
addConnectionTool(connectionToolType, string[])	Agrega una herramienta de conexión al conjunto de herramientas.
addFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Agrega una herramienta de búsqueda de archivos al conjunto de herramientas.
addOpenApiTool(OpenApiFunctionDefinition)	Agrega una herramienta OpenApi al conjunto de herramientas.

Detalles de las propiedades

toolDefinitions

Lista de definiciones de herramientas que se han agregado al conjunto de herramientas.

toolDefinitions: ToolDefinition[]

Valor de propiedad

ToolDefinition[]

toolResources

Colección de recursos asociados a las herramientas del conjunto de herramientas.

toolResources: ToolResources

Valor de propiedad

ToolResources

Detalles del método

addAzureAISearchTool(string, string)

Agrega una herramienta de búsqueda de Azure AI al conjunto de herramientas.

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

Parámetros

indexConnectionId

string

Identificador de conexión del índice de búsqueda de Azure AI.

indexName

string

Nombre del índice de búsqueda de Azure AI.

Devoluciones

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

Objeto que contiene la definición y los recursos de la herramienta de búsqueda de Azure AI

addBingGroundingTool(BingGroundingSearchConfiguration[])

Agrega una herramienta de búsqueda de conexión a tierra de Bing al conjunto de herramientas.

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

Parámetros

searchConfigurations

BingGroundingSearchConfiguration[]

Devoluciones

{ definition: BingGroundingToolDefinition }

Un objeto que contiene la definición y los recursos de la herramienta de búsqueda de conexión a tierra de Bing

addCodeInterpreterTool(string[], VectorStoreDataSource[])

Agrega una herramienta de intérprete de código al conjunto de herramientas.

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

Parámetros

fileIds

string[]

Lista de identificadores de archivo disponibles para la herramienta code_interpreter. Puede haber un máximo de 20 archivos asociados con la herramienta.

dataSources

VectorStoreDataSource[]

Orígenes de datos que se van a usar. Esta opción es mutuamente excluyente con fileIds.

Devoluciones

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

Objeto que contiene la definición y los recursos de la herramienta de intérprete de código

addConnectedAgentTool(string, string, string)

Agrega una herramienta de agente conectada al conjunto de herramientas.

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

Parámetros

id

string

El ID del agente conectado.

name

string

El nombre del agente conectado.

description

string

La descripción del agente conectado.

Devoluciones

{ definition: ConnectedAgentToolDefinition }

Un objeto que contiene la definición de la herramienta de agente conectada

addConnectionTool(connectionToolType, string[])

Agrega una herramienta de conexión al conjunto de herramientas.

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

Parámetros

toolType

connectionToolType

Tipo de la herramienta de conexión.

connectionIds

string[]

Lista de los identificadores de las conexiones que se van a usar.

Devoluciones

{ definition: ToolDefinition }

Objeto que contiene la definición de la herramienta de conexión

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

Agrega una herramienta de búsqueda de archivos al conjunto de herramientas.

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

Parámetros

vectorStoreIds

string[]

Identificador del almacén de vectores adjunto a este agente. Puede haber un máximo de 1 almacén de vectores asociado al agente.

vectorStores

VectorStoreConfigurations[]

La lista de objetos de configuración del almacén de vectores de Azure. Esta lista está limitada a un elemento. El único elemento de esta lista contiene la lista de identificadores de recursos de Azure usados por la herramienta de búsqueda.

definitionDetails

FileSearchToolDefinitionDetails

La información de definición de entrada de una herramienta de búsqueda de archivos como se usa para configurar un agente.

Devoluciones

{ definition: FileSearchToolDefinition, resources: ToolResources }

Objeto que contiene la definición y los recursos de la herramienta de búsqueda de archivos

addOpenApiTool(OpenApiFunctionDefinition)

Agrega una herramienta OpenApi al conjunto de herramientas.

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

Parámetros

openApiFunctionDefinition

OpenApiFunctionDefinition

Definición de la función OpenApi que se va a usar.

Devoluciones

{ definition: OpenApiToolDefinition }

Objeto que contiene la definición de la herramienta OpenApi