搭配使用伺服器端遠端設定、Cloud Functions 和 Vertex AI

本指南說明如何開始使用第 2 代 Cloud Functions，搭配伺服器端 Remote Config 對 Vertex AI Gemini API 進行伺服器端呼叫。

在本教學課程中，您將在類似聊天機器人的函式中新增 Remote Config，該函式會使用 Gemini 模型來回答使用者的問題。Remote Config 會管理 Gemini API 輸入內容 (包括您會在傳入的使用者查詢前加上提示訊息)，您可以視需要透過 Firebase 控制台更新這些輸入內容。您也會使用 Firebase Local Emulator Suite 測試及偵錯函式，然後在確認函式運作無誤後，在 Google Cloud 上部署及測試函式。

事前準備

本指南假設您已熟悉使用 JavaScript 開發應用程式。

設定 Firebase 專案

如果您還沒有 Firebase 專案：

登入 Firebase 控制台。
按一下「建立專案」，然後使用下列任一選項：
- 選項 1：在「建立專案」工作流程的第一個步驟中輸入新專案名稱，即可建立新的 Firebase 專案 (以及其底層 Google Cloud 專案)。
- 選項 2：在現有的 Google Cloud 專案中「新增 Firebase」，方法是在「建立專案」工作流程的第一個步驟中，從下拉式選單中選取 Google Cloud 專案名稱。
收到提示時，您不需要設定 Google Analytics 即可使用這項解決方案。
繼續按照畫面上的指示建立專案。

如果您已擁有 Firebase 專案：

請繼續設定開發環境。

設定開發環境

您需要 Node.js 環境才能編寫函式，並需要 Firebase CLI 才能將函式部署至 Cloud Functions 執行階段。

安裝 Node.js 和 npm。

如要安裝 Node.js 和 npm，建議您使用 Node Version Manager。

重要事項： 建議您使用 Node.js 20 以上版本。如要瞭解 Node.js 版本的持續支援服務，請參閱「設定執行階段選項」一文。
使用您偏好的方法安裝 Firebase CLI。舉例來說，如要使用 npm 安裝 CLI，請執行下列指令：
```
npm install -g firebase-tools@latest
```
這項指令會安裝全球適用的 firebase 指令。如果這個指令失敗，您可能需要變更 npm 權限。

如要更新至最新版的 firebase-tools，請重新執行相同的指令。
安裝 firebase-functions 和 firebase-admin，並使用 --save 將它們儲存至 package.json：
```
npm install firebase-functions@latest firebase-admin@latest --save
```

您現在可以繼續導入這個解決方案。

實作

請按照下列步驟，使用 Remote Config 和 Vertex AI 建立、測試及部署第 2 代 Cloud Functions：

在 Google Cloud 控制台中啟用 Vertex AI 建議的 API。
初始化專案並安裝 Node 依附元件。
為 Admin SDK 服務帳戶設定 IAM 權限，並儲存金鑰。
建立函式。
建立特定伺服器的 Remote Config 範本。
部署函式並在 Firebase Local Emulator Suite 中進行測試。
將函式部署至 Google Cloud。

步驟 1：在 Google Cloud 控制台中啟用 Vertex AI 建議的 API

開啟 Google Cloud 控制台，然後在系統提示時選取專案。
在控制台頂端的「Search」欄位中輸入 Vertex AI，然後等待 Vertex AI 顯示為結果。
選取 Vertex AI。系統會顯示 Vertex AI 資訊主頁。
點選「啟用所有建議的 API」。

API 啟用作業可能需要幾分鐘的時間才能完成。請保持頁面處於活動狀態並保持開啟，直到啟用程序完成為止。
如果未啟用帳單功能，系統會提示您新增或連結 Cloud Billing 帳戶。啟用結帳系統帳戶後，請返回 Vertex AI 資訊主頁，確認已啟用所有建議的 API。

步驟 2：初始化專案並安裝 Node 依附元件

在電腦上開啟終端機，然後前往您打算建立函式的目錄。
登入 Firebase：
```
firebase login
```
執行下列指令，初始化 Cloud Functions for Firebase：
```
firebase init functions
```
選取「使用現有專案」，然後指定專案 ID。
系統提示您選取要使用的語言時，請選擇「Javascript」，然後按下 Enter 鍵。
其他選項請選取預設值。

系統會在目前目錄中建立 functions 目錄。您會在其中找到用於建構函式的 index.js 檔案、包含函式依附元件的 node_modules 目錄，以及包含套件依附元件的 package.json 檔案。
請執行下列指令來新增 Admin SDK 和 Vertex AI 套件，並使用 --save 確保套件已儲存至 package.json 檔案：
```
cd functions
npm install firebase-admin@latest @google-cloud/vertexai --save
```

您的 functions/package.json 檔案現在應如下所示，並指定最新版本：

  {
    "name": "functions",
    "description": "Cloud Functions for Firebase",
    "scripts": {
      "serve": "firebase emulators:start --only functions",
      "shell": "firebase functions:shell",
      "start": "npm run shell",
      "deploy": "firebase deploy --only functions",
      "logs": "firebase functions:log"
    },
    "engines": {
      "node": "20"
    },
    "main": "index.js",
    "dependencies": {
      "@google-cloud/vertexai": "^1.1.0",
      "firebase-admin": "^12.1.0",
      "firebase-functions": "^5.0.0"
    },
    "devDependencies": {
      "firebase-functions-test": "^3.1.0"
    },
    "private": true
  }

請注意，如果您使用 ESLint，就會看到包含該工具的段落。此外，請確認節點引擎版本與您安裝的 Node.js 版本相符，以及您最終在 Google Cloud 上執行的版本。舉例來說，如果 package.json 中的 engines 節段已設為 Node 18 版，而您使用的是 Node.js 20，請更新檔案以使用 20：

  "engines": {
    "node": "20"
  },

步驟 3：為 Admin SDK 服務帳戶設定 IAM 權限並儲存金鑰

在這個解決方案中，您會使用 Firebase Admin SDK 服務帳戶執行函式。

在 Google Cloud 主控台中，開啟「IAM 與管理」頁面，然後找出 Admin SDK 服務帳戶 (名稱為 firebase-adminsdk)。

選取帳戶，然後按一下「編輯實體」。系統隨即顯示「編輯存取權」頁面。

按一下「Add another role」，然後選取「Remote Config Viewer」。

按一下「Add another role」，然後選取「AI platform developer」。

按一下「Add another role」(新增其他角色)，然後選取「Vertex AI user」(使用者)。

按一下「Add another role」(新增其他角色)，然後選取「Cloud Run Invoker」(Cloud Run 叫用者)。

按一下 [儲存]。

接下來，請匯出 Admin SDK 服務帳戶的憑證，並儲存在 GOOGLE_APPLICATION_CREDENTIALS 環境變數中。

在 Google Cloud 主控台中，開啟「憑證」頁面。

按一下 Admin SDK 服務帳戶，開啟「詳細資料」頁面。

按一下「Keys」。

依序點選「新增金鑰」 >「建立新的金鑰」。

確認已選取「JSON」做為「金鑰類型」，然後按一下「建立」。

將金鑰下載到電腦上的安全位置。

在終端機中，將金鑰匯出為環境變數：

export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account-key.json"

提示： 如果您打算在這個工作階段使用多個終端機視窗，請考慮將 GOOGLE_APPLICATION_CREDENTIALS 新增為系統變數。

步驟 4：建立函式

在這個步驟中，您將建構函式，以便處理使用者輸入內容並產生 AI 技術輔助的回應。您將結合多個程式碼片段，建立可初始化 Admin SDK 和 Vertex AI Gemini API、使用 Remote Config 設定預設參數、擷取最新 Remote Config 參數、處理使用者輸入內容，以及將回應串流傳送給使用者的完整函式。

重要事項： 這項函式的程式碼會在多個程式碼片段中提供。您必須先將這些檔案全部合併為單一 index.js 檔案，才能執行函式。

在程式碼集中，使用文字編輯器或 IDE 開啟 functions/index.js。

刪除現有內容，然後新增 Admin SDK、Remote Config 和 Vertex AI SDK，並將下列程式碼貼到檔案中，以便初始化應用程式：

const { onRequest } = require("firebase-functions/v2/https"); const logger = require("firebase-functions/logger"); const { initializeApp } = require("firebase-admin/app"); const { VertexAI } = require('@google-cloud/vertexai'); const { getRemoteConfig } = require("firebase-admin/remote-config"); // Set and check environment variables. const project = process.env.GCLOUD_PROJECT; // Initialize Firebase. const app = initializeApp();index.js

設定函式無法連線至 Remote Config 伺服器時，所使用的預設值。這個解決方案會將 textModel、generationConfig、safetySettings、textPrompt 和 location 設為 Remote Config 參數，對應至您稍後在本指南中進一步設定的 Remote Config 參數。如要進一步瞭解這些參數，請參閱 Vertex AI Node.js 用戶端。

您也可以視需要設定參數，用來控制是否要存取 Vertex AI Gemini API (在本例中，參數名稱為 vertex_enabled)。這項設定在測試函式時非常實用。在下列程式碼片段中，這個值設為 false，這樣在測試基本函式部署時，系統就會略過使用 Vertex AI。將其設為 true 會叫用 Vertex AI Gemini API。

// Define default (fallback) parameter values for Remote Config. const defaultConfig = { // Default values for Vertex AI. model_name: "gemini-1.5-flash-002", generation_config: [{ "stopSequences": [], "temperature": 0.7, "maxOutputTokens": 64, "topP": 0.1, "topK": 20 }], 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!", safety_settings: [{ "category": "HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT", "threshold": "HarmBlockThreshold.BLOCK_MEDIUM_AND_ABOVE" }], location: 'us-central1', // Disable Vertex AI Gemini API access for testing. vertex_enabled: false };index.js

建立函式並設定伺服器端 Remote Config：

// Export the function. exports.generateWithVertex = onRequest(async (request, response) => { try { // Set up Remote Config. const rc = getRemoteConfig(app); // Get the Remote Config template and assign default values. const template = await rc.getServerTemplate({ defaultConfig: defaultConfig }); // Add the template evaluation to a constant. const config = template.evaluate(); // Obtain values from Remote Config. const textModel = config.getString("model_name") || defaultConfig.model_name; const textPrompt = config.getString("prompt") || defaultConfig.prompt; const generationConfig = config.getString("generation_config") || defaultConfig.generation_config; const safetySettings = config.getString("safety_settings") || defaultConfig.safety_settings; const location = config.getString("location") || defaultConfig.location; const vertexEnabled = config.getBoolean("is_vertex_enabled") || defaultConfig.vertex_enabled;index.js

設定 Vertex AI，並新增聊天和回應邏輯：

// Allow user input. const userInput = request.query.prompt || ''; // Instantiate Vertex AI. const vertex_ai = new VertexAI({ project: project, location: location }); const generativeModel = vertex_ai.getGenerativeModel({ model: textModel, safety_settings: safetySettings, generation_config: generationConfig, }); // Combine prompt from Remote Config with optional user input. const chatInput = textPrompt + " " + userInput; if (!chatInput) { return res.status(400).send('Missing text prompt'); } // If vertexEnabled isn't true, do not send queries to Vertex AI. if (vertexEnabled !== true) { response.status(200).send({ message: "Vertex AI call skipped. Vertex is not enabled." }); return; } logger.log("\nRunning with model ", textModel, ", prompt: ", textPrompt, ", generationConfig: ", generationConfig, ", safetySettings: ", safetySettings, " in ", location, "\n"); const result = await generativeModel.generateContentStream(chatInput); response.writeHead(200, { 'Content-Type': 'text/plain' }); for await (const item of result.stream) { const chunk = item.candidates[0].content.parts[0].text; logger.log("Received chunk:", chunk); response.write(chunk); } response.end(); } catch (error) { logger.error(error); response.status(500).send('Internal server error'); } });index.js

儲存並關閉檔案。

提示： 如要進一步瞭解如何搭配使用 Vertex AI 和 Node.js 產生多模態和串流回應，請參閱 Node.js 適用的 Vertex AI 快速入門指南。

步驟 5：建立特定伺服器的 Remote Config 範本

接著，請建立伺服器端 Remote Config 範本，並設定要在函式中使用的參數和值。如要建立特定伺服器的 Remote Config 範本，請按照下列步驟操作：

開啟 Firebase 主控台，然後在導覽選單中展開「Run」，並選取「Remote Config」。

在 Remote Config 頁面頂端的「Client/Server」選取器中，選取「Server」。

如果這是您首次使用 Remote Config 或伺服器範本，請按一下「建立設定」。「建立第一個伺服器端參數」窗格隨即顯示。

如果您之前使用過 Remote Config 伺服器範本，請按一下「新增參數」。

定義下列 Remote Config 參數：

參數名稱 說明類型 預設值

model_name 模型名稱
如要查看在程式碼中使用的最新模型名稱清單，請參閱「模型版本和生命週期」或「可用的模型名稱」。字串 gemini-1.5-flash-002

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}]

safety_settings Vertex AI 的安全設定。 JSON [{"category": "HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT", "threshold": "HarmBlockThreshold.BLOCK_LOW_AND_ABOVE"}]

location 執行 Vertex AI 服務和模型的所在位置。字串 us-central1

is_vertex_enabled 選用參數，用於控制是否要將查詢傳送至 Vertex AI。布林值 true

重要事項： 模型會經常更新。如需 Vertex AI 目前支援的模型清單，請參閱「模型版本和生命週期」。

新增參數完成後，請仔細檢查參數及其資料類型是否正確，然後按一下「發布變更」。

步驟 6：部署函式並在 Firebase Local Emulator Suite 中測試

您現在可以使用 Firebase Local Emulator Suite 在本機部署及測試函式了。

請確認您已按照「步驟 3：為 Admin SDK 服務帳戶設定 IAM 權限並儲存金鑰」一文的說明，將 GOOGLE_APPLICATION_CREDENTIALS 設為環境變數。接著，從 functions 目錄的父目錄，將函式部署至 Firebase 模擬器：

firebase emulators:start --project PROJECT_ID --only functions
提示： 您也可以從 functions 目錄執行 npm run serve，在模擬器中執行函式。

開啟模擬器的記錄檔頁面。這應該會顯示函式已載入。

執行下列指令即可存取函式，其中 PROJECT_ID 是您的專案 ID，LOCATION 則是您部署函式的區域 (例如 us-central1)：

curl http://localhost:5001/PROJECT_ID/LOCATION/generateWithVertex
提示： 啟動模擬器後，這個連結也會顯示在主控台輸出內容中。你也可以將這段文字剪下並貼到瀏覽器中。

等待回應，然後返回 Firebase Emulator 記錄頁面或控制台，檢查是否有任何錯誤或警告。

請嘗試傳送一些使用者輸入內容，請注意，由於 is_vertex_enabled 已在 Remote Config 伺服器範本中設定，因此應透過 Vertex AI Gemini API 存取 Gemini，且這可能會產生費用：

curl http://localhost:5001/PROJECT_ID/LOCATION/generateWithVertex?prompt=Tell%20me%20everything%20you%20know%20about%20cats

在 Firebase 控制台上變更 Remote Config 伺服器範本，然後重新存取函式，觀察變更情形。

提示： 如要進一步瞭解如何使用 Firebase 測試 Cloud Functions，請參閱「以互動方式測試函式」一文。

步驟 7：將函式部署至 Google Cloud

測試並驗證函式後，即可將其部署至 Google Cloud 並測試實際運作的函式。

重要事項： 雖然在 Firebase 模擬器中測試函式不會產生費用，但使用模擬器時對 Vertex AI 的任何呼叫仍會產生費用。此外，在您部署函式後，任何對這些函式的叫用都會產生費用。請先查看 Vertex AI 定價和 Cloud Functions 定價，再繼續操作。
部署函式

使用 Firebase CLI 部署函式：

firebase deploy --only functions

封鎖未經認證的函式存取權

使用 Firebase 部署函式時，如果機構政策未限制這項操作，系統預設會允許未經驗證的叫用作業。在測試期間，以及在使用 App Check 進行安全防護前，建議您封鎖未經認證的存取權。

如要封鎖未經驗證的函式存取權，請按照下列步驟操作：

在 Google Cloud 控制台中開啟「Cloud Run」。

按一下 generateWithVertex，然後點選「安全性」分頁標籤。

啟用「需要驗證」，然後按一下「儲存」。

設定使用者帳戶以使用 Admin SDK 服務帳戶憑證

由於 Admin SDK 服務帳戶具備執行函式及與 Remote Config 和 Vertex AI Gemini API 互動的所有必要角色和權限，因此建議您使用該帳戶執行函式。如要執行這項操作，您必須能夠透過使用者帳戶為帳戶建立權杖。

以下步驟說明如何設定使用者帳戶和函式，以便使用 Admin SDK 服務帳戶權限執行。

在 Google Cloud 主控台中，啟用 IAM Service Account Credentials API。

為使用者帳戶授予「Service Account Token Creator」角色：在 Google Cloud 控制台中，依序開啟「IAM & Admin」 >「IAM」，選取使用者帳戶，然後按一下「Edit principal」 >「Add another role」。

選取「Service Account Token Creator」，然後按一下「Save」。

如要進一步瞭解服務帳戶模擬功能，請參閱 Google Cloud 說明文件中的「服務帳戶模擬功能」。

開啟 Google Cloud 主控台 Cloud Functions 頁面，然後按一下「Functions」清單中的「generateWithVertex」函式。

依序選取「Trigger」 >「Edit」，然後展開「Runtime, build, connections and security settings」。

在「執行階段」分頁中，將「執行階段服務帳戶」變更為「Admin SDK 帳戶」。

依序點選「下一步」和「部署」。

設定 gcloud CLI

如要透過指令列安全地執行及測試函式，您必須使用 Cloud Functions 服務進行驗證，並取得有效的驗證權杖。

如要啟用權杖產生功能，請安裝並設定 gcloud CLI：

如果電腦尚未安裝 gcloud CLI，請按照「安裝 gcloud CLI」一節所述安裝該工具。

取得 Google Cloud 帳戶的存取憑證：

gcloud auth login

在 gcloud 中設定專案 ID：

gcloud config set project PROJECT_ID

測試函式

您現在可以測試 Google Cloud 中的函式。如要測試函式，請執行下列指令：

curl -X POST https://LOCATION-PROJECT_ID.cloudfunctions.net/generateWithVertex \ -H "Authorization: bearer $(gcloud auth print-identity-token)" \ -H "Content-Type: application/json"

使用使用者提供的資料再試一次：

curl -X POST https://LOCATION-PROJECT_ID.cloudfunctions.net/generateWithVertex?prompt=Tell%20me%20everything%20you%20know%20about%20dogs \ -H "Authorization: bearer $(gcloud auth print-identity-token)" \ -H "Content-Type: application/json"

您現在可以變更 Remote Config 伺服器範本、發布這些變更，並測試不同的選項。

後續步驟

Firebase 建議您使用 App Check 保護 Cloud Functions。如要進一步瞭解如何使用 App Check 保護函式，請參閱「為 Cloud Functions 啟用 App Check 強制執行」。

請參閱「使用 Remote Config 和 App Check 呼叫 Vertex AI Gemini API」一文，試用含有伺服器端 Remote Config 和 App Check 的可呼叫函式範例。

進一步瞭解 Cloud Functions 適用於 Firebase。

進一步瞭解如何在伺服器環境中使用 Remote Config。

參數名稱	說明	類型	預設值
`model_name`	模型名稱如要查看在程式碼中使用的最新模型名稱清單，請參閱「模型版本和生命週期」或「可用的模型名稱」。	字串	`gemini-1.5-flash-002`
`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}]`
`safety_settings`	Vertex AI 的安全設定。	JSON	`[{"category": "HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT", "threshold": "HarmBlockThreshold.BLOCK_LOW_AND_ABOVE"}]`
`location`	執行 Vertex AI 服務和模型的所在位置。	字串	`us-central1`
`is_vertex_enabled`	選用參數，用於控制是否要將查詢傳送至 Vertex AI。	布林值	`true`