サーバー プロンプト テンプレートを使ってみる

プレビュー: サーバー プロンプト テンプレートの使用は プレビュー版の機能です。そのため、この機能は SLA または 非推奨ポリシーの対象ではなく、下位互換性のない方法で変更される可能性があります。

モデルへのリクエストごとに、プロンプトと、必要に応じてスキーマと構成を送信して、モデルのレスポンスを制御します。 Firebase AI Logic を使用する場合、このすべての情報を クライアント コードから直接送信できます。または、 サーバー プロンプト テンプレートを使用して、この情報をサーバーサイドで指定することもできます。

サーバー プロンプト テンプレートを使用する場合、プロンプト、スキーマ、構成をサーバーサイドに保存します。アプリは、特定のテンプレートを参照するキー（テンプレート ID）と、そのテンプレートに必要な入力をクライアントからサーバーに渡します。

サーバー プロンプト テンプレートを使用する場合、プロンプトと構成をサーバーサイドに保存し、アプリのコードベースにキー（テンプレート ID）のみを指定します。この方法には次のようなメリットがあります。

• プロンプトがクライアントサイドで公開されるのを防ぐ

• 新しいアプリ バージョンをリリースせずにプロンプトと構成を更新する

このガイドでは、サーバー プロンプト テンプレートの使用を開始する方法について説明します。

概要に移動 詳細な手順に移動

サポートされているモデルと機能

• サーバー プロンプト テンプレートは、 Gemini と Imagen モデル（Gemini Live モデルを除く）で Firebase AI Logic使用できます。

• まだサポートされていない機能の リストを確認してください。

注: **複数ターンのインタラクション（チャットや関数呼び出しなど）** でサーバー プロンプト テンプレートを使用するには、このスタートガイドで「Hello World」シナリオでのサーバー プロンプト テンプレートの仕組みを理解してください。 次に、複数ターンのインタラクションに関する 具体的なガイダンスを確認します。

---

概要

サーバー プロンプト テンプレートを使用するための基本的なワークフローは次のとおりです。

1. Firebase コンソールのガイド付き UI を使用してテンプレートを作成します。Firebase

2. コンソールのテスト機能を使用して、実際のリクエストでテンプレートをテストします。Firebase

3. アプリのコードから templateGenerativeModel を使用してテンプレートにアクセスします。

サーバー プロンプト テンプレートの基本形式

Firebase AI Logic の場合、 Firebase コンソール には、テンプレートのフロントマターとコンテンツを指定するためのガイド付き UI が用意されています。

サーバー プロンプト テンプレートでは、Dotprompt ベースの構文と形式が使用されます。 詳細については、 テンプレートの形式、構文、例をご覧ください。

次のテンプレートの例は、 モデルへのリクエストのテンプレートの最も重要なコンポーネントを示しています。Gemini

---
model: 'gemini-3-flash-preview'
---

{{role "system"}}
All output must be a clearly structured invoice document.
Use a tabular or clearly delineated list format for line items.

{{role "user"}}
Create an example customer invoice for a customer named {{customerName}}.

• 3 つのダッシュの間の上部には、モデル名と、必要に応じてリクエストで送信するモデル構成、入力検証、スキーマが含まれます。これは Key-Value ペアとして記述され、一般に YAML フロントマターと呼ばれます。

• テンプレートの本文にはプロンプトが含まれます。必要に応じて、 システム指示と入力値（ Handlebars 構文を使用）を含めることもできます。

コードでテンプレートを使用する

Gemini API プロバイダをクリックして、このページでプロバイダ固有のコンテンツとコードを表示します。 Gemini Developer API Vertex AI Gemini API

次のクライアント コードの例は、コードでテンプレートを使用する方法を示しています。

Swift

// ...

// Initialize the Gemini Developer API backend service
// Create a `TemplateGenerativeModel` instance
let model = FirebaseAI.firebaseAI(backend: .googleAI()).templateGenerativeModel()

let customerName = "Jane"

do {
    let response = try await model.generateContent(
        // Specify your template ID
        templateID: "my-first-template-v1-0-0",
        // Provide the values for any input variables required by your template.
        inputs: [
            "customerName": customerName
        ]
    )
    if let text = response.text {
        print("Response Text: \(text)")
    }
} catch {
    print("An error occurred: \(error)")
}
print("\n")

Kotlin

// ...

// Initialize the Gemini Developer API backend service
// Create a `TemplateGenerativeModel` instance
val model = Firebase.ai(backend = GenerativeBackend.googleAI()).templateGenerativeModel()

val customerName = "Jane"

val response = model.generateContent(
    // Specify your template ID
    "my-first-template-v1-0-0",
    // Provide the values for any input variables required by your template.
    mapOf(
        "customerName" to customerName
    )
)

val text = response.text
println(text)

Java

// ...

// Initialize the Gemini Developer API backend service
// Create a `TemplateGenerativeModel` instance
TemplateGenerativeModel generativeModel = FirebaseAI.getInstance().templateGenerativeModel();

TemplateGenerativeModelFutures model = TemplateGenerativeModelFutures.from(generativeModel);

String customerName = "Jane";

Future response = model.generateContent(
    // Specify your template ID
    "my-first-template-v1-0-0",
    // Provide the values for any input variables required by your template.
    mapOf("customerName", customerName)
);
addCallback(response,
       new FutureCallback() {
           public void onSuccess(GenerateContentResponse result) {
             System.out.println(result.getText());
           }
           public void onFailure(Throwable t) {
             reportError(t);
           }
    }
executor);

Web

// ...

// Initialize the Gemini Developer API backend service
const ai = getAI(app, { backend: new GoogleAIBackend() });

// Create a `TemplateGenerativeModel` instance
const model = getTemplateGenerativeModel(ai);

const customerName = 'Jane';

const result = await model.generateContent(
  // Specify your template ID
  'my-first-template-v1-0-0',
  // Provide the values for any input variables required by your template
  {
    customerName: customerName,
  }
);

const response = result.response;
const text = response.text();

Dart

// ...

// Initialize the Gemini Developer API backend service
// Create a `TemplateGenerativeModel` instance
var _model = FirebaseAI.googleAI().templateGenerativeModel()

var customerName = 'Jane';

var response = await _model.generateContent(
        // Specify your template ID
        'my-first-template-v1-0-0',
        // Provide the values for any input variables required by your template
        inputs: {
           'customerName': customerName,
        },
      );

var text = response?.text;
print(text);

Unity

// ...

// Initialize the Gemini Developer API backend service
var firebaseAI = FirebaseAI.GetInstance(FirebaseAI.Backend.GoogleAI());

// Create a `TemplateGenerativeModel` instance
var model = firebaseAI.GetTemplateGenerativeModel();

var customerName = "Jane";

try
{
   var response = await model.GenerateContentAsync(
      // Specify your template ID
      "my-first-template-v1-0-0",
      // Provide the values for any input variables required by your template
      new Dictionary<string, object> {
         { "customerName", customerName },
      }
   );
   Debug.Log($"Response Text: {response.Text}");
}
catch (Exception e) {
  Debug.LogError($"An error occurred: {e.Message}");
}

重要: サーバー プロンプト テンプレートで Firebase Remote Config を使用すると、リクエストのテンプレート ID やその他の値を簡単に変更できるため、強くおすすめします。

---

詳しい手順

このセクションでは、サーバー プロンプト テンプレートの作成、テスト、使用に関する詳細な手順について説明します。

始める前に

• まだ行っていない場合は、 **スタートガイドを完了**してください。このガイドでは、Firebase プロジェクトの設定、アプリと Firebase の接続、 SDK の追加、選択した Gemini APIのバックエンド サービスの初期化、GenerativeModelインスタンスの作成方法について説明しています。

• サーバー プロンプト テンプレートを作成して管理するために必要な権限 があることを確認してください。デフォルトでは、これらの権限はすべてオーナーロールに含まれています。

  必要な権限を表示

  • firebasevertexai.googleapis.com/promptTemplates.create
  • firebasevertexai.googleapis.com/promptTemplates.get
  • firebasevertexai.googleapis.com/promptTemplates.update
  • firebasevertexai.googleapis.com/promptTemplates.delete
  • firebasevertexai.googleapis.com/promptTemplates.list

• Vertex AI Gemini API を使用していて、Vertex AI Gemini APIユースケースで ロケーション ベースの制限が必要な場合は、 テンプレートの高度なワークフローがサポートされています。

ステップ 1: サーバー プロンプト テンプレートを作成する

ほとんどのユースケースでは、 Firebase コンソールでサーバー プロンプト テンプレートを作成して管理します。

1. Firebase コンソールで、[AI Services] > [AI Logic] > [Prompt templates] タブに移動します。

2. [Create new template] をクリックして、スターター テンプレート オプションを選択します。

   • これらのスターター テンプレートには、一般的なユースケースの形式と構文が用意されています。どのオプションを選択しても、ニーズに合わせてテンプレートを完全に変更できます。

   • このスタートガイドでは、Input + System Instructions オプションを選択していることを前提としています。

3. テンプレートの ID を入力します。

   • テンプレート名: テンプレートの表示名（例: My First Template）。 Firebase コンソールなどの Firebase インターフェース内でのみ表示されます。

   • テンプレート ID: Firebase プロジェクト内のテンプレートで一意の ID を指定してください（my-first-template-v1-0-0 など）。この ID は、アプリからのリクエストで参照します。

     • テンプレート ID には バージョン管理システム を使用することをおすすめします。

     • テンプレート ID は最大 63 文字で、小文字、数字、ハイフンを使用できます。

4. 必要に応じて、テンプレートの [Configuration (frontmatter)] セクションを変更します。

   • このセクションには、少なくとも次のようなモデル名を含める必要があります。

     ---
     model: 'gemini-3-flash-preview'
     ---
     

   • 必要に応じて、モデルの構成や入出力制御などを指定することもできます。詳細とオプションについては、 テンプレートの形式、構文、例をご覧ください。

5. 必要に応じて、テンプレートの [Prompt and (as applicable) system instructions] セクションを変更します。

   • このセクションには、モデルに送信するテキスト プロンプトを少なくとも含める必要があります。

     Write a story about a magic backpack.
     

   • 次のような複雑なプロンプトを作成することもできます。 詳細とオプションについては、 テンプレートの形式、構文、例をご覧ください。

     • （省略可、該当する場合） {{role "system"}} 構文を使用してシステム指示を指定し、 テキスト プロンプトを {{role "user"}} 構文を使用して指定します。

     • （省略可）入力変数は Handlebars構文（ {{customerName}}など）を使用して指定します。テンプレートでデフォルト値を指定できますが、通常、この入力変数の値はリクエストで渡されます。

     {{role "system"}}
     All output must be a clearly structured invoice document.
     Use a tabular or clearly delineated list format for line items.
     
     {{role "user"}}
     Create an example customer invoice for a customer named {{customerName}}.
     

ステップ 2: Firebase コンソールでテンプレートをテストする

Firebase コンソールには、テンプレートのテスト機能が用意されています。この機能を使用すると、テンプレートが使用されたときに何が起こるかを確認できます。リクエストの形式と実際のリクエストの出力の両方を確認できます。

1. [Save template] をクリックして、テンプレートをテストできるようにします。

   テンプレートは後でいつでも編集または削除できます。後で変更できない値はテンプレート ID のみです。

2. プロンプトで入力変数を使用する場合は、[Test input] フィールドにテスト値を含めます。この例では、次のようになります。

     {
       "customerName": "Jane"
     }
   

3. Firebase プロジェクトで複数の Gemini API プロバイダが有効になっている場合は、テスト リクエストに使用するプロバイダを選択できます。このオプションがコンソールに表示されたら、Gemini Developer API または Vertex AI Gemini API を選択します。

   この選択は、 Firebase コンソールのテスト機能を使用して送信されたリクエストにのみ適用されます。アプリからの実際のリクエストでは、 他のリクエストと同様に、選択した Gemini API プロバイダを指定します。

4. [Create formatted test request] ボタンをクリックします。

   画面の右側に表示される結果の書式設定されたテスト リクエストを確認し、テンプレートのフィールドを反復処理します。

   展開して、書式設定されたテスト リクエストの例を表示する

   {
     "model": "projects/YOUR_PROJECT_ID/models/gemini-3-flash-preview",
     "contents": [{
       "parts": [{
         "text": "Create an example customer invoice for a customer named Jane"
       }],
       "role": "user"
     }],
     "systemInstruction": {
       "parts": [{
         "text": "All output must be a clearly structured invoice document.\nUse a tabular or clearly delineated list format for line items."
       }]
     }
   }
   

5. 書式設定されたテスト リクエストに問題がなければ、[Run prompt test] ボタンをクリックします。

   画面の右側に表示される結果のテスト レスポンスを確認し、テンプレートのフィールドを反復処理します。

   **重要:** [**Run prompt test**] をクリックするたびに、費用が発生する可能性があります 選択した Gemini API プロバイダと**お支払いプラン**に応じて。

   展開して、テスト レスポンスの例を表示する

   {
     "candidates": [{
       "content": {
         "parts": [{
           "text": "```\n--------------------------------------------------------------------------------\n                         **INVOICE**\n--------------------------------------------------------------------------------\n\n**Creative Solutions Inc.**\n123 Business Lane, Suite 100\nAnytown, USA 12345\nPhone: [phone]\nEmail: [e-mail]\n\n**INVOICE NO:** INV-2023-001\n**INVOICE DATE:** October 26, 2023\n**DUE DATE:** November 25, 2023\n\n**BILL TO:**\nJane\n456 Client Street, Apt 2B\nAnytown, USA 12346\nPhone: [phone]\nEmail: [e-mail]\n\n--------------------------------------------------------------------------------\n**ITEM DESCRIPTION**               **QTY**   **UNIT PRICE**   **AMOUNT**\n--------------------------------------------------------------------------------\nWebsite Design Services            1         $800.00          $800.00\nContent Creation (Blog Posts)      4         $120.00          $480.00\nMonthly Hosting \u0026 Maintenance      1         $50.00           $50.00\nConsultation Fee                   2         $75.00           $150.00\n--------------------------------------------------------------------------------\n\n**SUMMARY:**\nSubtotal:                                                     $1,480.00\nSales Tax (8%):                                               $118.40\n--------------------------------------------------------------------------------\n**TOTAL DUE:**                                                **$1,598.40**\n--------------------------------------------------------------------------------\n\n**PAYMENT TERMS:**\nPayment is due within 30 days of the invoice date. Please make checks payable to Creative Solutions Inc. For electronic payments, please contact us for details.\n\nThank you for your business!\n```"
         }],
         "role": "model"
       },
       "finishReason": "STOP",
       "index": 0
     }],
     "usageMetadata": {
       "promptTokenCount": 34,
       "candidatesTokenCount": 418,
       "totalTokenCount": 890,
       "promptTokensDetails": [{
         "modality": "TEXT",
         "tokenCount": 34
       }],
       "thoughtsTokenCount": 438
     },
     "modelVersion": "gemini-3-flash-preview",
     "responseId": "3w4Vad6yF-y1vdIP_q_zgAw",
     "turnToken": "v1:ChczdzRWYWQ2eUYteTF2ZElQX3FfemdBdxIXM3c0VmFkNnlGLXkxdmRJUF9xX3pnQXc"
   }
   

6. アプリのコードからテンプレートにアクセスする準備ができたら、 テンプレートをロック するには、テンプレートの 右上にある ロックアイコンをクリックします。

7. [Close] をクリックして編集を終了します。

ステップ 3: コードからテンプレートにアクセスする

Gemini API プロバイダをクリックして、このページでプロバイダ固有のコンテンツとコードを表示します。 Gemini Developer API Vertex AI Gemini API

サーバー プロンプト テンプレートを使用するリクエストは、他のリクエストと似ていますが、次の点が異なります。

• templateGenerativeModel（または必要に応じて templateImagenModel）を使用します。
• テンプレート ID を指定します。
• テンプレートに必要な変数入力の値を指定します。

テンプレートを作成または更新した後、コードからアクセスする前に、テンプレートが Firebase サーバー全体に伝播するまで数分かかる場合があります。

Swift

リクエストでテンプレートを使用するには、templateGenerativeModel インスタンス（または templateImagenModel）を作成します。

// ...

// Initialize the Gemini Developer API backend service
// Create a `TemplateGenerativeModel` instance
let model = FirebaseAI.firebaseAI(backend: .googleAI()).templateGenerativeModel()

let customerName = "Jane"

do {
    let response = try await model.generateContent(
        // Specify your template ID
        templateID: "my-first-template-v1-0-0",
        // Provide the values for any input variables required by your template.
        inputs: [
            "customerName": customerName
        ]
    )
    if let text = response.text {
        print("Response Text: \(text)")
    }
} catch {
    print("An error occurred: \(error)")
}
print("\n")

Kotlin

リクエストでテンプレートを使用するには、templateGenerativeModel インスタンス（または templateImagenModel）を作成します。

// ...

// Initialize the Gemini Developer API backend service
// Create a `TemplateGenerativeModel` instance
val model = Firebase.ai(backend = GenerativeBackend.googleAI()).templateGenerativeModel()

val customerName = "Jane"

val response = model.generateContent(
    // Specify your template ID
    "my-first-template-v1-0-0",
    // Provide the values for any input variables required by your template.
    mapOf(
        "customerName" to customerName
    )
)

val text = response.text
println(text)

Java

リクエストでテンプレートを使用するには、templateGenerativeModel インスタンス（または templateImagenModel）を作成します。

// ...

// Initialize the Gemini Developer API backend service
// Create a `TemplateGenerativeModel` instance
TemplateGenerativeModel generativeModel = FirebaseAI.getInstance().templateGenerativeModel();

TemplateGenerativeModelFutures model = TemplateGenerativeModelFutures.from(generativeModel);

String customerName = "Jane";

Future response = model.generateContent(
    // Specify your template ID
    "my-first-template-v1-0-0",
    // Provide the values for any input variables required by your template.
    mapOf("customerName", customerName)
);
addCallback(response,
       new FutureCallback() {
           public void onSuccess(GenerateContentResponse result) {
             System.out.println(result.getText());
           }
           public void onFailure(Throwable t) {
             reportError(t);
           }
    }
executor);

Web

リクエストでテンプレートを使用するには、templateGenerativeModel インスタンス（または templateImagenModel）を作成します。

// ...

// Initialize the Gemini Developer API backend service
const ai = getAI(app, { backend: new GoogleAIBackend() });

// Create a `TemplateGenerativeModel` instance
const model = getTemplateGenerativeModel(ai);

const customerName = 'Jane';

const result = await model.generateContent(
  // Specify your template ID
  'my-first-template-v1-0-0',
  // Provide the values for any input variables required by your template
  {
    customerName: customerName,
  }
);

const response = result.response;
const text = response.text();

Dart

Flutter プラグインは、近日中にサーバー プロンプト テンプレートをサポートする予定です。

リクエストでテンプレートを使用するには、templateGenerativeModel インスタンス（または templateImagenModel）を作成します。

// ...

// Initialize the Gemini Developer API backend service
// Create a `TemplateGenerativeModel` instance
var _model = FirebaseAI.googleAI().templateGenerativeModel()

var customerName = 'Jane';

var response = await _model.generateContent(
        // Specify your template ID
        'my-first-template-v1-0-0',
        // Provide the values for any input variables required by your template
        inputs: {
           'customerName': customerName,
        },
      );

var text = response?.text;
print(text);

Unity

リクエストでテンプレートを使用するには、templateGenerativeModel インスタンス（または templateImagenModel）を作成します。

// ...

// Initialize the Gemini Developer API backend service
var firebaseAI = FirebaseAI.GetInstance(FirebaseAI.Backend.GoogleAI());

// Create a `TemplateGenerativeModel` instance
var model = firebaseAI.GetTemplateGenerativeModel();

var customerName = "Jane";

try
{
   var response = await model.GenerateContentAsync(
      // Specify your template ID
      "my-first-template-v1-0-0",
      // Provide the values for any input variables required by your template
      new Dictionary<string, object> {
         { "customerName", customerName },
      }
   );
   Debug.Log($"Response Text: {response.Text}");
}
catch (Exception e) {
  Debug.LogError($"An error occurred: {e.Message}");
}

**重要:** サーバー プロンプト テンプレートで Firebase Remote Config を使用すると、リクエストのテンプレートやその他の値を簡単に変更できるため、強くおすすめします。

---

次のステップ

• サーバー プロンプト テンプレートの使用に関する ベスト プラクティスと考慮事項 について学習する。

• テンプレートの形式と構文の詳細と例を確認する 。

• テンプレートを管理する（ 編集、ロック、バージョン管理など）。