ToolUtility class

Paquet:

@azure/ai-agents

Classe utilitaire pour la création de différents outils.

Méthodes

createAzureAISearchTool(string, string, AISearchIndexResource)	Crée un outil de recherche Azure AI
createBingGroundingTool(BingGroundingSearchConfiguration[])	Crée un outil de recherche d’ancrage Bing
createCodeInterpreterTool(string[], VectorStoreDataSource[])	Crée un outil d’interpréteur de code
createConnectedAgentTool(string, string, string)	Crée un outil d’agent connecté
createConnectionTool(connectionToolType, string[])	Crée un outil de connexion
createFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Crée un outil de recherche de fichiers
createFunctionTool(FunctionDefinition)	Crée un outil de fonction
createOpenApiTool(OpenApiFunctionDefinition)	Crée un outil OpenApi

Détails de la méthode

createAzureAISearchTool(string, string, AISearchIndexResource)

Crée un outil de recherche Azure AI

static function createAzureAISearchTool(indexConnectionId: string, indexName: string, options?: AISearchIndexResource): { 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.

options

AISearchIndexResource

Retours

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

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

createBingGroundingTool(BingGroundingSearchConfiguration[])

Crée un outil de recherche d’ancrage Bing

static function createBingGroundingTool(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

createCodeInterpreterTool(string[], VectorStoreDataSource[])

Crée un outil d’interpréteur de code

static function createCodeInterpreterTool(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.

createConnectedAgentTool(string, string, string)

Crée un outil d’agent connecté

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

Paramètres

id

string

name

string

description

string

Retours

{ definition: ConnectedAgentToolDefinition }

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

createConnectionTool(connectionToolType, string[])

Crée un outil de connexion

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

Paramètres

toolType

connectionToolType

Type de l’outil de connexion.

connectionIds

string[]

Liste des ID des connexions à utiliser.

Retours

{ definition: ToolDefinitionUnion }

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

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

Crée un outil de recherche de fichiers

static function createFileSearchTool(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

createFunctionTool(FunctionDefinition)

Crée un outil de fonction

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

Paramètres

functionDefinition

FunctionDefinition

Définition de fonction à utiliser.

Retours

{ definition: FunctionToolDefinition }

Objet contenant la définition de l’outil de fonction.

createOpenApiTool(OpenApiFunctionDefinition)

Crée un outil OpenApi

static function createOpenApiTool(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.