Alibaba Cloud Model Studio:カスタムプラグイン

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

1. [プラグイン] ページに移動し、[プラグインの作成] をクリックします。

   

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

   	プラグイン名： 意味の通る名前を入力します。中国語と英語がサポートされています。 例： 寮規約クエリツールテスト
   	プラグインの説明： プラグインの機能とユースケースの簡単な説明です。これにより、LLM が現在のタスクに対してプラグインを呼び出すべきかどうかを判断するのに役立ちます。説明には自然言語を使用してください。 例： 入力された数値インデックスに基づいて、特定の寮規約エントリの内容をクエリします。
   	Plug-in URL： プラグインのエンドポイントです。 例：https://domitorgreement-plugin-example-icohrkdjxy.cn-beijing.fcapp.run 同じドメイン名の下で、異なるパスは別々の API を表します。各パスは、後述するツール作成時の Tool Path に対応します。 同じプラグイン内の異なるツールは、同じドメイン名を共有します。各ツールのパスは、独立した API に対応します。 例えば、xx という名前のプラグインに 2 つの API が含まれているとします： クエリ： https://xxx.com/query 削除： https://xxx.com/delete この例では、https://xxx.com が Plug-in URL に対応し、/query と /delete が後述するツール作成時の Tool Path に対応します。これは、プラグインに 2 つのツールが含まれていることを示します。

   認証が必要な場合は、Enable Authentication スイッチをオンにし、認証設定を入力します。

   認証パラメーターの説明

   Headers (任意)	認証が必要な場合、カスタムヘッダーを介して認証情報を渡すことができます。
   Enable Authentication (任意)	Alibaba Cloud Model Studio アプリケーションがカスタムプラグインを呼び出す際に認証が必要かどうかを指定します。これは API プロバイダーのセキュリティポリシーに依存します。
   Authentication Type	認証には、[サービスレベル認証] と [ユーザーレベル認証] の 2 種類があります。 場所： 認証情報をヘッダーまたはクエリに配置できます。 [ヘッダー]： 認証情報を HTTP リクエストヘッダーの Authorization フィールドに配置します。この情報は URL には表示されません。 [クエリ]： 認証情報を URL に配置します。例： https://example.com?api_key=123456。 パラメーター名： 認証情報をクエリに配置する場合、認証に使用するパラメーター (例： `api_key`) を入力します。ヘッダーに配置する場合、パラメーターはデフォルトで `Authorization` になります。 タイプ: 基本: 指定したトークンにプレフィックスを付加しません。 Bearer: トークンに「Bearer」プレフィックスを追加します。 appcode: トークンに APPCODE プレフィックスを追加します。 どちらのタイプも、認証パラメーター フィールドに入力されます。たとえば、`bearer` を選択した場合、プラグインへの呼び出しは (`Authorization`: `Bearer <YOUR_TOKEN>`) になります。 [トークン] (サービスレベル認証)： API プロバイダーから取得した認証トークン (API キーなど) です。

3. 完了後、Confirm Create Plug-in > Create Tool をクリックするか、Continue to Add Tool をクリックします。

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

1. ツール情報を入力し、入出力パラメーターを設定し、詳細設定を行います。

   

   ツールパラメーターの説明

   ツール情報

   ツール名	意味の通る名前を入力します。中国語と英語がサポートされています。
   Tool Description	ツールの機能とシナリオの簡単な説明です。 これにより、LLM が現在のタスクに対してツールを呼び出すべきかどうかを判断するのに役立ちます。説明には自然言語を使用し、可能であれば例を提供してください。
   Tool Path	Plug-in URL への相対パスです。 パスはスラッシュ (/) で始まる必要があります。 このパスは Plug-in URL に追加され、完全な URL を構築します。
   Request Method	必要に応じて、API オペレーションを呼び出すための GET または POST リクエストメソッドを選択します。
   Submission Method	リクエストまたはレスポンスのエンコーディングタイプです。 [application/json]： 本文の内容は JSON フォーマットです。 [application/x-www-form-urlencoded]： フォームデータをキーと値のペアとしてエンコードします。 このエンコーディングメソッドは POST リクエストに使用されます。フォームデータはキーと値のペアとしてエンコードされ、URL エンコーディングを介して送信されます。複数のキーと値のペアはアンパサンド (&) で区切られ、各キーと値は等号 (=) で区切られます。URL エンコーディングは、特殊文字をパーセント記号 (%) とそれに続く 2 つの 16 進数に変換します。例えば、スペースは %20、& は %26、= は %3D にエンコードされます。 例： name=John Doe&age=25 は name=John%20Doe&age=25 としてエンコードされます。

   入出力パラメーターの設定

   Configure Input Parameters	Add Input Parameter をクリックして、パラメーター情報を設定します。
   	Parameter Name： LLM がどのパラメーター情報を識別すべきかを理解しやすくするために、意味のある名前を使用します。例： city。
   	Parameter Description： 入力パラメーターの機能を簡潔かつ正確に説明します。これにより、LLM がパラメーターをより良く取得するのに役立ちます。例えば、date の場合、日付として説明し、さらにフォーマットを指定できます。例： yyyy-MM-dd。
   	タイプ： パラメーターのタイプです。 重要 Object タイプのサブプロパティは空にできません。オブジェクトの行の末尾にある アイコンをクリックして、サブプロパティを追加します。
   	Passing Method： 正確に設定してください。 LLM Recognition： このパラメーターの値が、ユーザーの入力から LLM によって抽出される必要があることを示します。 Business Pass-through： このパラメーターの値が、処理または変更されることなく外部ソースから渡されることを示します。 DashScope SDK または HTTP インターフェイスを使用してアプリケーションを呼び出す場合、プラグイン内のビジネスパススルータイプの入力パラメーターは、biz_params および user_defined_params を介してアプリケーションに渡されます。詳細については、「API 経由でのプラグインパラメーターの受け渡し」をご参照ください。
   Configure Output Parameters	Add Output Parameters をクリックして、パラメーター情報を設定します。すべてのパラメーターは必須です。 LLM は、出力パラメーターの定義とユーザーのクエリに基づいて API から返された結果をフィルタリングおよび再編成し、最終的な回答を生成します。 入力パラメーターと同様に、出力パラメーターもできるだけ簡潔かつ正確に記述し、ネストレベルを最小限に抑える必要があります。 重要 GET と POST の両方のリクエストメソッドが Object パラメータータイプをサポートしています。ただし、Object タイプのサブプロパティは空にできません。オブジェクトの行の末尾にある アイコンをクリックして、サブプロパティを追加します。

   詳細設定 (任意)

   Advanced Configuration	LLM が見逃しや誤検出を減らすための呼び出し例を提供します。 これは通常、入力パラメーターが複雑でモデルの構築にエラーが発生しやすいシナリオで使用されます。例を提供することで、LLM がプラグインを呼び出す際の精度が向上します。
   	[値]： ユーザーが現在のクエリを入力したときに LLM が構築すべき期待される入力パラメーターです。例： ユーザーが「明日の杭州の天気は？」と入力した場合、期待される入力パラメーターは {"city": "Hangzhou", "date": "2025-04-25"} です。

2. 設定が完了したら、Save Draft をクリックします。

3. ツールの API 接続性をオンラインでテストします。

   Test Tool をクリックし、認証情報 (認証が有効な場合) と入力パラメーターの値を入力してから、Start Running をクリックします。 実行に失敗した場合は、Run Result のエラーメッセージに基づいて設定を調整し、成功するまで再度テストしてください。 入力パラメーターの値は手動またはコードで入力できます。複雑な入力パラメーターの場合は、Code Editing を使用することを推奨します。コードエディタで、完全な入力パラメーターとそれに対応する値を JSON 形式で送信できます。

4. テストに合格したら、公開 をクリックします。Published のツールのみがアプリケーションで呼び出せます。

ツール ID の取得

ツール ID は特定のツールを識別します。API を介してツールを呼び出す場合、リクエストが正しく識別されるように、正しいツール ID を渡す必要があります。

1. Plugins で、ツールが属するプラグインを見つけ、詳細を見る をクリックします。

2. ツール名の横にある アイコンにマウスを合わせます。

3. アイコンをクリックしてツール ID をコピーします。