プロンプトテンプレートを使用すると、プロンプトの固定構造と動的変数を分離し、再利用可能なテンプレートを作成して、統一された管理、最適化、効率的なプロンプト生成を実現できます。
このトピックは、国際版 (シンガポールリージョン) にのみ適用されます。
ワークフロー
-
テンプレートの作成: Model Studio コンソールでテンプレートを作成して保存するか、API を使用して一意のテンプレート ID を取得します。
-
テンプレートの取得: API とテンプレート ID を使用して、テンプレートのコンテンツを取得します。
-
プロンプトの生成: テンプレート変数にビジネスデータを入力して、最終的なプロンプトを生成します。
-
テンプレートの使用: 生成されたプロンプトをターゲットモデルに送信して、結果を取得します。
テンプレートの種類
プロンプトテンプレートは、組み込みプロンプトテンプレートとカスタムプロンプトテンプレートの 2 種類に分類されます。
|
ディメンション |
組み込み |
カスタム |
|
ソース |
Model Studio によって提供され、幅広いビジネスシナリオをカバーします。 |
|
|
有効性 |
事前に最適化されており、安定したパフォーマンスを保証します。 |
有効性は、設計とテストの品質に依存します。 |
|
使いやすさ |
追加の開発なしですぐに使用できます。コンソールまたは API から直接呼び出すことができます。
|
複数回の反復による改良が必要になる場合があります。プロンプト設計の原則と最適化手法 (明確な命令、フューショットの例、フォーマット制約の提供など) に精通している必要があります。基本的な開発スキルと技術スキルも必要です。 |
|
適用シナリオ |
|
|
|
編集可能 |
いいえ。 |
はい。必要に応じてテンプレートを変更できます。 |
組み込みプロンプトテンプレート
1. テンプレートの表示
[プロンプト] ページでは、Model Studio がさまざまなシナリオ向けに提供する組み込みプロンプトテンプレートを表示および使用できます。
各プロンプトテンプレートは、コンテンツのプレビューとテンプレート ID を表示するカードに表示されます。カードには、[詳細の表示]、[プロンプトのコピー]、およびその他の操作 ([...]) のボタンが含まれています。

2. テンプレートの表示と管理
表示: テンプレートカードの 詳細を見る をクリックして、名前、コンテンツ、変数、ID、その他の情報を表示します。
管理:
-
をクリックして、テンプレートのコンテンツをコピーします。
-
をクリックします。テンプレートのコンテンツは、エージェントアプリケーション のプロンプトエディターに自動的に入力されます。コンテンツをそのまま使用することも、ビジネスシナリオに基づいて変更することもできます。
入力されたプロンプトには、Xiaohongshu スタイルのコンテンツを生成するためのカスタム変数
${number}と${content}が含まれています。
-
をクリックして、[プロンプト] ページにカスタムプロンプトテンプレートを作成します。新しいテンプレートには、「組み込みプロンプトテンプレート名_Copy_タイムスタンプ」という名前が付けられます。
コピーされたテンプレートカードには、テンプレートのコンテンツとテンプレート ID のプレビューが表示されます (右側のアイコンをクリックしてコピーします)。カードの下部には、[編集]、[プロンプトのコピー]、およびその他の操作のボタンがあります。

カスタムプロンプトテンプレート
1. テンプレートの作成
カスタムプロンプトテンプレートは、コンソールで作成するか、API を使用して作成できます。
コンソール
-
組み込みプロンプトテンプレートの変更
組み込みプロンプトテンプレートカードで をクリックして、「組み込みプロンプトテンプレート名_Copy_タイムスタンプ」という名前のコピーを作成します。
-
ビジネスニーズに基づいたテンプレートの作成
[プロンプト] ページで、Create Prompt をクリックします。構成が完了したら、保存 をクリックしてテンプレートを作成します。プロンプトテンプレート管理ページでは、タイプフィルター (すべて、テキスト生成、画像生成) または検索バーを使用して既存のテンプレートを見つけることができます。右上隅の [+ プロンプトの作成] をクリックして、新しいプロンプトテンプレートを作成します。作成されたテンプレートは、テンプレートのタイトル、コンテンツのプレビュー、テンプレート ID を表示するカードとして表示され、[編集] と [プロンプトのコピー] のオプションがあります。
API
-
ワークスペース ID の取得: 詳細については、「アプリ ID とワークスペース ID の取得」をご参照ください。
-
カスタムプロンプトテンプレートの作成: CreatePromptTemplate API オペレーションを使用します。
2. テンプレートの表示と管理
表示: カスタムプロンプトテンプレートを作成した後、[プロンプト] ページで表示できます。
管理:
-
テンプレートカードの 編集 をクリックして、コンテンツを変更します。
-
をクリックして、テンプレートのコンテンツをコピーします。
-
をクリックします。テンプレートのコンテンツは、エージェントアプリケーション のプロンプトエディターに自動的に入力されます。コンテンツをそのまま使用することも、ビジネスシナリオに基づいて変更することもできます。
-
をクリックして、現在のページに「カスタムプロンプトテンプレート名_Copy_タイムスタンプ」という名前のコピーを作成します。
-
をクリックして、テンプレートを削除します。
プロンプトテンプレートの使用
コンソール
-
組み込みまたはカスタムプロンプトテンプレートカードで をクリックします。テンプレートのコンテンツは、エージェントアプリケーションのプロンプトフィールドに自動的に入力されます。
${name}などのテンプレート変数は、プロンプト入力ボックスに表示されます。右下隅の文字数カウンターには現在の文字数が表示され、最大 6,144 文字です。
-
アプリケーションのモデルを設定し、質問を入力してプロンプトをテストします。
モデルのデバッグページの左側で、Qwen-Plus-Latest 128K などのモデルを選択し、プロンプトエリアにシステム命令を記述します。右側で、ユーザー入力エリアにテスト用の質問を入力し、[実行] をクリックします。モデルの応答と、入力および出力のトークン統計が下に表示されます。
API
-
GetPromptTemplate API リファレンスを開き、Debug をクリックします。
-
パラメータ設定 パネルで、workspaceId と promptTemplateId を入力します。
-
workspaceId: ご利用のワークスペース ID。詳細については、「アプリ ID とワークスペース ID の取得」をご参照ください。
-
promptTemplateId: 組み込みまたはカスタムプロンプトテンプレートの ID。ID はテンプレートカードで確認できます。
-
-
[呼び出しの開始] をクリックして、API オペレーションをオンラインでデバッグします。
{ // 応答のスキーマ "variables": [ // テンプレート変数のリスト "platform", // テンプレート変数 "topic", // テンプレート変数 "num1", // テンプレート変数 "num2" // テンプレート変数 ], "promptTemplateId": "cfec40c311f14f3e976403059d8f0116", // テンプレート ID "requestId": "8C616xxx", // リクエスト ID "name": "Marketing Copy Generation", // テンプレート名 "content": "You are a professional marketing copywriter with extensive experience on the ${platform} platform. Now, please write a highly engaging piece of ${platform} marketing content with \"${topic}\" as the core theme. The content must include a captivating and SEO-friendly title, and a detailed and emotionally compelling body. In the body, please insert at least ${num1} different emoji to increase interactivity and visual appeal. Additionally, based on this theme, design and provide up to ${num2} popular recommended tags that highly summarize the theme and attract the target audience.", // テンプレートのコンテンツ }
SDK
-
GetPromptTemplate API リファレンスを開き、Debug をクリックします。
-
パラメータ設定 パネルで、workspaceId と promptTemplateId を入力します。パラメーターを入力すると、workspaceId と promptTemplateId が SDK サンプルに自動的に入力されます。
-
workspaceId: ご利用のワークスペース ID。詳細については、「アプリ ID とワークスペース ID の取得」をご参照ください。
-
promptTemplateId: 組み込みまたはカスタムプロンプトテンプレートの ID。ID はテンプレートカードで確認できます。
-
-
デバッグページで、[SDK サンプル] をクリックします。
-
オンラインでサンプルを実行するか、完全なプロジェクトをダウンロードし、ご自身の accessKeyId と accessKeySecret を設定してから実行します。
AccessKey の取得方法の詳細については、「AccessKey と AgentKey の取得」をご参照ください。
OpenAPI Explorer ページの右側で、[SDK サンプル] タブをクリックします。SDK バージョン V2.0 (推奨) と、Java などのターゲット言語を選択して、対応する SDK サンプルコードを表示します。
エラーコード
呼び出しが失敗し、エラーメッセージが返された場合は、「エラーコード」を参照して問題を解決してください。
よくある質問
Q: GetPromptTemplate API を呼び出すことと、コード内で直接文字列を連結することの違いは何ですか?
A: GetPromptTemplate API を使用してプロンプトを管理すると、次の利点があります:
-
ロジックとコンテンツの分離: アプリケーションコードを変更したり再デプロイしたりすることなく、Model Studio コンソールでプロンプトのコンテンツを更新および最適化できます。
-
一元管理とコラボレーション: すべてのプロンプトを中央の場所に保存することで、プロンプトエンジニアや開発者などのチームが、コラボレーション、バージョンの管理、テンプレートの再利用を容易に行えます。
-
一貫性: アプリケーションのさまざまな部分や異なるサービス間で同じプロンプトのバージョンと構造が使用されることを保証し、手動メンテナンスによる不整合を回避します。