ToolUtility class

Paket:

@azure/ai-agents

Hilfsprogrammklasse zum Erstellen verschiedener Tools.

Methoden

createAzureAISearchTool(string, string, AISearchIndexResource)	Erstellt ein Azure AI-Suchtool
createBingGroundingTool(BingGroundingSearchConfiguration[])	Erstellt ein Suchwerkzeug für die Bing-Erdung
createCodeInterpreterTool(string[], VectorStoreDataSource[])	Erstellt ein Codedolmetschertool
createConnectedAgentTool(string, string, string)	Erstellt ein Tool für verbundene Agenten.
createConnectionTool(connectionToolType, string[])	Erstellt ein Verbindungstool
createFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Erstellt ein Dateisuchtool
createFunctionTool(FunctionDefinition)	Erstellt ein Funktionstool.
createOpenApiTool(OpenApiFunctionDefinition)	Erstellt ein OpenApi-Tool

Details zur Methode

createAzureAISearchTool(string, string, AISearchIndexResource)

Erstellt ein Azure AI-Suchtool

static function createAzureAISearchTool(indexConnectionId: string, indexName: string, options?: AISearchIndexResource): { definition: AzureAISearchToolDefinition, resources: ToolResources }

Parameter

indexConnectionId

string

Die Verbindungs-ID des Azure AI-Suchindex.

indexName

string

Der Name des Azure AI-Suchindex.

options

AISearchIndexResource

Gibt zurück

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

Ein Objekt, das die Definition und Ressourcen für das Azure AI-Suchtool enthält.

createBingGroundingTool(BingGroundingSearchConfiguration[])

Erstellt ein Suchwerkzeug für die Bing-Erdung

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

Parameter

searchConfigurations

BingGroundingSearchConfiguration[]

Gibt zurück

{ definition: BingGroundingToolDefinition }

Ein Objekt, das die Definition und die Ressourcen für das Suchwerkzeug für die Bing-Erdung enthält

createCodeInterpreterTool(string[], VectorStoreDataSource[])

Erstellt ein Codedolmetschertool

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

Parameter

fileIds

string[]

Eine Liste mit Datei-IDs, die für das Tool code_interpreter zur Verfügung gestellt wurden. Dem Tool können maximal 20 Dateien zugeordnet sein.

dataSources

VectorStoreDataSource[]

Die zu verwendenden Datenquellen. Diese Option schließt sich gegenseitig mit FileIds aus.

Gibt zurück

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

Ein Objekt, das die Definition und Ressourcen für das Codedolmetschertool enthält.

createConnectedAgentTool(string, string, string)

Erstellt ein Tool für verbundene Agenten.

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

Parameter

id

string

name

string

description

string

Gibt zurück

{ definition: ConnectedAgentToolDefinition }

Ein Objekt, das die Definition für das verbundene Agentenwerkzeug enthält.

createConnectionTool(connectionToolType, string[])

Erstellt ein Verbindungstool

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

Parameter

toolType

connectionToolType

Der Typ des Verbindungstools.

connectionIds

string[]

Eine Liste der IDs der zu verwendenden Verbindungen.

Gibt zurück

{ definition: ToolDefinitionUnion }

Ein Objekt, das die Definition für das Verbindungstool enthält

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

Erstellt ein Dateisuchtool

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

Parameter

vectorStoreIds

string[]

Die ID des an diesen Agent angefügten Vektorspeichers. Der Agent kann maximal 1 Vektorspeicher zugeordnet sein.

vectorStores

VectorStoreConfigurations[]

Die Liste der Vektorspeicherkonfigurationsobjekte aus Azure. Diese Liste ist auf ein Element beschränkt. Das einzige Element dieser Liste enthält die Liste der azure-Objekt-IDs, die vom Suchtool verwendet werden.

definitionDetails

FileSearchToolDefinitionDetails

Die Eingabedefinitionsinformationen für ein Dateisuchtool, wie zum Konfigurieren eines Agents verwendet.

Gibt zurück

{ definition: FileSearchToolDefinition, resources: ToolResources }

Ein Objekt, das die Definition und Ressourcen für das Dateisuchtool enthält

createFunctionTool(FunctionDefinition)

Erstellt ein Funktionstool.

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

Parameter

functionDefinition

FunctionDefinition

Die zu verwendende Funktionsdefinition.

Gibt zurück

{ definition: FunctionToolDefinition }

Ein Objekt, das die Definition für das Funktionstool enthält.

createOpenApiTool(OpenApiFunctionDefinition)

Erstellt ein OpenApi-Tool

static function createOpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition): { definition: OpenApiToolDefinition }

Parameter

openApiFunctionDefinition

OpenApiFunctionDefinition

Die zu verwendende OpenApi-Funktionsdefinition.

Gibt zurück

{ definition: OpenApiToolDefinition }

Ein Objekt, das die Definition für das OpenApi-Tool enthält.