OpenApiTool class

Paquete:

@azure/ai-agents

Una herramienta que recupera información utilizando las especificaciones de OpenAPI. Inicializada con una definición de API inicial (nombre, descripción, especificación, autenticación), esta clase también admite la adición y eliminación de definiciones de API adicionales de forma dinámica.

Constructores

OpenApiTool(OpenApiFunctionDefinition)

Constructor inicializa la herramienta con una definición de API principal.

Propiedades

definitions	Obtenga la lista de todas las definiciones de API para la herramienta.
resources	Obtenga los recursos de la herramienta para el agente. OpenApiTool no tiene recursos específicos, por lo que se devuelve un objeto vacío.

Métodos

addDefinition(OpenApiFunctionDefinition)	Agrega una nueva definición de API de forma dinámica. Produce si ya existe una definición con el mismo nombre.
createDefinition(OpenApiFunctionDefinition)	Crea una nueva definición de API.
removeDefinition(string)	Quita una definición de API basada en su nombre. Produce si la definición no existe.

Detalles del constructor

OpenApiTool(OpenApiFunctionDefinition)

Constructor inicializa la herramienta con una definición de API principal.

new OpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition)

Parámetros

openApiFunctionDefinition

OpenApiFunctionDefinition

Detalles de las propiedades

definitions

Obtenga la lista de todas las definiciones de API para la herramienta.

OpenApiToolDefinition[] definitions

Valor de propiedad

OpenApiToolDefinition[]

resources

Obtenga los recursos de la herramienta para el agente. OpenApiTool no tiene recursos específicos, por lo que se devuelve un objeto vacío.

ToolResources resources

Valor de propiedad

ToolResources

Detalles del método

addDefinition(OpenApiFunctionDefinition)

Agrega una nueva definición de API de forma dinámica. Produce si ya existe una definición con el mismo nombre.

function addDefinition(openApiFunctionDefinition: OpenApiFunctionDefinition)

Parámetros

openApiFunctionDefinition

OpenApiFunctionDefinition

createDefinition(OpenApiFunctionDefinition)

Crea una nueva definición de API.

static function createDefinition(openapi: OpenApiFunctionDefinition): OpenApiToolDefinition

Parámetros

openapi

OpenApiFunctionDefinition

Definición de la función OpenApi

Devoluciones

OpenApiToolDefinition

La definición de API creada

removeDefinition(string)

Quita una definición de API basada en su nombre. Produce si la definición no existe.

function removeDefinition(name: string)

Parámetros

name

string