OpenApiTool class

Pacchetto:

@azure/ai-agents

Uno strumento che recupera informazioni utilizzando le specifiche OpenAPI. Inizializzata con una definizione API iniziale (nome, descrizione, specifica, autenticazione), questa classe supporta anche l'aggiunta e la rimozione dinamica di ulteriori definizioni API.

Costruttori

OpenApiTool(OpenApiFunctionDefinition)

Il costruttore inizializza lo strumento con una definizione API primaria.

Proprietà

definitions	Ottieni l'elenco di tutte le definizioni API per lo strumento.
resources	Ottenere le risorse dello strumento per l'agente. OpenApiTool non dispone di risorse specifiche, quindi viene restituito un oggetto vuoto.

Metodi

addDefinition(OpenApiFunctionDefinition)	Aggiunge dinamicamente una nuova definizione API. Genera se esiste già una definizione con lo stesso nome.
createDefinition(OpenApiFunctionDefinition)	Crea una nuova definizione API.
removeDefinition(string)	Rimuove una definizione API in base al suo nome. Genera se la definizione non esiste.

Dettagli costruttore

OpenApiTool(OpenApiFunctionDefinition)

Il costruttore inizializza lo strumento con una definizione API primaria.

new OpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition)

Parametri

openApiFunctionDefinition

OpenApiFunctionDefinition

Dettagli proprietà

definitions

Ottieni l'elenco di tutte le definizioni API per lo strumento.

OpenApiToolDefinition[] definitions

Valore della proprietà

OpenApiToolDefinition[]

resources

Ottenere le risorse dello strumento per l'agente. OpenApiTool non dispone di risorse specifiche, quindi viene restituito un oggetto vuoto.

ToolResources resources

Valore della proprietà

ToolResources

Dettagli metodo

addDefinition(OpenApiFunctionDefinition)

Aggiunge dinamicamente una nuova definizione API. Genera se esiste già una definizione con lo stesso nome.

function addDefinition(openApiFunctionDefinition: OpenApiFunctionDefinition)

Parametri

openApiFunctionDefinition

OpenApiFunctionDefinition

createDefinition(OpenApiFunctionDefinition)

Crea una nuova definizione API.

static function createDefinition(openapi: OpenApiFunctionDefinition): OpenApiToolDefinition

Parametri

openapi

OpenApiFunctionDefinition

Definizione della funzione OpenApi

Restituisce

OpenApiToolDefinition

La definizione API creata

removeDefinition(string)

Rimuove una definizione API in base al suo nome. Genera se la definizione non esiste.

function removeDefinition(name: string)

Parametri

name

string