ToolUtility class

Paket:

@azure/ai-agents

Kelas utilitas untuk membuat berbagai alat.

Metode

createAzureAISearchTool(string, string, AISearchIndexResource)	Membuat alat pencarian Azure AI
createBingGroundingTool(BingGroundingSearchConfiguration[])	Membuat alat pencarian pembumian bing
createCodeInterpreterTool(string[], VectorStoreDataSource[])	Membuat alat penerjemah kode
createConnectedAgentTool(string, string, string)	Membuat alat agen yang terhubung
createConnectionTool(connectionToolType, string[])	Membuat alat koneksi
createFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Membuat alat pencarian file
createFunctionTool(FunctionDefinition)	Membuat alat fungsi
createOpenApiTool(OpenApiFunctionDefinition)	Membuat alat OpenApi

Detail Metode

createAzureAISearchTool(string, string, AISearchIndexResource)

Membuat alat pencarian Azure AI

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

Parameter

indexConnectionId

string

ID koneksi indeks pencarian Azure AI.

indexName

string

Nama indeks pencarian Azure AI.

options

AISearchIndexResource

Mengembalikan

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

Objek yang berisi definisi dan sumber daya untuk alat pencarian Azure AI.

createBingGroundingTool(BingGroundingSearchConfiguration[])

Membuat alat pencarian pembumian bing

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

Parameter

searchConfigurations

BingGroundingSearchConfiguration[]

Mengembalikan

{ definition: BingGroundingToolDefinition }

Objek yang berisi definisi dan sumber daya untuk alat pencarian pembumian bing

createCodeInterpreterTool(string[], VectorStoreDataSource[])

Membuat alat penerjemah kode

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

Parameter

fileIds

string[]

Daftar ID file yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.

dataSources

VectorStoreDataSource[]

Sumber data yang akan digunakan. Opsi ini saling eksklusif dengan fileIds.

Mengembalikan

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

Objek yang berisi definisi dan sumber daya untuk alat penerjemah kode.

createConnectedAgentTool(string, string, string)

Membuat alat agen yang terhubung

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

Parameter

id

string

name

string

description

string

Mengembalikan

{ definition: ConnectedAgentToolDefinition }

Objek yang berisi definisi untuk alat agen yang terhubung.

createConnectionTool(connectionToolType, string[])

Membuat alat koneksi

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

Parameter

toolType

connectionToolType

Jenis alat koneksi.

connectionIds

string[]

Daftar ID koneksi yang akan digunakan.

Mengembalikan

{ definition: ToolDefinitionUnion }

Objek yang berisi definisi untuk alat koneksi

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

Membuat alat pencarian file

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

Parameter

vectorStoreIds

string[]

ID penyimpanan vektor yang terpasang pada agen ini. Mungkin ada maksimal 1 penyimpanan vektor yang terpasang pada agen.

vectorStores

VectorStoreConfigurations[]

Daftar objek konfigurasi penyimpanan vektor dari Azure. Daftar ini terbatas pada satu elemen. Satu-satunya elemen dari daftar ini berisi daftar ID aset azure yang digunakan oleh alat pencarian.

definitionDetails

FileSearchToolDefinitionDetails

Informasi definisi input untuk alat pencarian file seperti yang digunakan untuk mengonfigurasi agen.

Mengembalikan

{ definition: FileSearchToolDefinition, resources: ToolResources }

Objek yang berisi definisi dan sumber daya untuk alat pencarian file

createFunctionTool(FunctionDefinition)

Membuat alat fungsi

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

Parameter

functionDefinition

FunctionDefinition

Definisi fungsi yang akan digunakan.

Mengembalikan

{ definition: FunctionToolDefinition }

Objek yang berisi definisi untuk alat fungsi.

createOpenApiTool(OpenApiFunctionDefinition)

Membuat alat OpenApi

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

Parameter

openApiFunctionDefinition

OpenApiFunctionDefinition

Definisi fungsi OpenApi yang akan digunakan.

Mengembalikan

{ definition: OpenApiToolDefinition }

Objek yang berisi definisi untuk alat OpenApi.