OpenApiTool class

Pacote:

@azure/ai-agents

Uma ferramenta que recupera informações usando especificações OpenAPI. Inicializada com uma definição inicial de API (nome, descrição, spec, auth), essa classe também oferece suporte à adição e remoção de definições de API adicionais dinamicamente.

Construtores

OpenApiTool(OpenApiFunctionDefinition)

O construtor inicializa a ferramenta com uma definição de API primária.

Propriedades

definitions	Obtenha a lista de todas as definições de API para a ferramenta.
resources	Obtenha os recursos da ferramenta para o agente. OpenApiTool não tem recursos específicos para que um objeto vazio seja retornado.

Métodos

addDefinition(OpenApiFunctionDefinition)	Adiciona uma nova definição de API dinamicamente. Lança se já existir uma definição com o mesmo nome.
createDefinition(OpenApiFunctionDefinition)	Cria uma nova definição de API.
removeDefinition(string)	Remove uma definição de API com base em seu nome. Lança se a definição não existir.

Detalhes do Construtor

OpenApiTool(OpenApiFunctionDefinition)

O construtor inicializa a ferramenta com uma definição de API primária.

new OpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition)

Parâmetros

openApiFunctionDefinition

OpenApiFunctionDefinition

Detalhes de Propriedade

definitions

Obtenha a lista de todas as definições de API para a ferramenta.

OpenApiToolDefinition[] definitions

Valor de Propriedade

OpenApiToolDefinition[]

resources

Obtenha os recursos da ferramenta para o agente. OpenApiTool não tem recursos específicos para que um objeto vazio seja retornado.

ToolResources resources

Valor de Propriedade

ToolResources

Detalhes de Método

addDefinition(OpenApiFunctionDefinition)

Adiciona uma nova definição de API dinamicamente. Lança se já existir uma definição com o mesmo nome.

function addDefinition(openApiFunctionDefinition: OpenApiFunctionDefinition)

Parâmetros

openApiFunctionDefinition

OpenApiFunctionDefinition

createDefinition(OpenApiFunctionDefinition)

Cria uma nova definição de API.

static function createDefinition(openapi: OpenApiFunctionDefinition): OpenApiToolDefinition

Parâmetros

openapi

OpenApiFunctionDefinition

Definição da função OpenApi

Devoluções

OpenApiToolDefinition

A definição de API criada

removeDefinition(string)

Remove uma definição de API com base em seu nome. Lança se a definição não existir.

function removeDefinition(name: string)

Parâmetros

name

string