FunctionDeclaration interface

OpenAPI 3.0 規格所定義的函式宣告結構化表示法。此宣告中包含函式名稱和參數。這個 FunctionDeclaration 代表程式碼區塊,可用於模型做為工具,並由用戶端執行。

簽名:

export declare interface FunctionDeclaration 

屬性

屬性 類型 說明
description 字串 選用設定。函式的說明和用途。模型會使用它來決定是否要呼叫函式,以及呼叫函式。
name 字串 要呼叫的函式名稱。開頭須為英文字母或底線。必須是 a-z、A-Z、0-9,或包含底線和破折號,長度上限為 64 個字元。
參數 FunctionDeclarationSchema 選用設定。以 JSON 結構定義物件格式說明此函式的參數。代表 Open API 3.03 參數物件。參數名稱須區分大小寫。如果函式沒有參數,則可略過設定。

函式宣告.description

選用設定。函式的說明和用途。模型會使用它來決定是否要呼叫函式,以及呼叫函式。

簽名:

description?: string;

函式宣告.name

要呼叫的函式名稱。開頭須為英文字母或底線。必須是 a-z、A-Z、0-9,或包含底線和破折號,長度上限為 64 個字元。

簽名:

name: string;

函式宣告.參數

選用設定。以 JSON 結構定義物件格式說明此函式的參數。代表 Open API 3.03 參數物件。參數名稱須區分大小寫。如果函式沒有參數,則可略過設定。

簽名:

parameters?: FunctionDeclarationSchema;