遠端設定範本和版本管理


遠端設定範本是您為 Firebase 專案建立的 JSON 格式參數和條件組合。您可以建立「用戶端」範本，供應用程式從中擷取值，以及「伺服器」範本，供伺服器用戶端從中擷取值。

本節討論伺服器範本。如要瞭解用戶端專屬範本，請按一下「Client templates」(用戶端範本)。

透過 Firebase 控制台修改和管理範本，該範本會在「Parameters」和「Conditions」分頁中以圖像格式顯示範本內容。

以下是伺服器範本檔案的範例：

{
  "parameters": {
    "preamble_prompt": {
      "defaultValue": {
        "value": "You are a helpful assistant who knows everything there is to know about Firebase! "
      },
      "description": "Add this prompt to the user's prompt",
      "valueType": "STRING"
    },
    "model_name": {
      "defaultValue": {
        "value": "gemini-pro-test"
      },
      "valueType": "STRING"
    },
    "generation_config": {
      "defaultValue": {
        "value": "{\"temperature\": 0.9, \"maxOutputTokens\": 2048, \"topP\": 0.9, \"topK\": 20}"
      },
      "valueType": "JSON"
    },
  },
  "version": {
    "versionNumber": "19",
    "isLegacy": true
  }
}

您可以透過 Firebase 控制台執行下列版本管理工作：

  • 列出所有儲存的範本版本
  • 擷取特定版本
  • 復原至特定用戶端版本
  • 從「變更記錄」頁面刪除遠端設定範本

每個範本類型 (300 個用戶端範本和 300 個伺服器範本) 的生命週期儲存版本總數上限為 300 個，包括為已刪除範本儲存的版本編號。如果您在專案生命週期內，每個範本類型發布超過 300 個範本版本，就會刪除最早的版本，最多仍能維持該類型的 300 個版本。

每次更新參數時，遠端設定都會建立新的版本化遠端設定範本，並將先前的範本儲存為版本，讓您可以視需要擷取或復原。版本號碼會從遠端設定儲存的初始值依序遞增。所有範本皆包含 version 欄位 (如圖所示)，其中包含該特定版本的中繼資料。

您可以視需要從 變更記錄 頁面，刪除遠端設定範本。

管理遠端設定範本版本

本節說明如何管理遠端設定範本的版本。

列出遠端設定範本的所有已儲存版本

您可以擷取遠端設定範本的所有已儲存版本清單。現在說明一下操作方式：

  1. 在 Firebase 控制台中開啟遠端設定。

  2. 接著，在「Parameters」分頁中，選取右上方顯示的「時鐘」圖示。

    「變更記錄」頁面就會開啟，並在右側的清單選單中列出所有已儲存的範本版本。

    範本清單包含所有已儲存版本的中繼資料，包括更新時間、更新使用者和製作方式。

擷取特定版本的遠端設定範本

您可以擷取任何特定的遠端設定範本儲存版本。如要擷取已儲存的範本版本：

  1. 開啟「變更記錄」的詳細資料窗格。

  2. 如要查看清單中其他版本的詳細資料，請從右側選單中選取該版本。

  3. 將遊標懸停在任何未選取版本的內容選單上，然後選取「Compare with selected version」，即可查看使用中範本和其他任何儲存版本的詳細差異。

將遠端設定範本復原至特定已儲存的版本

您可以將範本復原為任何已儲存的版本。如何復原範本：

  1. 找到「變更記錄」頁面右上方的選項按鈕。除非您確認要復原至該版本，並「立即」對所有應用程式和使用者使用這些值，否則請勿進行確認。

請注意，這項復原作業實際上會建立一個新的編號版本。舉例來說，從第 10 版復原到第 6 版，會有效建立第 6 版的新副本，唯一的差別在於其版本編號是 11。如果原始版本 6 尚未到期，則原始版本 6 仍然會保留下來，而第 11 版成為使用中的範本。

刪除遠端設定範本

您可以透過 Firebase 控制台刪除遠端設定範本。如要刪除遠端設定範本：

1. 在遠端設定的「參數」頁面中，按一下 「變更記錄」。

  1. 切換到要刪除的範本，然後按一下 「More」，然後選取「Delete」。

  2. 系統提示您確認刪除時，按一下「Delete」(刪除)。

下載並發布遠端設定範本

下載並發布遠端設定範本，將範本整合至來源控制與建構系統、自動更新設定，並讓參數和值在不同專案中保持同步。

您可以透過程式輔助方式下載目前啟用中的遠端設定範本。 接著，您可以更新匯出的 JSON 檔案並發布至相同專案，或發布至新專案或現有專案。

假設您有多個專案都代表軟體開發生命週期的不同階段，例如開發、測試、測試和實際工作環境。在此情況下，您可以從測試環境下載範本，並發布到正式環境專案，藉此將經過全面測試的範本從測試環境推送至實際工作環境。

您也可以使用這個方法在專案之間遷移設定，或是利用既有專案中的參數和值填入新專案。

在 A/B 測試實驗中專為變化版本建立的參數和參數值，不包含在匯出的範本中。

如何匯出及匯入遠端設定範本：

  1. 下載目前的遠端設定設定範本。
  2. 驗證遠端設定範本。
  3. 發布遠端設定範本。

下載目前的遠端設定範本

如要以 JSON 格式下載有效的遠端設定範本，請使用下列指令：

  1. 在遠端設定參數或條件分頁中，開啟「Menu」(選單)，然後選取「Download current config file」(下載目前的設定檔)。
  2. 出現提示時，按一下「Download config file」，選擇要儲存檔案的位置，然後按一下「Save」。

驗證遠端設定範本

當您嘗試透過 Firebase 主控台發布時，系統會驗證伺服器範本。請注意，您可以匯入「隨機百分比」條件的使用者，但任何不支援的條件都會在上傳期間產生錯誤。如果您要發布原本從用戶端範本匯出的範本，請務必先移除任何用戶端專屬條件。

發布遠端設定範本

下載範本、對 JSON 內容做出必要變更並進行驗證後，您就能將範本發布到專案。

發布範本會將整個現有設定範本替換成更新後的檔案，並將範本版本遞增 1。由於整個設定會遭到取代，因此如果您從 JSON 檔案刪除並發布參數，該參數會從伺服器刪除，也無法再提供給用戶端。

發布後，參數和值的變更內容會「立即」提供給應用程式和使用者。如有需要，您可以復原至先前版本。

使用下列指令發布範本：

  1. 在遠端設定參數或條件分頁中，開啟「選單」並選取「從檔案發布」。
  2. 系統提示時，請按一下「Browse」(瀏覽)，前往並選取要發布的遠端設定檔，然後按一下「Select」(選取)。
  3. 系統會驗證檔案。如果成功，您可以按一下「Publish」(發布)，將設定立即提供給應用程式和使用者。

後續步驟