OpenApiTool class

Paket:

@azure/ai-agents

Ett verktyg som hämtar information med hjälp av OpenAPI-specifikationer. Den här klassen initieras med en inledande API-definition (namn, beskrivning, specifikation, autentisering) och har även stöd för att lägga till och ta bort ytterligare API-definitioner dynamiskt.

Konstruktorer

OpenApiTool(OpenApiFunctionDefinition)

Konstruktorn initierar verktyget med en primär API-definition.

Egenskaper

definitions	Hämta listan över alla API-definitioner för verktyget.
resources	Hämta verktygsresurserna för handläggaren. OpenApiTool har inga specifika resurser, så ett tomt objekt returneras.

Metoder

addDefinition(OpenApiFunctionDefinition)	Lägger till en ny API-definition dynamiskt. Utlöser om det redan finns en definition med samma namn.
createDefinition(OpenApiFunctionDefinition)	Skapar en ny API-definition.
removeDefinition(string)	Tar bort en API-definition baserat på dess namn. Utlöser om definitionen inte finns.

Konstruktorinformation

OpenApiTool(OpenApiFunctionDefinition)

Konstruktorn initierar verktyget med en primär API-definition.

new OpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition)

Parametrar

openApiFunctionDefinition

OpenApiFunctionDefinition

Egenskapsinformation

definitions

Hämta listan över alla API-definitioner för verktyget.

OpenApiToolDefinition[] definitions

Egenskapsvärde

OpenApiToolDefinition[]

resources

Hämta verktygsresurserna för handläggaren. OpenApiTool har inga specifika resurser, så ett tomt objekt returneras.

ToolResources resources

Egenskapsvärde

ToolResources

Metodinformation

addDefinition(OpenApiFunctionDefinition)

Lägger till en ny API-definition dynamiskt. Utlöser om det redan finns en definition med samma namn.

function addDefinition(openApiFunctionDefinition: OpenApiFunctionDefinition)

Parametrar

openApiFunctionDefinition

OpenApiFunctionDefinition

createDefinition(OpenApiFunctionDefinition)

Skapar en ny API-definition.

static function createDefinition(openapi: OpenApiFunctionDefinition): OpenApiToolDefinition

Parametrar

openapi

OpenApiFunctionDefinition

Definition av OpenApi-funktion

Returer

OpenApiToolDefinition

Den skapade API-definitionen

removeDefinition(string)

Tar bort en API-definition baserat på dess namn. Utlöser om definitionen inte finns.

function removeDefinition(name: string)

Parametrar

name

string