匯入搜尋的自動完成資料

自動完成功能可預測使用者輸入的字詞,提升搜尋體驗。根據您提供的資料集或使用者事件,提供自動完成建議。

只有在需要額外控制項 (請勿移除清單、拒絕清單) 或使用自己的自動完成資料時,才考慮匯入自動完成資料。在大多數需要自動完成功能的情況下,開啟自動學習功能就已足夠。自動學習功能會根據使用者搜尋事件,提供以機器學習技術為基礎的建議資料集。如要瞭解如何開啟自動學習功能,請參閱「自動完成」。

以下操作說明僅適用於上傳自己的自動完成資料。如果您打算一直使用自動完成資料集,請務必保持最新狀態。如要在查詢時取得自動完成結果,請參閱 CompletionService.CompleteQuery。自動完成資料只會用於搜尋。建議不會使用這項資料。

事前準備

您必須先完成「事前準備」一節中的操作說明,特別是設定專案建立服務帳戶,以及將服務帳戶新增至本機環境,才能匯入自動完成資訊。

您必須具備「Retail 編輯者」身分與存取權管理角色,才能執行匯入作業。

自動完成匯入最佳做法

匯入自動完成資料時,請務必採用下列最佳做法:

  • 請參閱下列章節和 API 說明文件,瞭解 BigQuery 結構定義。

  • 請勿使用預留位置值。

  • 請盡可能多加入欄位。

  • 如果您打算使用自行上傳的資料集,請確保自己的自動完成資料集為最新版本。

  • 不允許從其他專案匯入資料。

匯入自動完成資料

從 BigQuery 匯入自動完成資料

Vertex AI Search for commerce 支援匯入 BigQuery 資料,用於拒絕清單、請勿移除清單和建議字詞清單。詳情請參閱「自動完成」。

如要從 BigQuery 匯入格式正確的自動完成資料,請使用 Vertex AI Search for commerce 自動完成結構定義建立格式正確的 BigQuery 資料表,然後載入自動完成資料。然後將資料上傳至商家適用的 Vertex AI Search。

如需 BigQuery 資料表的更多說明,請參閱資料表簡介。如需 BigQuery 查詢方面的協助,請參閱「查詢 BigQuery 資料總覽」一文。

BigQuery 資料集位置

首次為自動完成 BigQuery 資料表建立 BigQuery 資料集時,請務必將資料集位置設為多區域位置 "US"。如果未正確設定,稍後匯入要求就會失敗。如要進一步瞭解 BigQuery 資料集位置,請參閱 BigQuery 說明文件中的「資料集位置」。

將資料填入 BigQuery

使用 Vertex AI Search for commerce 自動完成結構定義,將自動完成資料上傳至 BigQuery。

BigQuery 可以使用結構定義驗證 JSON 格式的資料是否具有正確的欄位名稱和類型 (例如 STRINGINTEGERRECORD),但無法執行驗證,例如判斷:

  • 如果字串欄位對應至可辨識的列舉值。
  • 字串欄位是否使用正確格式。
  • 整數或浮點欄位的值是否在有效範圍內。
  • 如果缺少的欄位是必填欄位。

為確保資料品質和使用者搜尋體驗,請務必參閱結構定義和參考文件,瞭解值和格式的詳細資訊。

設定 BigQuery 資料集存取權

如要設定存取權,請確認 BigQuery 資料集與 Vertex AI Search for commerce 服務位於同一個專案中,然後完成下列步驟。

  1. 在 Google Cloud 控制台中開啟「IAM」頁面。

    開啟「IAM」頁面

  2. 選取 Vertex AI Search for Commerce 專案。

  3. 在「IAM 與管理」頁面中,按一下 「授予存取權」

  4. 針對「New principals」(新主體),輸入 cloud-retail-customer-data-access@system.gserviceaccount.com 並選取「BigQuery」>「BigQuery Data Viewer」(BigQuery 資料檢視者) 角色。

    如果不想為整個專案提供資料檢視者角色,可以直接將這個角色新增至資料集。瞭解詳情

  5. 按一下 [儲存]

觸發資料匯入商家適用的 Vertex AI Search

主控台

  1. 前往「Controls」(控制項) 頁面

  2. 前往「自動完成控制項」分頁。

  3. 在「字詞清單」部分,找出要匯入的清單類型 (拒絕清單請勿移除清單建議字詞清單),然後按一下「匯入」或「取代」

    「匯入」窗格隨即開啟。

  4. 輸入資料位置的 BigQuery 路徑,或選取「瀏覽」來選取位置。

    BigQuery 路徑必須位於同一專案,且結構定義應正確無誤。如要確認,請按一下「Browse」(瀏覽),然後按一下資料表名稱,在 BigQuery 控制台中查看內容。

  5. 在「匯入」窗格中,按一下「匯入」

    匯入作業隨即開始。您可以離開這個頁面,匯入作業不會因此中斷。

cURL

  1. 建立匯入作業的輸入參數資料檔案。輸入參數值取決於您是從 Cloud Storage 還是 BigQuery 匯入資料。

    使用 BigQuerySource 物件指向 BigQuery 資料集。

    {
      "inputConfig":{
        "bigQuerySource": {
          "datasetId":"dataset-id",
          "tableId":"table-id",
          "dataSchema":"data-schema"
        }
      }
    }
  2. 如要將自動完成資訊匯入商家適用的 Vertex AI Search,請對 CompletionData:import REST 方法發出 POST 要求,並提供資料檔案名稱 (如下方範例所示,為 input.json)。

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" -d @./input.json
    "https://retail.googleapis.com/v2alpha/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/completionData:import"

    您可以使用 API 透過程式輔助方式檢查狀態。您會收到類似下方的回應物件:

    {
      "name": "projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456",
      "done": false
    }

    名稱欄位是作業物件的 ID。如要要求這個物件的狀態,請將名稱欄位替換為匯入方法傳回的值。匯入完成後,done 欄位會傳回 true

    curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    "https://retail.googleapis.com/v2alpha/projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456"

    作業完成後,傳回的物件會包含 truedone 值,以及類似下列範例的 Status 物件:

    {
      "name": "projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.retail.v2alpha.ImportMetadata",
        "createTime": "2020-01-01T03:33:33.000001Z",
        "updateTime": "2020-01-01T03:34:33.000001Z",
        "successCount": "2",
        "failureCount": "1"
      },
      "done": true
      "response": {
        "@type": "type.googleapis.com/google.cloud.retail.v2alpha.ImportCompletionDataResponse",
      }
    }

自動完成資料格式

JSON 檔案應與以下範例類似。換行是為了方便閱讀,建議您在同一行提供完整建議。每項建議應單獨一行。

建議的最低必填欄位:

{
  "suggestion": "ABC",
  "globalScore": "0.5"
}

或:

{
  "suggestion": "ABC",
  "frequency": "100"
}

匯入自動完成資料所需時間

從 BigQuery 匯入資料通常需要幾分鐘到一小時。

資料集匯入完成後,作業物件中的 done 欄位會標示為 true。之後,資料可能還需要 1 到 2 天的時間才能完成索引,並用於正式環境服務。

確保自動完成資料集符合現況

如果您打算使用自己上傳的資料集,建議定期更新上傳的資料集。

批次更新

您可以使用匯入方法,批次更新自動完成功能。方法與初始匯入作業相同,請按照「匯入自動完成資料」一文中的步驟操作。這會取代整個匯入的資料集。

監控匯入健康狀態

請務必隨時更新自己的資料集,這樣使用時才能獲得優質的建議結果。您應監控匯入錯誤率,並視需要採取行動。

Vertex AI Search 電子商務套件自動完成結構定義

從 BigQuery 匯入自動完成資料集時,請使用下方的 Vertex AI Search for commerce 結構定義建立格式正確的 BigQuery 資料表,並載入自動完成資料。

建議的結構定義

這個資料集可用於提供您自己的自動完成建議片語,並附上您自己的分數。

拒絕清單的結構定義

這個資料集會做為拒絕清單,禁止系統建議特定片語。

許可清單的結構定義

這個資料集可用於略過許可清單中所有片語的後續處理程序 (例如拼字修正和零結果篩選)。