OpenApiTool class

Csomag:

@azure/ai-agents

Olyan eszköz, amely OpenAPI-specifikációk alapján kéri le az információkat. A kezdeti API-definícióval (név, leírás, specifikáció, hitelesítés) inicializálva ez az osztály további API-definíciók dinamikus hozzáadását és eltávolítását is támogatja.

Konstruktorok

OpenApiTool(OpenApiFunctionDefinition)

A konstruktor inicializálja az eszközt egy elsődleges API-definícióval.

Tulajdonságok

definitions	Szerezze be az eszköz összes API-definíciójának listáját.
resources	Szerezze be az ügynök eszközerőforrásait. Az OpenApiTool nem rendelkezik konkrét erőforrásokkal, ezért a rendszer üres objektumot ad vissza.

Metódusok

addDefinition(OpenApiFunctionDefinition)	Dinamikusan ad hozzá egy új API-definíciót. Dob, ha már létezik azonos nevű definíció.
createDefinition(OpenApiFunctionDefinition)	Létrehoz egy új API-definíciót.
removeDefinition(string)	Eltávolítja az API-definíciót a neve alapján. Dob, ha a definíció nem létezik.

Konstruktor adatai

OpenApiTool(OpenApiFunctionDefinition)

A konstruktor inicializálja az eszközt egy elsődleges API-definícióval.

new OpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition)

Paraméterek

openApiFunctionDefinition

OpenApiFunctionDefinition

Tulajdonság adatai

definitions

Szerezze be az eszköz összes API-definíciójának listáját.

OpenApiToolDefinition[] definitions

Tulajdonság értéke

OpenApiToolDefinition[]

resources

Szerezze be az ügynök eszközerőforrásait. Az OpenApiTool nem rendelkezik konkrét erőforrásokkal, ezért a rendszer üres objektumot ad vissza.

ToolResources resources

Tulajdonság értéke

ToolResources

Metódus adatai

addDefinition(OpenApiFunctionDefinition)

Dinamikusan ad hozzá egy új API-definíciót. Dob, ha már létezik azonos nevű definíció.

function addDefinition(openApiFunctionDefinition: OpenApiFunctionDefinition)

Paraméterek

openApiFunctionDefinition

OpenApiFunctionDefinition

createDefinition(OpenApiFunctionDefinition)

Létrehoz egy új API-definíciót.

static function createDefinition(openapi: OpenApiFunctionDefinition): OpenApiToolDefinition

Paraméterek

openapi

OpenApiFunctionDefinition

OpenApi függvény definíciója

Válaszok

OpenApiToolDefinition

A létrehozott API-definíció

removeDefinition(string)

Eltávolítja az API-definíciót a neve alapján. Dob, ha a definíció nem létezik.

function removeDefinition(name: string)

Paraméterek

name

string