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

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

1. 在 Google Cloud 控制台中，開啟「Credentials」(憑證) 頁面。
2. 按一下 Admin SDK 服務帳戶，開啟「詳細資料」頁面。
3. 按一下「鍵」。
4. 依序點選「新增金鑰」 >「建立新的金鑰」。
5. 確認已選取「JSON」做為「金鑰類型」，然後按一下「建立」。
6. 將金鑰下載到電腦上的安全位置。

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

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

步驟 4：建立函式

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

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

2. 刪除現有內容，然後新增 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
   

3. 設定函式無法連線至 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
   

4. 建立函式並設定伺服器端 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
   

5. 設定 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
   

6. 儲存並關閉檔案。

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

接著，請建立伺服器端 Remote Config 範本，並設定要在函式中使用的參數和值。如何建立伺服器專屬的 Remote Config 範本：

1. 開啟 Firebase 控制台，從導覽選單中展開「Run」(執行) 並選取「Remote Config」。

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

   • 如果您是第一次使用 Remote Config 或伺服器範本，請按一下「Create Configuration」。「建立第一個伺服器端參數」窗格隨即顯示。
   • 如果您之前使用過 Remote Config 伺服器範本，請按一下「新增參數」。

3. 定義下列 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

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

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

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

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

   firebase emulators:start --project PROJECT_ID --only functions
   

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

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

   curl http://localhost:5001/PROJECT_ID/LOCATION/generateWithVertex
   

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

5. 請嘗試傳送一些使用者輸入內容，請注意，由於 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
   

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

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

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

部署函式

使用 Firebase CLI 部署函式：

firebase deploy --only functions

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

使用 Firebase 部署函式時，如果機構政策未禁止未經認證的叫用作業，系統預設會允許這類作業。在測試期間，以及使用 App Check 加以保護前，建議您封鎖未經認證的存取權。

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

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

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

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

將使用者帳戶設為使用「Admin SDK」服務帳戶憑證

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

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

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

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

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

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

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

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

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

設定 gcloud CLI

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

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

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

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

   gcloud auth login
   

3. 在 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。