ToolUtility class

Balíček:

@azure/ai-agents

Utility třída pro vytváření různých nástrojů.

Metody

createAzureAISearchTool(string, string, AISearchIndexResource)	Vytvoří vyhledávací nástroj Azure AI.
createBingGroundingTool(BingGroundingSearchConfiguration[])	Vytvoří ukotvovací vyhledávací nástroj služby Bing
createCodeInterpreterTool(string[], VectorStoreDataSource[])	Vytvoří nástroj interpreta kódu.
createConnectedAgentTool(string, string, string)	Vytvoří připojený nástroj agenta
createConnectionTool(connectionToolType, string[])	Vytvoří nástroj pro připojení.
createFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Vytvoří nástroj pro vyhledávání souborů.
createFunctionTool(FunctionDefinition)	Vytvoří nástroj funkce.
createOpenApiTool(OpenApiFunctionDefinition)	Vytvoří nástroj OpenApi.

Podrobnosti metody

createAzureAISearchTool(string, string, AISearchIndexResource)

Vytvoří vyhledávací nástroj Azure AI.

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

Parametry

indexConnectionId

string

ID připojení indexu azure AI Search.

indexName

string

Název indexu azure AI Search.

options

AISearchIndexResource

Návraty

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

Objekt obsahující definici a prostředky pro nástroj Azure AI Search.

createBingGroundingTool(BingGroundingSearchConfiguration[])

Vytvoří ukotvovací vyhledávací nástroj služby Bing

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

Parametry

searchConfigurations

BingGroundingSearchConfiguration[]

Návraty

{ definition: BingGroundingToolDefinition }

Objekt obsahující definici a prostředky pro vyhledávací nástroj Bing Grounding Search

createCodeInterpreterTool(string[], VectorStoreDataSource[])

Vytvoří nástroj interpreta kódu.

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

Parametry

fileIds

string[]

Seznam ID souborů zpřístupněných nástroji code_interpreter . K nástroji může být přidruženo maximálně 20 souborů.

dataSources

VectorStoreDataSource[]

Zdroje dat, které se mají použít. Tato možnost se vzájemně vylučují s id souboru.

Návraty

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

Objekt obsahující definici a prostředky pro nástroj interpret kódu.

createConnectedAgentTool(string, string, string)

Vytvoří připojený nástroj agenta

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

Parametry

id

string

name

string

description

string

Návraty

{ definition: ConnectedAgentToolDefinition }

Objekt obsahující definici nástroje připojeného agenta.

createConnectionTool(connectionToolType, string[])

Vytvoří nástroj pro připojení.

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

Parametry

toolType

connectionToolType

Typ nástroje pro připojení.

connectionIds

string[]

Seznam ID připojení, která se mají použít.

Návraty

{ definition: ToolDefinitionUnion }

Objekt obsahující definici nástroje pro připojení

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

Vytvoří nástroj pro vyhledávání souborů.

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

Parametry

vectorStoreIds

string[]

ID vektorového úložiště připojeného k tomuto agentu. K agentu může být připojeno maximálně 1 vektorové úložiště.

vectorStores

VectorStoreConfigurations[]

Seznam objektů konfigurace úložiště vektorů z Azure Tento seznam je omezen na jeden prvek. Jediný prvek tohoto seznamu obsahuje seznam ID prostředků Azure používaných vyhledávacím nástrojem.

definitionDetails

FileSearchToolDefinitionDetails

Informace o definici vstupu pro nástroj pro vyhledávání souborů, jak se používá ke konfiguraci agenta.

Návraty

{ definition: FileSearchToolDefinition, resources: ToolResources }

Objekt obsahující definici a prostředky pro nástroj pro vyhledávání souborů

createFunctionTool(FunctionDefinition)

Vytvoří nástroj funkce.

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

Parametry

functionDefinition

FunctionDefinition

Definice funkce, která se má použít.

Návraty

{ definition: FunctionToolDefinition }

Objekt obsahující definici nástroje funkce.

createOpenApiTool(OpenApiFunctionDefinition)

Vytvoří nástroj OpenApi.

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

Parametry

openApiFunctionDefinition

OpenApiFunctionDefinition

Definice funkce OpenApi, která se má použít.

Návraty

{ definition: OpenApiToolDefinition }

Objekt obsahující definici nástroje OpenApi.