ToolSet class

Paquet:

@azure/ai-agents

Représente un ensemble d’outils avec leurs définitions et ressources.

Propriétés

toolDefinitions	Liste des définitions d’outils qui ont été ajoutées à l’ensemble d’outils.
toolResources	Collection de ressources associées aux outils de l’ensemble d’outils.

Méthodes

addAzureAISearchTool(string, string)	Ajoute un outil de recherche Azure AI à l’ensemble d’outils.
addBingGroundingTool(BingGroundingSearchConfiguration[])	Ajoute un outil de recherche d’ancrage Bing à l’ensemble d’outils.
addCodeInterpreterTool(string[], VectorStoreDataSource[])	Ajoute un outil d’interpréteur de code à l’ensemble d’outils.
addConnectedAgentTool(string, string, string)	Ajoute un outil d’agent connecté à l’ensemble d’outils.
addConnectionTool(connectionToolType, string[])	Ajoute un outil de connexion à l’ensemble d’outils.
addFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Ajoute un outil de recherche de fichiers à l’ensemble d’outils.
addOpenApiTool(OpenApiFunctionDefinition)	Ajoute un outil OpenApi à l’ensemble d’outils.

Détails de la propriété

toolDefinitions

Liste des définitions d’outils qui ont été ajoutées à l’ensemble d’outils.

toolDefinitions: ToolDefinition[]

Valeur de propriété

ToolDefinition[]

toolResources

Collection de ressources associées aux outils de l’ensemble d’outils.

toolResources: ToolResources

Valeur de propriété

ToolResources

Détails de la méthode

addAzureAISearchTool(string, string)

Ajoute un outil de recherche Azure AI à l’ensemble d’outils.

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

Paramètres

indexConnectionId

string

ID de connexion de l’index de recherche Azure AI.

indexName

string

Nom de l’index de recherche Azure AI.

Retours

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

Objet contenant la définition et les ressources de l’outil de recherche Azure AI

addBingGroundingTool(BingGroundingSearchConfiguration[])

Ajoute un outil de recherche d’ancrage Bing à l’ensemble d’outils.

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

Paramètres

searchConfigurations

BingGroundingSearchConfiguration[]

Retours

{ definition: BingGroundingToolDefinition }

Objet contenant la définition et les ressources de l’outil de recherche d’ancrage Bing

addCodeInterpreterTool(string[], VectorStoreDataSource[])

Ajoute un outil d’interpréteur de code à l’ensemble d’outils.

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

Paramètres

fileIds

string[]

Une liste des ID de fichier mis à la disposition de l’outil code_interpreter. Il peut y avoir un maximum de 20 fichiers associés à l’outil.

dataSources

VectorStoreDataSource[]

Sources de données à utiliser. Cette option s’exclue mutuellement avec les fileIds.

Retours

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

Objet contenant la définition et les ressources de l’outil d’interpréteur de code

addConnectedAgentTool(string, string, string)

Ajoute un outil d’agent connecté à l’ensemble d’outils.

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

Paramètres

id

string

ID de l’agent connecté.

name

string

Nom de l’agent connecté.

description

string

Description de l’agent connecté.

Retours

{ definition: ConnectedAgentToolDefinition }

Objet contenant la définition de l’outil agent connecté

addConnectionTool(connectionToolType, string[])

Ajoute un outil de connexion à l’ensemble d’outils.

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

Paramètres

toolType

connectionToolType

Type de l’outil de connexion.

connectionIds

string[]

Liste des ID des connexions à utiliser.

Retours

{ definition: ToolDefinition }

Objet contenant la définition de l’outil de connexion

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

Ajoute un outil de recherche de fichiers à l’ensemble d’outils.

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

Paramètres

vectorStoreIds

string[]

ID du magasin de vecteurs attaché à cet agent. Il peut y avoir un maximum de 1 magasin vectoriel attaché à l’agent.

vectorStores

VectorStoreConfigurations[]

Liste des objets de configuration de magasin de vecteurs à partir d’Azure. Cette liste est limitée à un élément. Le seul élément de cette liste contient la liste des ID de ressources Azure utilisés par l’outil de recherche.

definitionDetails

FileSearchToolDefinitionDetails

Informations de définition d’entrée pour un outil de recherche de fichiers tel qu’il est utilisé pour configurer un agent.

Retours

{ definition: FileSearchToolDefinition, resources: ToolResources }

Objet contenant la définition et les ressources de l’outil de recherche de fichiers

addOpenApiTool(OpenApiFunctionDefinition)

Ajoute un outil OpenApi à l’ensemble d’outils.

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

Paramètres

openApiFunctionDefinition

OpenApiFunctionDefinition

Définition de la fonction OpenApi à utiliser.

Retours

{ definition: OpenApiToolDefinition }

Objet contenant la définition de l’outil OpenApi