OpenApiTool class

Paket:

@azure/ai-agents

Alat yang mengambil informasi menggunakan spesifikasi OpenAPI. Diinisialisasi dengan definisi API awal (nama, deskripsi, spesifikasi, autentikasi), class ini juga mendukung penambahan dan penghapusan definisi API tambahan secara dinamis.

Konstruktor

OpenApiTool(OpenApiFunctionDefinition)

Konstruktor menginisialisasi alat dengan definisi API utama.

Properti

definitions	Dapatkan daftar semua definisi API untuk alat ini.
resources	Dapatkan sumber daya alat untuk agen. OpenApiTool tidak memiliki sumber daya khusus sehingga objek kosong dikembalikan.

Metode

addDefinition(OpenApiFunctionDefinition)	Menambahkan definisi API baru secara dinamis. Melempar jika definisi dengan nama yang sama sudah ada.
createDefinition(OpenApiFunctionDefinition)	Membuat definisi API baru.
removeDefinition(string)	Menghapus definisi API berdasarkan namanya. Melempar jika definisinya tidak ada.

Detail Konstruktor

OpenApiTool(OpenApiFunctionDefinition)

Konstruktor menginisialisasi alat dengan definisi API utama.

new OpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition)

Parameter

openApiFunctionDefinition

OpenApiFunctionDefinition

Detail Properti

definitions

Dapatkan daftar semua definisi API untuk alat ini.

OpenApiToolDefinition[] definitions

Nilai Properti

OpenApiToolDefinition[]

resources

Dapatkan sumber daya alat untuk agen. OpenApiTool tidak memiliki sumber daya khusus sehingga objek kosong dikembalikan.

ToolResources resources

Nilai Properti

ToolResources

Detail Metode

addDefinition(OpenApiFunctionDefinition)

Menambahkan definisi API baru secara dinamis. Melempar jika definisi dengan nama yang sama sudah ada.

function addDefinition(openApiFunctionDefinition: OpenApiFunctionDefinition)

Parameter

openApiFunctionDefinition

OpenApiFunctionDefinition

createDefinition(OpenApiFunctionDefinition)

Membuat definisi API baru.

static function createDefinition(openapi: OpenApiFunctionDefinition): OpenApiToolDefinition

Parameter

openapi

OpenApiFunctionDefinition

Definisi fungsi OpenApi

Mengembalikan

OpenApiToolDefinition

Definisi API yang dibuat

removeDefinition(string)

Menghapus definisi API berdasarkan namanya. Melempar jika definisinya tidak ada.

function removeDefinition(name: string)

Parameter

name

string