在伺服器環境使用遠端設定

Firebase Remote Config 現在支援使用 Firebase Admin Node.js SDK 12.1.0 以上版本的伺服器端設定。這項新功能可讓您使用 Remote Config 動態管理伺服器端應用程式的行為和設定。這包括 Cloud Functions 等無伺服器導入作業。

與 Firebase 用戶端 SDK 不同,後者會從 Remote Config 範本擷取衍生的用戶端專屬設定,而伺服器端 Remote Config SDK 則會從 Firebase 下載完整Remote Config 範本。這樣一來,伺服器就能根據每個傳入的要求評估範本,並使用自身邏輯提供低延遲的自訂回應。您可以使用條件,根據自訂信號中定義的隨機百分比和用戶端屬性,控制及自訂回應。

您可以透過伺服器端 Remote Config 執行下列操作:

  • 為在伺服器上執行或透過伺服器存取的應用程式定義設定參數,以便遠端設定 AI 模型參數和提示,以及其他整合,確保 API 金鑰安全無虞。
  • 根據環境變更或其他應用程式變更 (例如更新 LLM 參數和模型端點),動態調整參數。
  • 透過遠端更新伺服器呼叫的 API,控管費用。
  • 為存取伺服器的用戶端即時產生自訂設定。
  • 記錄哪些用戶端收到參數值,並在 Cloud Functions 中使用此值,做為授權驗證系統的一部分。

您可以在 Cloud Run、Cloud Functions 或自管伺服器環境中部署伺服器端 Remote Config

事前準備

請按照「將 Firebase Admin SDK 新增至伺服器」中的操作說明,建立 Firebase 專案、設定服務帳戶,並將 Firebase Admin Node.js SDK 新增至伺服器。

步驟 1:初始化 Firebase Admin Node.js SDK 並授權 API 要求

當您在沒有參數的情況下初始化 Admin SDK 時,SDK 會使用 Google 應用程式預設憑證,並從 GOOGLE_APPLICATION_CREDENTIALS 環境變數讀取選項。舉例來說,如要初始化 SDK 並新增 Remote Config

import { initializeApp } from "firebase-admin/app";
import { getRemoteConfig } from "firebase-admin/remote-config";

// Initialize Firebase
const firebaseApp = initializeApp();

步驟 2:找出伺服器應用程式的預設參數值

找出您想透過 Remote Config 動態更新的應用程式變數。接著,請考量應用程式中必須預設設定哪些變數,以及這些變數的預設值。這樣一來,即使應用程式與 Remote Config 後端伺服器的連線中斷,應用程式仍可順利執行。

舉例來說,如果您要編寫用於管理生成式 AI 函式的伺服器應用程式,可以設定預設模型名稱、提示前置文字和生成式 AI 設定,如下所示:

參數名稱 說明 類型 預設值
model_name 模型 API 名稱 字串 gemini-1.5-pro
preamble_prompt 提示要附加到使用者的查詢 字串 I'm a developer who wants to learn about Firebase and you are a helpful assistant who knows everything there is to know about Firebase!
generation_config 要傳送至模型的參數 JSON {"stopSequences": ["I hope this helps"], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}

步驟 3:設定伺服器應用程式

確定要與 Remote Config 搭配使用的參數後,請設定應用程式,以便設定預設值、擷取特定伺服器的 Remote Config 範本,並使用其值。以下步驟說明如何設定 Node.js 應用程式。

  1. 存取及載入範本。

    // Initialize server-side Remote Config
    const rc = getRemoteConfig(firebaseApp);
    const template = rc.initServerTemplate();
    
    // Load Remote Config
    await template.load();
    

    如果您在 Cloud Functions 中使用 Node.js,可以使用非同步 getServerTemplate 在單一步驟中擷取及載入範本:

    // Initialize server-side Remote Config
    const rc = getRemoteConfig(firebaseApp);
    const template = await rc.getServerTemplate();
    
  2. 為確保應用程式即使與 Remote Config 後端伺服器的連線中斷,也能順利執行,請在應用程式中為每個參數新增預設值。如要這麼做,請在 initServerTemplategetServerTemplate 範本函式中新增 defaultConfig

    const template = rc.initServerTemplate({
      defaultConfig: {
        model_name: "gemini-pro",
        generation_config: '{"stopSequences": [], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}',
        preamble_prompt: "I'm a developer who wants to learn about Firebase and you are a helpful assistant who knows everything there is to know about Firebase!"
      },
    });
    
    // Load Remote Config
    await template.load()
    
  3. 範本載入後,請使用 template.evaluate() 從範本匯入參數和值:

    // Add template parameters to config
    const config = template.evaluate();
    
  4. 您也可以在 Remote Config 範本中設定條件,定義並提供所需的值:

    • 如果使用百分比條件,請在 template.evaluate() 函式中新增要用於評估條件的 randomizationId
    • 如果使用自訂信號,請定義屬性及其值。自訂信號適用於 Firebase Admin Node.js SDK 12.5.0 以上版本。

    舉例來說,您可以將 Firebase 安裝 ID 設為 randomizationId (或使用者 ID),確保與您的伺服器聯絡的每位使用者都會加入適當的隨機群組、version 做為指定特定用戶端版本的自訂信號,以及 platform 做為指定用戶端平台的自訂信號。

    如要進一步瞭解條件,請參閱「條件規則類型」。

    // Add template parameters to `config`. Evaluates the
    // template and returns the parameter value assigned to
    // the group assigned to the {randomizationId} and version.
    const config = template.evaluate({
      randomizationId: "2ac93c28-c459-4760-963d-a3974ec26c04",
      version: "1.0",
      platform: "Android"
    });
    
    
  5. 接下來,請從設定常數中擷取所需的參數值。使用 gettersRemote Config 的值轉換為預期格式。支援以下類型:

    • 布林值:getBoolean
    • 物件:getValue
    • 編號:getNumber
    • 字串:getString

    舉例來說,如果您在伺服器上導入 Vertex AI,並想要變更模型和模型參數,建議您為 model_namegenerationConfig 設定參數。以下範例說明如何存取 Remote Config 的值:

    // Replace defaults with values from Remote Config.
    const generationConfig =
      JSON.parse(
        config.getString('generation_config'));
    
    const is_ai_enabled = config.getBool('is_ai_enabled');
    
    const model = config.getString('model_name');
    
    // Generates a prompt comprised of the Remote Config
    // parameter and prepends it to the user prompt
    const prompt = `${config.getString('preamble_prompt')} ${req.query.prompt}`;
    
  6. 如果您的伺服器是長時間執行的伺服器 (而非無伺服器環境),請使用 setInterval 定期重新載入範本,確保您定期從 Remote Config 伺服器擷取最新的範本。

步驟 4:在 Remote Config 中設定伺服器專屬參數值

接著,請建立伺服器 Remote Config 範本,並設定應用程式要使用的參數和值。

如要建立特定伺服器的 Remote Config 範本,請按照下列步驟操作:

  1. 開啟 Firebase 控制台 Remote Config 參數頁面,然後從 Client/Server 選取器中選取 Server
  2. 定義 Remote Config 參數時,請使用與應用程式中定義的參數相同的名稱和資料類型,並提供值。擷取及評估範本並將這些值指派給變數時,這些值會覆寫您在「設定伺服器應用程式」中設定的 defaultConfig
  3. 您可以視情況設定條件,將值持續套用至隨機的執行個體樣本或自訂信號。如要進一步瞭解條件,請參閱「條件規則類型」。
  4. 新增參數完成後,請按一下「發布變更」
  5. 查看變更內容,然後再次按一下「發布變更」

步驟 5:使用 Cloud Functions 或 Cloud Run 部署

如果您的伺服器應用程式是輕量且事件驅動的,建議您使用 Cloud Functions 部署程式碼。舉例來說,假設您的應用程式包含由生成式 AI API (例如 Google AIVertex AI) 提供的角色對話。在這種情況下,您可以在應用程式按需呼叫的函式中代管 LLM 服務邏輯。

如果您的應用程式是長時間執行的應用程式 (例如含有資產的網頁應用程式),不妨考慮使用 Cloud Run。如要使用 Cloud Run 部署伺服器應用程式,請按照「快速入門導覽課程:將 Node.js 服務部署至 Cloud Run」中的指南操作。

如要進一步瞭解 Cloud Run 和 Cloud Functions 的最佳用途,請參閱「Cloud Functions 與 Cloud Run:何時應使用哪一個」。