ToolSet class

Paket:

@azure/ai-agents

Mewakili sekumpulan alat dengan definisi dan sumber dayanya.

Properti

toolDefinitions	Daftar definisi alat yang telah ditambahkan ke set alat.
toolResources	Kumpulan sumber daya yang terkait dengan alat dalam set alat.

Metode

addAzureAISearchTool(string, string)	Menambahkan alat pencarian Azure AI ke set alat.
addBingGroundingTool(BingGroundingSearchConfiguration[])	Menambahkan alat pencarian pembumian bing ke set alat.
addCodeInterpreterTool(string[], VectorStoreDataSource[])	Menambahkan alat penerjemah kode ke set alat.
addConnectedAgentTool(string, string, string)	Menambahkan alat agen yang terhubung ke set alat.
addConnectionTool(connectionToolType, string[])	Menambahkan alat koneksi ke set alat.
addFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Menambahkan alat pencarian file ke set alat.
addMCPTool({ allowedTools?: string[], serverLabel: string, serverUrl: string })	Menambahkan alat Model Context Protocol (MCP) ke set alat.
addOpenApiTool(OpenApiFunctionDefinition)	Menambahkan alat OpenApi ke set alat.

Detail Properti

toolDefinitions

Daftar definisi alat yang telah ditambahkan ke set alat.

toolDefinitions: ToolDefinition[]

Nilai Properti

ToolDefinition[]

toolResources

Kumpulan sumber daya yang terkait dengan alat dalam set alat.

toolResources: ToolResources

Nilai Properti

ToolResources

Detail Metode

addAzureAISearchTool(string, string)

Menambahkan alat pencarian Azure AI ke set alat.

function addAzureAISearchTool(indexConnectionId: string, indexName: string): { definition: AzureAISearchToolDefinition, resources: ToolResources }

Parameter

indexConnectionId

string

ID koneksi indeks pencarian Azure AI.

indexName

string

Nama indeks pencarian Azure AI.

Mengembalikan

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

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

addBingGroundingTool(BingGroundingSearchConfiguration[])

Menambahkan alat pencarian pembumian bing ke set alat.

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

Parameter

searchConfigurations

BingGroundingSearchConfiguration[]

Mengembalikan

{ definition: BingGroundingToolDefinition }

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

addCodeInterpreterTool(string[], VectorStoreDataSource[])

Menambahkan alat penerjemah kode ke set alat.

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

addConnectedAgentTool(string, string, string)

Menambahkan alat agen yang terhubung ke set alat.

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

Parameter

id

string

ID agen yang terhubung.

name

string

Nama agen yang terhubung.

description

string

Deskripsi agen yang terhubung.

Mengembalikan

{ definition: ConnectedAgentToolDefinition }

Objek yang berisi definisi untuk alat agen yang terhubung

addConnectionTool(connectionToolType, string[])

Menambahkan alat koneksi ke set alat.

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

Parameter

toolType

connectionToolType

Jenis alat koneksi.

connectionIds

string[]

Daftar ID koneksi yang akan digunakan.

Mengembalikan

{ definition: ToolDefinition }

Objek yang berisi definisi untuk alat koneksi

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

Menambahkan alat pencarian file ke set alat.

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

addMCPTool({ allowedTools?: string[], serverLabel: string, serverUrl: string })

Menambahkan alat Model Context Protocol (MCP) ke set alat.

function addMCPTool(options: { allowedTools?: string[], serverLabel: string, serverUrl: string }): { definition: MCPToolDefinition, resources: ToolResources }

Parameter

options

{ allowedTools?: string[], serverLabel: string, serverUrl: string }

Opsi untuk mengonfigurasi alat MCP.

Mengembalikan

{ definition: MCPToolDefinition, resources: ToolResources }

Objek yang berisi definisi dan sumber daya untuk alat MCP

addOpenApiTool(OpenApiFunctionDefinition)

Menambahkan alat OpenApi ke set alat.

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

Parameter

openApiFunctionDefinition

OpenApiFunctionDefinition

Definisi fungsi OpenApi yang akan digunakan.

Mengembalikan

{ definition: OpenApiToolDefinition }

Objek yang berisi definisi untuk alat OpenApi