OpenApiTool class

Пакет:

@azure/ai-agents

Инструмент, который извлекает информацию с использованием спецификаций OpenAPI. Этот класс, инициализированный начальным определением API (имя, описание, спецификация, аутентификация), также поддерживает динамическое добавление и удаление дополнительных определений API.

Конструкторы

OpenApiTool(OpenApiFunctionDefinition)

Конструктор инициализирует инструмент с помощью основного определения API.

Свойства

definitions	Получите список всех определений API для инструмента.
resources	Получите ресурсы инструмента для агента. OpenApiTool не имеет конкретных ресурсов, поэтому возвращается пустой объект.

Методы

addDefinition(OpenApiFunctionDefinition)	Динамически добавляет новое определение API. Выдает, если определение с таким же именем уже существует.
createDefinition(OpenApiFunctionDefinition)	Создает новое определение API.
removeDefinition(string)	Удаляет определение API на основе его имени. Выдает, если определения не существует.

Сведения о конструкторе

OpenApiTool(OpenApiFunctionDefinition)

Конструктор инициализирует инструмент с помощью основного определения API.

new OpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition)

Параметры

openApiFunctionDefinition

OpenApiFunctionDefinition

Сведения о свойстве

definitions

Получите список всех определений API для инструмента.

OpenApiToolDefinition[] definitions

Значение свойства

OpenApiToolDefinition[]

resources

Получите ресурсы инструмента для агента. OpenApiTool не имеет конкретных ресурсов, поэтому возвращается пустой объект.

ToolResources resources

Значение свойства

ToolResources

Сведения о методе

addDefinition(OpenApiFunctionDefinition)

Динамически добавляет новое определение API. Выдает, если определение с таким же именем уже существует.

function addDefinition(openApiFunctionDefinition: OpenApiFunctionDefinition)

Параметры

openApiFunctionDefinition

OpenApiFunctionDefinition

createDefinition(OpenApiFunctionDefinition)

Создает новое определение API.

static function createDefinition(openapi: OpenApiFunctionDefinition): OpenApiToolDefinition

Параметры

openapi

OpenApiFunctionDefinition

Определение функции OpenApi

Возвращаемое значение

OpenApiToolDefinition

Созданное определение API

removeDefinition(string)

Удаляет определение API на основе его имени. Выдает, если определения не существует.

function removeDefinition(name: string)

Параметры

name

string