OpenApiTool class

Pacote:

@azure/ai-agents

Uma ferramenta que recupera informações usando especificações OpenAPI. Inicializada com uma definição de API inicial (nome, descrição, especificação, autenticação), essa classe também dá 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, portanto, um objeto vazio é retornado.

Métodos

addDefinition(OpenApiFunctionDefinition)	Adiciona uma nova definição de API dinamicamente. Lança se uma definição com o mesmo nome já existir.
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 da propriedade

definitions

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

OpenApiToolDefinition[] definitions

Valor da propriedade

OpenApiToolDefinition[]

resources

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

ToolResources resources

Valor da propriedade

ToolResources

Detalhes do método

addDefinition(OpenApiFunctionDefinition)

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

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 de função OpenApi

Retornos

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