Skip to main content

AI Agentカスタムプラグインの設定方法

AI Agentカスタムプラグインを使用すると、独自のHTTPインターフェースをAI Agentにシームレスに統合し、Agentが利用できる強力なツールにすることができます。

1. プラグインの動作原理​

AI Agentカスタムプラグインの核心原理は、HTTPインターフェースをAI Agentが理解し呼び出すことができるツールに変換することです。カスタムプラグインでは、OpenAPI Specification形式を使用してインターフェースの詳細な説明を行う必要があります。これには、リクエスト方式、リクエストアドレス、入力パラメータ、出力パラメータなどが含まれます。この標準化された記述により、AIはインターフェースの機能を理解し、必要に応じて自動的に呼び出すことができます。

2. カスタムプラグイン追加エントリーポイント​

カスタムプラグインを追加するには、以下の手順に従ってください： カスタムプラグインページナビゲーション

3. カスタムプラグイン設定詳細​

開いた設定フォームで、プラグインを定義するための関連情報を入力する必要があります。各パラメータの詳細説明は以下の通りです： カスタムプラグインページナビゲーション

  • Code：これはプラグインの一意識別子で、重複しない英語コンテンツである必要があります。AIの理解と使用を容易にするため、get_weather_infoやsend_email_notificationなど、意味のある名前を使用してください。
  • Name：プラグインの名前で、システム内での表示に使用されます。
  • Description：プラグイン機能の簡潔な説明。この説明はAIがプラグインの用途を理解するために非常に重要です。プラグインができることを明確かつ正確に説明してください。
  • Request Header：インターフェースで認証が必要な場合、ここでリクエストヘッダー情報を設定できます。例えば、AuthorizationやTokenを設定して検証を行います。
  • OpenAPI / Swagger Schema (JSON)：これは設定の最も重要な部分で、インターフェースを記述するために使用されます。

OpenAPI / Swagger Schema (JSON)について​

OpenAPI Specification (OAS) は、RESTful APIを記述するための標準形式です。JSON形式でAPIの様々な情報を定義します：

  • サーバーアドレス
  • 利用可能なすべてのパス（エンドポイント）
  • 各パスのリクエスト方式（GET、POSTなど）
  • リクエストパラメータ
  • レスポンス内容
  • 認証方式 この標準について詳しく知りたい場合は、公式ドキュメントをご覧ください：OpenAPI Specification。

AIにOpenAPI JSONの生成を手伝ってもらう​

このプロセスを簡素化するため、AIに直接このJSONコンテンツの生成を手伝ってもらうことができます。以下のプロンプトを使用し、プレースホルダーの内容を置き換えてください：

以下のインターフェース情報に基づいて、OpenAPI 3.0仕様に準拠したJSONオブジェクトを生成してください：

インターフェースURL：${あなたのインターフェースURL}
インターフェースメソッド：${GET/POST/PUT/DELETE}
インターフェース入力パラメータ：${パラメータ名、タイプ、必須かどうか、説明を含むパラメータリスト}
インターフェース出力パラメータ：${戻り値のコンテンツ構造}
インターフェース説明：${インターフェース機能の簡潔な説明}

AIが生成したJSONコンテンツを OpenAPI / Swagger Schema (JSON) 入力ボックスにコピー＆ペーストしてください。