ToolUtility class

Csomag:

@azure/ai-agents

Segédprogram-osztály különböző eszközök létrehozásához.

Metódusok

createAzureAISearchTool(string, string, AISearchIndexResource)	Azure AI-keresőeszköz létrehozása
createBingGroundingTool(BingGroundingSearchConfiguration[])	Létrehoz egy Bing földelő keresőeszközt
createCodeInterpreterTool(string[], VectorStoreDataSource[])	Kódértelmező eszköz létrehozása
createConnectedAgentTool(string, string, string)	Létrehoz egy csatlakoztatott ügyintézői eszközt
createConnectionTool(connectionToolType, string[])	Kapcsolati eszköz létrehozása
createFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Fájlkereső eszköz létrehozása
createFunctionTool(FunctionDefinition)	Függvényeszköz létrehozása
createOpenApiTool(OpenApiFunctionDefinition)	OpenApi-eszköz létrehozása

Metódus adatai

createAzureAISearchTool(string, string, AISearchIndexResource)

Azure AI-keresőeszköz létrehozása

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

Paraméterek

indexConnectionId

string

Az Azure AI keresési index kapcsolatazonosítója.

indexName

string

Az Azure AI keresési indexének neve.

options

AISearchIndexResource

Válaszok

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

Az Azure AI keresőeszköz definícióját és erőforrásait tartalmazó objektum.

createBingGroundingTool(BingGroundingSearchConfiguration[])

Létrehoz egy Bing földelő keresőeszközt

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

Paraméterek

searchConfigurations

BingGroundingSearchConfiguration[]

Válaszok

{ definition: BingGroundingToolDefinition }

A bing földelési keresőeszköz definícióját és erőforrásait tartalmazó objektum

createCodeInterpreterTool(string[], VectorStoreDataSource[])

Kódértelmező eszköz létrehozása

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

Paraméterek

fileIds

string[]

Az eszköz számára code_interpreter elérhetővé tett fájlazonosítók listája. Az eszközhöz legfeljebb 20 fájl társítható.

dataSources

VectorStoreDataSource[]

A használni kívánt adatforrások. Ez a beállítás kölcsönösen kizárja a fájlazonosítókat.

Válaszok

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

A kódértelmező eszköz definícióját és erőforrásait tartalmazó objektum.

createConnectedAgentTool(string, string, string)

Létrehoz egy csatlakoztatott ügyintézői eszközt

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

Paraméterek

id

string

name

string

description

string

Válaszok

{ definition: ConnectedAgentToolDefinition }

A csatlakoztatott ügynök eszköz definícióját tartalmazó objektum.

createConnectionTool(connectionToolType, string[])

Kapcsolati eszköz létrehozása

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

Paraméterek

toolType

connectionToolType

A kapcsolati eszköz típusa.

connectionIds

string[]

A használni kívánt kapcsolatok azonosítóinak listája.

Válaszok

{ definition: ToolDefinitionUnion }

A kapcsolati eszköz definícióját tartalmazó objektum

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

Fájlkereső eszköz létrehozása

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

Paraméterek

vectorStoreIds

string[]

Az ügynökhöz csatolt vektortároló azonosítója. Az ügynökhöz legfeljebb 1 vektortároló csatolható.

vectorStores

VectorStoreConfigurations[]

A vektortároló konfigurációs objektumainak listája az Azure-ból. Ez a lista csak egy elemre korlátozódik. A lista egyetlen eleme a keresőeszköz által használt Azure-eszközazonosítók listáját tartalmazza.

definitionDetails

FileSearchToolDefinitionDetails

Az ügynök konfigurálásához használt fájlkereső eszköz bemeneti definíciós információi.

Válaszok

{ definition: FileSearchToolDefinition, resources: ToolResources }

A fájlkereső eszköz definícióját és erőforrásait tartalmazó objektum

createFunctionTool(FunctionDefinition)

Függvényeszköz létrehozása

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

Paraméterek

functionDefinition

FunctionDefinition

A használni kívánt függvénydefiníció.

Válaszok

{ definition: FunctionToolDefinition }

A függvényeszköz definícióját tartalmazó objektum.

createOpenApiTool(OpenApiFunctionDefinition)

OpenApi-eszköz létrehozása

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

Paraméterek

openApiFunctionDefinition

OpenApiFunctionDefinition

A használni kívánt OpenApi-függvénydefiníció.

Válaszok

{ definition: OpenApiToolDefinition }

Az OpenApi eszköz definícióját tartalmazó objektum.