Структурированное представление объявления функции, определенное спецификацией OpenAPI 3.0. . В это объявление включены имя функции и параметры. Это FunctionDeclaration
является представлением блока кода, который может использоваться моделью в качестве инструмента и выполняться клиентом.
Подпись:
export declare interface FunctionDeclaration
Характеристики
Свойство | Тип | Описание |
---|---|---|
описание | нить | Необязательный. Описание и назначение функции. Модель использует его, чтобы решить, как и следует ли вызывать функцию. |
имя | нить | Имя функции, которую нужно вызвать. Должно начинаться с буквы или подчеркивания. Должен быть az, AZ, 0–9 или содержать символы подчеркивания и тире, максимальная длина — 64. |
параметры | Объявление функцииСхема | Необязательный. Описывает параметры этой функции в формате объекта схемы JSON. Отражает объект параметров Open API 3.03. Имена параметров чувствительны к регистру. Для функции без параметров это значение можно оставить неустановленным. |
FunctionDeclaration.description
Необязательный. Описание и назначение функции. Модель использует его, чтобы решить, как и следует ли вызывать функцию.
Подпись:
description?: string;
Объявление функции.имя
Имя функции для вызова. Должно начинаться с буквы или подчеркивания. Должен быть az, AZ, 0–9 или содержать символы подчеркивания и тире, максимальная длина — 64.
Подпись:
name: string;
Объявление функции.параметры
Необязательный. Описывает параметры этой функции в формате объекта схемы JSON. Отражает объект параметров Open API 3.03. Имена параметров чувствительны к регистру. Для функции без параметров это значение можно оставить неустановленным.
Подпись:
parameters?: FunctionDeclarationSchema;