OpenAPI 3.0 仕様 で定義された関数宣言の構造化表現。この宣言には、関数名とパラメータが含まれています。この FunctionDeclaration は、モデルによってツールとして使用され、クライアントによって実行できるコードブロックを表しています。
署名:
export declare interface FunctionDeclaration
プロパティ
| プロパティ | タイプ | 説明 |
|---|---|---|
| description | 文字列 | 省略可。関数の説明と目的。モデルはこれを使用して、関数を呼び出す方法と呼び出すかどうかを決定します。 |
| name | 文字列 | 呼び出す関数の名前。先頭は英字またはアンダースコアにしてください。a ～ z、A ～ Z、0 ～ 9 にするか、アンダースコアとダッシュを含める必要があり、最大長は 64 です。 |
| パラメータ | FunctionDeclarationSchema | 省略可。この関数のパラメータを JSON スキーマ オブジェクト形式で説明します。Open API 3.03 パラメータ オブジェクトを反映します。パラメータ名では大文字と小文字が区別されます。パラメータのない関数の場合は、未設定のままにできます。 |
FunctionDeclaration.description
省略可。関数の説明と目的。モデルはこれを使用して、関数を呼び出す方法と呼び出すかどうかを決定します。
署名:
description?: string;
FunctionDeclaration.name
呼び出す関数の名前。先頭は英字またはアンダースコアにしてください。a ～ z、A ～ Z、0 ～ 9 にするか、アンダースコアとダッシュを含める必要があり、最大長は 64 です。
署名:
name: string;
FunctionDeclaration.parameters
省略可。この関数のパラメータを JSON スキーマ オブジェクト形式で説明します。Open API 3.03 パラメータ オブジェクトを反映します。パラメータ名では大文字と小文字が区別されます。パラメータのない関数の場合は、未設定のままにできます。
署名:
parameters?: FunctionDeclarationSchema;