Alibaba Cloud Model Studio:カスタムプラグインの作成方法

ステップ 1: プラグインの作成

1. [プラグイン] ページで、[カスタムプラグインの追加] をクリックします。

   

2. プラグイン情報を入力します。

   

   パラメーター	説明
   プラグイン名	分かりやすい名前を入力します。名前は中国語または英語で指定できます。
   プラグインの説明	ユーザーがプラグインの機能とシナリオをよりよく理解できるように、説明を入力します。
   プラグイン URL	プラグインのエンドポイント。同じ HTTP リクエストの場合、異なるパスが異なる API に分割されます。これらのパスは、ツールを作成するときに設定する [ツールパス] パラメーターに対応します。同じプラグイン下の異なるツールは同じドメイン名を使用します。各ツールのツールパスは独立した API に対応します。 たとえば、プラグインに 2 つの API が含まれているとします。 クエリ: https://xxx.com/query 削除: https://xxx.com/delete この例では、https://xxx.com が [プラグイン URL] です。/query と /delete は [ツールパス] に対応します。これは、プラグインに 2 つのツールが含まれていることを示します。
   ヘッダー	(オプション) 認証が必要な場合は、カスタムヘッダーを介して認証情報を渡すことができます。
   認証を有効にする	(オプション) Model Studio アプリケーションがカスタムプラグインを呼び出すときに認証が必要かどうかを指定します。認証が必要かどうかは、API プロバイダーのセキュリティポリシーによって異なります。 : 認証なし。 : 認証が必要です。
   認証タイプ	認証方式はサービスレベル認証とユーザーレベル認証です。 [サービスレベル認証] を選択した場合、各呼び出しにトークンは必要ありません。プラグインを設定するときに指定したトークンがすべての呼び出しに使用されます。 ユーザーレベル認証を選択した場合、呼び出しごとにトークンが必要です。 サービスレベル認証 場所: 認証情報をヘッダーまたはクエリに配置できます。 ヘッダー: 認証情報を HTTP リクエストヘッダーの Authorization フィールドに配置します。この情報は URL には表示されません。 クエリ: 認証情報を URL に配置します。例: https://example.com?api_key=123456。 パラメーター名: 認証情報をクエリに配置する場合は、認証に使用するパラメーター (「api_key」など) を指定します。認証情報をヘッダーに配置する場合、パラメーターはデフォルトで「Authorization」になります。 タイプ: basic: 提供するトークンの前にコンテンツは追加されません。 bearer: トークンの前に「Bearer」が追加されます。 appcode: トークンの前に「APPCODE」が追加されます。 プレフィックスは認証パラメーターフィールドに配置されます。たとえば、bearer を選択した場合、呼び出しは ("Authorization": "Bearer <YOUR_TOKEN>") になります。 トークン: API プロバイダーから取得した認証トークン (API キーなど)。 ユーザーレベル認証 場所: 認証情報をヘッダーまたはクエリに配置できます。 ヘッダー: 認証情報を HTTP リクエストヘッダーの Authorization フィールドに配置します。この情報は URL には表示されません。 クエリ: 認証情報を URL に配置します。例: https://example.com?api_key=123456。 パラメーター名: 認証情報をクエリに配置する場合は、認証に使用するパラメーター (「api_key」など) を指定します。認証情報をヘッダーに配置する場合、パラメーターはデフォルトで「Authorization」になります。 タイプ: basic: 提供するトークンの前にコンテンツは追加されません。 bearer: トークンの前に「Bearer」が追加されます。 appcode: トークンの前に「APPCODE」が追加されます。 プレフィックスは認証パラメーターフィールドに配置されます。たとえば、bearer を選択した場合、呼び出しは ("Authorization": "Bearer <YOUR_TOKEN>") になります。 DashScope SDK または HTTP インターフェイスを使用してアプリケーションを呼び出す場合、プラグインからのユーザーレベル認証情報を biz_params および user_defined_tokens パラメーターを介してアプリケーションに渡します。user_token の値は、プラグインで必要な認証情報です。詳細については、「API を介してプラグインパラメーターを渡す」をご参照ください。

3. 情報を入力した後、[プラグイン作成の確認] > [ツールの作成] をクリックするか、[続けてツールを追加] をクリックします。

ステップ 2：ツールの作成

1. ツール情報を入力し、入力および出力パラメーターを設定し、詳細設定を構成します。

   

   パラメーター	説明
   ツール名	分かりやすい名前を入力します。名前は中国語または英語で指定できます。 [ツール名] は、モデルが現在のタスクに対してツールを呼び出すかどうかを判断するのに役立ちます。
   ツールの説明	ツールの説明は、モデルがツールの特徴とシナリオをよりよく理解するのに役立ちます。ツールを自然言語で説明し、例を提供します。例: 「このツールは、指定された時間と場所の天気と気温を取得するために使用されます。例: '明日の杭州の天気と気温を照会する'」 [ツールの説明] は、モデルが現在のタスクに対してツールを呼び出すかどうかを判断するのに役立ちます。
   ツールパス	[プラグイン URL] への相対パス。パスはスラッシュ (/) で始まる必要があります。このパスは [プラグイン URL] に追加されて完全な URL を構築します。
   リクエストメソッド	必要に応じて、GET や POST などの HTTP メソッドを選択して API 操作を実行できます。
   送信方法	リクエストまたは応答のコーデック。 application/json: リクエストまたは応答の本文は、JSON 形式でエンコードされたデータです。 application/x-www-form-urlencoded: このメソッドは、HTTP リクエストでフォームデータをエンコードするために使用されます。主に POST リクエストに使用されます。フォームデータをキーと値のペアにエンコードし、URL エンコーディングを介して送信します。複数のキーと値のペアはアンパサンド (&) で区切られます。各キーと値は等号 (=) で区切られます。URL エンコーディングは、特殊文字をパーセント記号 (%) とそれに続く 2 桁の 16 進数に変換します。たとえば、スペースは %20、& は %26、= は %3D としてエンコードされます。フォームデータ name=John Doe&age=25 は name=John%20Doe&age=25 としてエンコードされます。
   入力パラメーターの構成	[入力パラメーターの追加] をクリックし、パラメーターを設定します。すべてのパラメーターは必須です。 [パラメーター名] は、できるだけ意味のあるものにする必要があります。これにより、モデルがどのパラメーター情報を識別する必要があるかを理解するのに役立ちます。たとえば、city のような意味のある単語を使用します。 [パラメーターの説明] は、入力パラメーターの機能を説明します。モデルがパラメーターを取得する方法をよりよく理解できるように、簡潔かつ正確でなければなりません。たとえば、日付パラメーターの場合、yyyy-MM-dd のような日付形式を記述できます。 [タイプ] はパラメーターのタイプを指定します。Object タイプの下に新しいパラメーターを追加するには、Object 行の末尾にある アイコンをクリックします。 [渡し方] を正確に設定します。 LLM 認識: パラメーターの値は、モデルによってユーザー入力から抽出される必要があります。 ビジネスパススルー: パラメーターの値は、外部ソースから積極的に渡されます。データは送信中に処理または変更されません。DashScope SDK または HTTP インターフェイスを使用してアプリケーションを呼び出す場合、プラグインのビジネスパススルーパラメーター情報を biz_params および user_defined_params パラメーターを介してアプリケーションに渡します。詳細については、「API を介してプラグインパラメーターを渡す」をご参照ください。
   出力パラメーターの構成	[出力パラメーターの追加] をクリックし、パラメーターを設定します。すべてのパラメーターは必須です。 モデルは、出力パラメーターの定義とユーザーの質問に基づいて、API から返された結果をフィルタリングして再編成します。最終的な回答はユーザーに返されます。したがって、入力パラメーターと同様に、出力パラメーターはできるだけ簡潔かつ正確に、ネストレベルをできるだけ少なくして記述する必要があります。
   詳細設定	(オプション) モデルの呼び出し例を追加して、見逃されたリコールや不正確なリコールを減らします。これは通常、入力パラメーターが複雑で、モデルが構築エラーを起こしやすいシナリオで使用されます。例を提供することで、プラグインを呼び出す際のモデルの精度が向上します。 [値] は、ユーザーが現在のクエリを入力したときにモデルが構築すべき期待される呼び出し入力パラメーターを示します。

2. 設定が完了したら、[下書き保存] をクリックします。

3. ツール API をオンラインでテストして、正常に呼び出せることを確認します。

   [ツールのテスト] をクリックします。認証が有効になっている場合は、認証情報と入力パラメーターの値を入力し、[実行開始] をクリックします。

   実行が失敗した場合は、[実行結果] セクションのエラーメッセージに基づいて設定を調整し、実行が成功するまで再度テストします。

   

   入力パラメーターの値は、手動またはコードを使用して入力できます。複雑な入力パラメーターの場合は、[コード編集] を使用します。コードエディタでは、完全な入力パラメーターとそれに対応する値を JSON 形式で送信できます。

   

4. テストが成功したら、[公開] をクリックします。公開済みのツールのみがアプリケーションで呼び出せます。

ステップ 3: プラグインの呼び出し

ツールの公開時のエラーメッセージ