ToolSet class

Pakiet:

@azure/ai-agents

Reprezentuje zestaw narzędzi z ich definicjami i zasobami.

Właściwości

toolDefinitions	Lista definicji narzędzi, które zostały dodane do zestawu narzędzi.
toolResources	Kolekcja zasobów skojarzonych z narzędziami w zestawie narzędzi.

Metody

addAzureAISearchTool(string, string)	Dodaje narzędzie do wyszukiwania sztucznej inteligencji platformy Azure do zestawu narzędzi.
addBingGroundingTool(BingGroundingSearchConfiguration[])	Dodaje narzędzie do wyszukiwania uziemienia usługi Bing do zestawu narzędzi.
addCodeInterpreterTool(string[], VectorStoreDataSource[])	Dodaje narzędzie interpretera kodu do zestawu narzędzi.
addConnectedAgentTool(string, string, string)	Dodaje narzędzie połączonego agenta do zestawu narzędzi.
addConnectionTool(connectionToolType, string[])	Dodaje narzędzie połączenia do zestawu narzędzi.
addFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Dodaje narzędzie wyszukiwania plików do zestawu narzędzi.
addOpenApiTool(OpenApiFunctionDefinition)	Dodaje narzędzie OpenApi do zestawu narzędzi.

Szczegóły właściwości

toolDefinitions

Lista definicji narzędzi, które zostały dodane do zestawu narzędzi.

toolDefinitions: ToolDefinition[]

Wartość właściwości

ToolDefinition[]

toolResources

Kolekcja zasobów skojarzonych z narzędziami w zestawie narzędzi.

toolResources: ToolResources

Wartość właściwości

ToolResources

Szczegóły metody

addAzureAISearchTool(string, string)

Dodaje narzędzie do wyszukiwania sztucznej inteligencji platformy Azure do zestawu narzędzi.

function addAzureAISearchTool(indexConnectionId: string, indexName: string): { 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.

Zwraca

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

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

addBingGroundingTool(BingGroundingSearchConfiguration[])

Dodaje narzędzie do wyszukiwania uziemienia usługi Bing do zestawu narzędzi.

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

Parametry

searchConfigurations

BingGroundingSearchConfiguration[]

Zwraca

{ definition: BingGroundingToolDefinition }

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

addCodeInterpreterTool(string[], VectorStoreDataSource[])

Dodaje narzędzie interpretera kodu do zestawu narzędzi.

function addCodeInterpreterTool(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

addConnectedAgentTool(string, string, string)

Dodaje narzędzie połączonego agenta do zestawu narzędzi.

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

Parametry

id

string

Identyfikator połączonego agenta.

name

string

Nazwa połączonego agenta.

description

string

Opis połączonego agenta.

Zwraca

{ definition: ConnectedAgentToolDefinition }

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

addConnectionTool(connectionToolType, string[])

Dodaje narzędzie połączenia do zestawu narzędzi.

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

Parametry

toolType

connectionToolType

Typ narzędzia połączenia.

connectionIds

string[]

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

Zwraca

{ definition: ToolDefinition }

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

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

Dodaje narzędzie wyszukiwania plików do zestawu narzędzi.

function addFileSearchTool(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

addOpenApiTool(OpenApiFunctionDefinition)

Dodaje narzędzie OpenApi do zestawu narzędzi.

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

Parametry

openApiFunctionDefinition

OpenApiFunctionDefinition

Definicja funkcji OpenApi do użycia.

Zwraca

{ definition: OpenApiToolDefinition }

Obiekt zawierający definicję narzędzia OpenApi