FunctionDeclaration interface

OpenAPI 3.0 规范 定义的函数声明的结构化表示法。此声明中包含函数名称和形参。此 FunctionDeclaration 表示代码块,可由模型用作工具,并由客户端执行。

签名

export declare interface FunctionDeclaration 

属性

属性 类型 说明
description string 可选。函数的说明和用途。模型使用它来决定如何以及是否调用函数。
name string 要调用的函数名称。必须以字母或下划线开头。必须为 a-z、A-Z、0-9 之间,或包含下划线和短划线,长度上限为 64。
参数 FunctionDeclarationSchema 可选。用于描述此函数的参数(采用 JSON 架构对象格式)。反映 Open API 3.03 参数对象。参数名称区分大小写。对于不含形参的函数,可以不设置此字段。

FunctionDeclaration.description

可选。函数的说明和用途。模型使用它来决定如何以及是否调用函数。

签名

description?: string;

函数声明.name

要调用的函数名称。必须以字母或下划线开头。必须为 a-z、A-Z、0-9 之间,或包含下划线和短划线,长度上限为 64。

签名

name: string;

FunctionDeclaration.parameters

可选。用于描述此函数的参数(采用 JSON 架构对象格式)。反映 Open API 3.03 参数对象。参数名称区分大小写。对于不含形参的函数,可以不设置此字段。

签名

parameters?: FunctionDeclarationSchema;