OpenApiTool class

OpenAPI 仕様を使用して情報を取得するツール。 このクラスは、初期 API 定義 (名前、説明、仕様、認証) で初期化され、追加の API 定義を動的に追加および削除することもサポートします。

コンストラクター

OpenApiTool(OpenApiFunctionDefinition)

コンストラクターは、プライマリ API 定義を使用してツールを初期化します。

プロパティ

definitions

ツールのすべての API 定義の一覧を取得します。

resources

エージェントのツール リソースを取得します。 OpenApiTool には特定のリソースがないため、空のオブジェクトが返されます。

メソッド

addDefinition(OpenApiFunctionDefinition)

新しい API 定義を動的に追加します。 同じ名前の定義が既に存在する場合にスローします。

createDefinition(OpenApiFunctionDefinition)

新しい API 定義を作成します。

removeDefinition(string)

名前に基づいて API 定義を削除します。 定義が存在しない場合にスローします。

コンストラクターの詳細

OpenApiTool(OpenApiFunctionDefinition)

コンストラクターは、プライマリ API 定義を使用してツールを初期化します。

new OpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition)

パラメーター

openApiFunctionDefinition
OpenApiFunctionDefinition

プロパティの詳細

definitions

ツールのすべての API 定義の一覧を取得します。

OpenApiToolDefinition[] definitions

プロパティ値

resources

エージェントのツール リソースを取得します。 OpenApiTool には特定のリソースがないため、空のオブジェクトが返されます。

ToolResources resources

プロパティ値

メソッドの詳細

addDefinition(OpenApiFunctionDefinition)

新しい API 定義を動的に追加します。 同じ名前の定義が既に存在する場合にスローします。

function addDefinition(openApiFunctionDefinition: OpenApiFunctionDefinition)

パラメーター

openApiFunctionDefinition
OpenApiFunctionDefinition

createDefinition(OpenApiFunctionDefinition)

新しい API 定義を作成します。

static function createDefinition(openapi: OpenApiFunctionDefinition): OpenApiToolDefinition

パラメーター

openapi
OpenApiFunctionDefinition

OpenApi関数の定義

戻り値

作成された API 定義

removeDefinition(string)

名前に基づいて API 定義を削除します。 定義が存在しない場合にスローします。

function removeDefinition(name: string)

パラメーター

name

string