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 パラメータ オブジェクトを反映しています。パラメータ名では大文字と小文字が区別されます。パラメータを持たない関数の場合は、未設定のままにできます。

FunctionDeclaration.description

省略可。関数の説明と目的。モデルはこれを使用して、関数の呼び出し方法と呼び出すかどうかを決定します。

署名:

description?: string;

FunctionDeclaration.name

呼び出す関数の名前。先頭は英字またはアンダースコアにする必要があります。a ～ z、A ～ Z、0 ～ 9 にする必要があり、アンダースコアとダッシュを含めることができます。最大長は 64 です。

署名:

name: string;

FunctionDeclaration.parameters

省略可。この関数のパラメータを JSON スキーマ オブジェクト形式で記述します。Open API 3.03 パラメータ オブジェクトを反映しています。パラメータ名では大文字と小文字が区別されます。パラメータを持たない関数の場合は、未設定のままにできます。

署名:

parameters?: FunctionDeclarationSchema;