Skip to main content

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

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

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

AI Agentカスタムプラグインの核心的な原理は、ご自身のHTTPインターフェースをAI Agentが理解し呼び出せるツールへと変換することにあります。カスタムプラグインでは、OpenAPI Specification形式を用いてインターフェースを詳細に記述する必要があります。これにはリクエスト方式、リクエストURL、入力パラメータ、レスポンスパラメータなどが含まれます。このような標準化された記述により、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}
接口方法：${GET/POST/PUT/DELETE}
接口入参：${接口的参数列表，包含参数名、类型、是否必填、描述}
接口返参：${接口的返回内容结构}
接口描述：${对该接口功能的简要描述}

AIが生成したJSON内容をコピーし、OpenAPI / Swagger Schema (JSON) 入力欄に貼り付けてください。