ToolUtility class

Pakiet:

@azure/ai-agents

Klasa narzędzi do tworzenia różnych narzędzi.

Metody

createAzureAISearchTool(string, string, AISearchIndexResource)	Tworzy narzędzie wyszukiwania sztucznej inteligencji platformy Azure
createBingGroundingTool(BingGroundingSearchConfiguration[])	Tworzy narzędzie do wyszukiwania uziemienia Bing
createCodeInterpreterTool(string[], VectorStoreDataSource[])	Tworzy narzędzie interpretera kodu
createConnectedAgentTool(string, string, string)	Tworzy narzędzie połączonego agenta
createConnectionTool(connectionToolType, string[])	Tworzy narzędzie połączenia
createFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Tworzy narzędzie do wyszukiwania plików
createFunctionTool(FunctionDefinition)	Tworzy narzędzie funkcji
createOpenApiTool(OpenApiFunctionDefinition)	Tworzy narzędzie OpenApi

Szczegóły metody

createAzureAISearchTool(string, string, AISearchIndexResource)

Tworzy narzędzie wyszukiwania sztucznej inteligencji platformy Azure

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

Parametry

indexConnectionId

string

Identyfikator połączenia indeksu wyszukiwania usługi Azure AI.

indexName

string

Nazwa indeksu wyszukiwania usługi Azure AI.

options

AISearchIndexResource

Zwraca

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

Obiekt zawierający definicję i zasoby narzędzia do wyszukiwania sztucznej inteligencji platformy Azure.

createBingGroundingTool(BingGroundingSearchConfiguration[])

Tworzy narzędzie do wyszukiwania uziemienia Bing

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

Parametry

searchConfigurations

BingGroundingSearchConfiguration[]

Zwraca

{ definition: BingGroundingToolDefinition }

Obiekt zawierający definicję i zasoby narzędzia do wyszukiwania uziemienia usługi Bing

createCodeInterpreterTool(string[], VectorStoreDataSource[])

Tworzy narzędzie interpretera kodu

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

Parametry

fileIds

string[]

Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.

dataSources

VectorStoreDataSource[]

Źródła danych do użycia. Ta opcja wzajemnie wyklucza się z identyfikatorami fileId.

Zwraca

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

Obiekt zawierający definicję i zasoby narzędzia interpretera kodu.

createConnectedAgentTool(string, string, string)

Tworzy narzędzie połączonego agenta

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

Parametry

id

string

name

string

description

string

Zwraca

{ definition: ConnectedAgentToolDefinition }

Obiekt zawierający definicję narzędzia połączonego agenta.

createConnectionTool(connectionToolType, string[])

Tworzy narzędzie połączenia

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

Parametry

toolType

connectionToolType

Typ narzędzia połączenia.

connectionIds

string[]

Lista identyfikatorów połączeń do użycia.

Zwraca

{ definition: ToolDefinitionUnion }

Obiekt zawierający definicję narzędzia połączenia

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

Tworzy narzędzie do wyszukiwania plików

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

Parametry

vectorStoreIds

string[]

Identyfikator magazynu wektorów dołączony do tego agenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do agenta.

vectorStores

VectorStoreConfigurations[]

Lista obiektów konfiguracji magazynu wektorów z platformy Azure. Ta lista jest ograniczona do jednego elementu. Jedynym elementem tej listy jest lista identyfikatorów zasobów platformy Azure używanych przez narzędzie wyszukiwania.

definitionDetails

FileSearchToolDefinitionDetails

Informacje o definicji wejściowej narzędzia wyszukiwania plików używane do konfigurowania agenta.

Zwraca

{ definition: FileSearchToolDefinition, resources: ToolResources }

Obiekt zawierający definicję i zasoby narzędzia do wyszukiwania plików

createFunctionTool(FunctionDefinition)

Tworzy narzędzie funkcji

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

Parametry

functionDefinition

FunctionDefinition

Definicja funkcji do użycia.

Zwraca

{ definition: FunctionToolDefinition }

Obiekt zawierający definicję narzędzia funkcji.

createOpenApiTool(OpenApiFunctionDefinition)

Tworzy narzędzie OpenApi

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

Parametry

openApiFunctionDefinition

OpenApiFunctionDefinition

Definicja funkcji OpenApi do użycia.

Zwraca

{ definition: OpenApiToolDefinition }

Obiekt zawierający definicję narzędzia OpenApi.