使用 ML.GENERATE_EMBEDDING 函式生成文字嵌入

本文說明如何建立參照 Vertex AI 嵌入模型的 BigQuery ML 遠端模型。接著，您可以使用 ML.GENERATE_EMBEDDING 函式，透過 BigQuery標準資料表中的資料建立文字嵌入。

必要的角色

如要建立遠端模型並使用 ML.GENERATE_EMBEDDING 函式，您需要下列 Identity and Access Management (IAM) 角色：

  • 建立及使用 BigQuery 資料集、資料表和模型：專案中的 BigQuery 資料編輯者 (roles/bigquery.dataEditor)。

  • 建立、委派及使用 BigQuery 連線： 專案的 BigQuery 連線管理員 (roles/bigquery.connectionsAdmin)。

    如果沒有設定預設連線，您可以在執行 CREATE MODEL 陳述式時建立並設定連線。如要執行這項操作，您必須具備專案的 BigQuery 管理員角色 (roles/bigquery.admin)。詳情請參閱「設定預設連線」。

  • 將權限授予連線的服務帳戶：在包含 Vertex AI 端點的專案中，授予專案 IAM 管理員 (roles/resourcemanager.projectIamAdmin) 權限。這是您透過將模型名稱指定為端點所建立遠端模型的目前專案。這是您透過指定網址做為端點所建立遠端模型的網址中，所識別的專案。

  • 建立 BigQuery 工作：專案中的 BigQuery 工作使用者 (roles/bigquery.jobUser)。

這些預先定義的角色具備執行本文中工作所需的權限。如要查看確切的必要權限，請展開「必要權限」部分：

所需權限

  • 建立資料集：bigquery.datasets.create
  • 建立、委派及使用連線： bigquery.connections.*
  • 設定服務帳戶權限： resourcemanager.projects.getIamPolicy 和 resourcemanager.projects.setIamPolicy
  • 建立模型並執行推論：
    • bigquery.jobs.create
    • bigquery.models.create
    • bigquery.models.getData
    • bigquery.models.updateData
    • bigquery.models.updateMetadata
  • 查詢資料表資料：bigquery.tables.getData

您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

事前準備

  1. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  2. Make sure that billing is enabled for your Google Cloud project.

  3. Enable the BigQuery, BigQuery Connection, and Vertex AI APIs.

    Enable the APIs

建立資料集

建立 BigQuery 資料集來存放資源：

控制台

  1. 前往 Google Cloud 控制台的「BigQuery」頁面。

    前往 BigQuery 頁面

  2. 在「Explorer」窗格中，按一下專案名稱。

  3. 依序點按 「View actions」(查看動作) >「Create dataset」(建立資料集)。

  4. 在「建立資料集」頁面中，執行下列操作：

    • 在「Dataset ID」(資料集 ID) 部分，輸入資料集的名稱。

    • 在「位置類型」部分，選取資料集的位置。

    • 點選「建立資料集」。

bq

  1. 如要建立新的資料集，請使用 bq mk 指令搭配 --location 旗標：

    bq --location=LOCATION mk -d DATASET_ID

    更改下列內容：

    • LOCATION：資料集的位置。
    • DATASET_ID 是您要建立的資料集 ID。

  2. 確認資料集已建立完成：

    bq ls

建立連線

如果已設定預設連線，或您具備 BigQuery 管理員角色，則可略過這個步驟。

建立供遠端模型使用的Cloud 資源連線，並取得連線的服務帳戶。在與上一步建立的資料集相同的位置中建立連線。

選取下列選項之一：

主控台

  1. 前往「BigQuery」頁面

    前往 BigQuery

  2. 在「Explorer」窗格中，按一下 「新增資料」：

    「新增資料」UI 元素。

    「新增資料」對話方塊隨即開啟。

  3. 在「依條件篩選」窗格的「資料來源類型」部分，選取「商務應用程式」。

    或者，您也可以在「Search for data sources」(搜尋資料來源) 欄位中輸入 Vertex AI。

  4. 在「精選資料來源」部分，按一下「Vertex AI」。

  5. 按一下「Vertex AI Models: BigQuery Federation」解決方案資訊卡。

  6. 在「連線類型」清單中，選取「Vertex AI 遠端模型、遠端函式和 BigLake (Cloud 資源)」。

  7. 在「連線 ID」欄位中，輸入連線名稱。

  8. 點選「建立連線」。

  9. 按一下「前往連線」。

  10. 在「連線資訊」窗格中，複製服務帳戶 ID，以供後續步驟使用。

bq

  1. 在指令列環境中建立連線：

    bq mk --connection --location=REGION --project_id=PROJECT_ID \
    --connection_type=CLOUD_RESOURCE CONNECTION_ID

    --project_id 參數會覆寫預設專案。

    更改下列內容：

    • REGION：您的連線區域
    • PROJECT_ID：您的 Google Cloud 專案 ID
    • CONNECTION_ID：連線的 ID

    建立連線資源時，BigQuery 會建立專屬的系統服務帳戶，並將其與連線建立關聯。

    疑難排解：如果收到下列連線錯誤訊息，請更新 Google Cloud SDK：

    Flags parsing error: flag --connection_type=CLOUD_RESOURCE: value should be one of...

  2. 擷取並複製服務帳戶 ID，以供後續步驟使用：

    bq show --connection PROJECT_ID.REGION.CONNECTION_ID

    輸出結果會與下列內容相似：

    name                          properties
1234.REGION.CONNECTION_ID     {"serviceAccountId": "connection-1234-9u56h9@gcp-sa-bigquery-condel.iam.gserviceaccount.com"}

Terraform

使用 google_bigquery_connection 資源。

如要向 BigQuery 進行驗證，請設定應用程式預設憑證。詳情請參閱「設定用戶端程式庫的驗證機制」。

下列範例會在 US 地區中建立名為 my_cloud_resource_connection 的 Cloud 資源連線：


# This queries the provider for project information.
data "google_project" "default" {}

# This creates a cloud resource connection in the US region named my_cloud_resource_connection.
# Note: The cloud resource nested object has only one output field - serviceAccountId.
resource "google_bigquery_connection" "default" {
  connection_id = "my_cloud_resource_connection"
  project       = data.google_project.default.project_id
  location      = "US"
  cloud_resource {}
}

如要在 Google Cloud 專案中套用 Terraform 設定，請完成下列各節的步驟。

準備 Cloud Shell

  1. 啟動 Cloud Shell。

  2. 設定要套用 Terraform 設定的預設 Google Cloud 專案。

    每項專案只需要執行一次這個指令，且可以在任何目錄中執行。

    export GOOGLE_CLOUD_PROJECT=PROJECT_ID

    如果您在 Terraform 設定檔中設定明確值，環境變數就會遭到覆寫。

準備目錄

每個 Terraform 設定檔都必須有自己的目錄 (也稱為根模組)。

  1. 在 Cloud Shell 中建立目錄，並在該目錄中建立新檔案。檔案名稱的副檔名必須是 .tf，例如 main.tf。在本教學課程中，這個檔案稱為 main.tf。
    mkdir DIRECTORY && cd DIRECTORY && touch main.tf

  2. 如果您正在學習教學課程，可以複製每個章節或步驟中的範例程式碼。

    將範例程式碼複製到新建立的 main.tf。

    視需要從 GitHub 複製程式碼。如果 Terraform 程式碼片段是端對端解決方案的一部分，建議您使用這個方法。

  3. 查看並修改範例參數，套用至您的環境。
  4. 儲存變更。
  5. 初始化 Terraform。每個目錄只需執行一次這項操作。 
    terraform init

    如要使用最新版 Google 供應商，請加入 -upgrade 選項： 

    terraform init -upgrade

套用變更

  1. 檢查設定，確認 Terraform 即將建立或更新的資源符合您的預期：
    terraform plan

    視需要修正設定。

  2. 執行下列指令，並在提示中輸入 yes，即可套用 Terraform 設定： 
    terraform apply

    等待 Terraform 顯示「Apply complete!」訊息。

  3. 開啟 Google Cloud 專案即可查看結果。在 Google Cloud 控制台中，前往 UI 中的資源，確認 Terraform 已建立或更新這些資源。

授予服務帳戶存取權

為連線的服務帳戶授予 Vertex AI 使用者角色。

如果您打算在建立遠端模型時將端點指定為網址 (例如 endpoint = 'https://us-central1-aiplatform.googleapis.com/v1/projects/myproject/locations/us-central1/publishers/google/models/text-embedding-005')，請在網址指定的專案中授予這個角色。

如果您打算在建立遠端模型時使用模型名稱指定端點 (例如 endpoint = 'text-embedding-005')，請在您要建立遠端模型的專案中授予這個角色。

在其他專案中授予角色會導致錯誤 bqcx-1234567890-wxyz@gcp-sa-bigquery-condel.iam.gserviceaccount.com does not have the permission to access resource。

如要授予角色，請按照下列步驟操作：

主控台

  1. 前往「IAM & Admin」(IAM 與管理) 頁面。

    前往「IAM & Admin」(IAM 與管理)

  2. 按一下「授予存取權」。

    「新增主體」對話方塊隨即開啟。

  3. 在「新增主體」欄位，輸入先前複製的服務帳戶 ID。

  4. 在「請選擇角色」欄位中，依序選取「Vertex AI」和「Vertex AI 使用者」。

  5. 按一下 [儲存]。

gcloud

使用 gcloud projects add-iam-policy-binding 指令：

gcloud projects add-iam-policy-binding 'PROJECT_NUMBER' --member='serviceAccount:MEMBER' --role='roles/aiplatform.user' --condition=None

取代下列項目：

  • PROJECT_NUMBER：您的專案編號
  • MEMBER：您先前複製的服務帳戶 ID

建立模型

  1. 前往 Google Cloud 控制台的「BigQuery」頁面。

    前往 BigQuery

  2. 使用 SQL 編輯器建立遠端模型：

    CREATE OR REPLACE MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME`
REMOTE WITH CONNECTION {DEFAULT | `PROJECT_ID.REGION.CONNECTION_ID`}
OPTIONS (ENDPOINT = 'ENDPOINT');

    取代下列項目：

    • PROJECT_ID：您的專案 ID
    • DATASET_ID：要包含模型的資料集 ID
    • MODEL_NAME：模型名稱
    • REGION：連線使用的區域。
    • CONNECTION_ID：BigQuery 連線的 ID

      在 Google Cloud 控制台中查看連線詳細資料時，這是顯示在「連線 ID」中的完整連線 ID 最後一部分的值，例如 projects/myproject/locations/connection_location/connections/myconnection

    • ENDPOINT：要使用的嵌入模型名稱。必須是 text-embedding、text-multilingual-embedding 或 multimodalembedding 模型。如要進一步瞭解支援的模型版本和別名，請參閱 ENDPOINT。

      您指定的 Vertex AI 模型必須位於建立遠端模型的位置。詳情請參閱位置。

使用資料表中的資料生成文字嵌入

使用資料表欄中的文字資料，透過 ML.GENERATE_EMBEDDING 函式生成文字嵌入項目。

一般來說，您會想將 text-embedding 或 text-multilingual-embedding 模型用於純文字應用情境，並將 multimodalembedding 模型用於跨模式搜尋應用情境，在這些情境中，文字和視覺內容的嵌入會產生在同一個語意空間。

文字嵌入

透過嵌入模型使用遠端模型生成文字嵌入：

SELECT *
FROM ML.GENERATE_EMBEDDING(
  MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME`,
  TABLE PROJECT_ID.DATASET_ID.TABLE_NAME,
  STRUCT(FLATTEN_JSON AS flatten_json_output,
    TASK_TYPE AS task_type,
    OUTPUT_DIMENSIONALITY AS output_dimensionality)
);

取代下列項目：

  • PROJECT_ID：您的專案 ID。
  • DATASET_ID：包含模型的資料集 ID。
  • MODEL_NAME：嵌入模型上的遠端模型名稱。
  • TABLE_NAME：包含要嵌入文字的表格名稱。這個資料表必須有名為 content 的資料欄，您也可以使用別名來使用名稱不同的資料欄。
  • FLATTEN_JSON：BOOL 值，指出是否要將嵌入內容剖析至個別資料欄。預設值為 TRUE。
  • TASK_TYPE：STRING常值，指定預期的下游應用程式，協助模型產生更高品質的嵌入內容。TASK_TYPE 接受下列值：
    • RETRIEVAL_QUERY：指定給定文字是搜尋或擷取設定中的查詢。
    • RETRIEVAL_DOCUMENT：指定給定文字是搜尋或擷取設定中的文件。

      使用這類工作時，建議在查詢陳述式中加入文件標題，以提升嵌入品質。文件標題必須位於名為 title 或別名為 title 的資料欄中，例如： 

            SELECT *
      FROM
        ML.GENERATE_EMBEDDING(
          MODEL mydataset.embedding_model,
          (SELECT abstract as content, header as title, publication_number
          FROM mydataset.publications),
          STRUCT(TRUE AS flatten_json_output, 'RETRIEVAL_DOCUMENT' as task_type)
      );

      在輸入查詢中指定標題資料欄，即可填入傳送至模型的要求主體中的 title 欄位。如果使用任何其他工作類型時指定 title 值，系統會忽略該輸入內容，且不會對嵌入結果造成影響。

    • SEMANTIC_SIMILARITY：指定給定文字將用於語意文字相似度 (STS)。
    • CLASSIFICATION：指定嵌入內容將用於分類。
    • CLUSTERING：指定要將嵌入用於叢集。
    • QUESTION_ANSWERING：指定嵌入內容將用於問答。
    • FACT_VERIFICATION：指定嵌入內容將用於事實查證。
    • CODE_RETRIEVAL_QUERY：指定嵌入內容將用於程式碼擷取。
  • OUTPUT_DIMENSIONALITY：INT64 值，用於指定產生嵌入時使用的維度數量。舉例來說，如果您指定 256 AS output_dimensionality，則輸出資料欄會為每個輸入值包含 256 個嵌入。ml_generate_embedding_result

    只有在 model 引數中指定的遠端模型使用下列其中一個模型做為端點時，才能使用這個引數：

    • text-embedding-004 以上版本
    • text-multilingual-embedding-002 以上版本

多模態嵌入

透過 multimodalembedding 模型使用遠端模型生成文字嵌入：

SELECT *
FROM ML.GENERATE_EMBEDDING(
  MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME`,
  TABLE PROJECT_ID.DATASET_ID.TABLE_NAME,
  STRUCT(FLATTEN_JSON AS flatten_json_output，
  OUTPUT_DIMENSIONALITY AS output_dimensionality)
);

取代下列項目：

  • PROJECT_ID：您的專案 ID。
  • DATASET_ID：包含模型的資料集 ID。
  • MODEL_NAME：multimodalembedding@001 模型上的遠端模型名稱。
  • TABLE_NAME：包含要嵌入文字的表格名稱。這個資料表必須有名為 content 的資料欄，您也可以使用別名來使用名稱不同的資料欄。
  • FLATTEN_JSON：BOOL，指出是否要將嵌入內容剖析至獨立資料欄。預設值為 TRUE。
  • OUTPUT_DIMENSIONALITY：INT64 值，用於指定產生嵌入時使用的維度數量。有效值為 128、256、512 和 1408。預設值為 1408。舉例來說，如果您指定 256 AS output_dimensionality，則輸出資料欄會為每個輸入值包含 256 個嵌入。ml_generate_embedding_result

使用查詢資料生成文字嵌入

使用查詢提供的文字資料和遠端模型，透過嵌入模型，以 ML.GENERATE_EMBEDDING 函式生成文字嵌入。

一般來說，您會想將 text-embedding 或 text-multilingual-embedding 模型用於純文字應用情境，並將 multimodalembedding 模型用於跨模式搜尋應用情境，在這些情境中，文字和視覺內容的嵌入會產生在同一個語意空間。

文字嵌入

透過嵌入模型使用遠端模型生成文字嵌入：

SELECT *
FROM ML.GENERATE_EMBEDDING(
  MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME`,
  (CONTENT_QUERY),
  STRUCT(FLATTEN_JSON AS flatten_json_output,
    TASK_TYPE AS task_type,
    OUTPUT_DIMENSIONALITY AS output_dimensionality)
  );

取代下列項目：

  • PROJECT_ID：您的專案 ID。
  • DATASET_ID：包含模型的資料集 ID。
  • MODEL_NAME：嵌入模型上的遠端模型名稱。
  • CONTENT_QUERY：查詢，結果包含名為 content 的 STRING 資料欄。
  • FLATTEN_JSON：BOOL 值，指出是否要將嵌入內容剖析至個別資料欄。預設值為 TRUE。
  • TASK_TYPE：STRING常值，指定預期的下游應用程式，協助模型產生品質較佳的嵌入內容。TASK_TYPE 接受下列值：
    • RETRIEVAL_QUERY：指定給定文字是搜尋或擷取設定中的查詢。
    • RETRIEVAL_DOCUMENT：指定給定文字是搜尋或擷取設定中的文件。

      使用這類工作時，建議在查詢陳述式中加入文件標題，以提升嵌入品質。文件標題必須位於名為 title 或別名為 title 的資料欄中，例如： 

              SELECT *
        FROM
          ML.GENERATE_EMBEDDING(
            MODEL mydataset.embedding_model,
            (SELECT abstract as content, header as title, publication_number
            FROM mydataset.publications),
            STRUCT(TRUE AS flatten_json_output, 'RETRIEVAL_DOCUMENT' as task_type)
        );

      在輸入查詢中指定標題資料欄，即可填入傳送至模型的要求主體中的 title 欄位。如果使用任何其他工作類型時指定 title 值，系統會忽略該輸入內容，且不會對嵌入結果造成影響。

    • SEMANTIC_SIMILARITY：指定給定文字將用於語意文字相似度 (STS)。
    • CLASSIFICATION：指定嵌入內容將用於分類。
    • CLUSTERING：指定要將嵌入用於叢集。
    • QUESTION_ANSWERING：指定嵌入內容將用於問答。
    • FACT_VERIFICATION：指定嵌入內容將用於事實查證。
    • CODE_RETRIEVAL_QUERY：指定嵌入內容將用於程式碼擷取。
  • OUTPUT_DIMENSIONALITY：INT64 值，用於指定產生嵌入時要使用的維度數量。舉例來說，如果您指定 256 AS output_dimensionality，則輸出資料欄會為每個輸入值包含 256 個嵌入。ml_generate_embedding_result

    只有在 model 引數中指定的遠端模型使用下列其中一個模型做為端點時，才能使用這個引數：

    • text-embedding-004 以上版本
    • text-multilingual-embedding-002 以上版本

多模態嵌入

透過 multimodalembedding 模型使用遠端模型生成文字嵌入：

SELECT *
FROM ML.GENERATE_EMBEDDING(
  MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME`,
  (CONTENT_QUERY),
  STRUCT(FLATTEN_JSON AS flatten_json_output,
  OUTPUT_DIMENSIONALITY AS output_dimensionality)
);

取代下列項目：

  • PROJECT_ID：您的專案 ID。
  • DATASET_ID：包含模型的資料集 ID。
  • MODEL_NAME：multimodalembedding@001 模型上的遠端模型名稱。
  • CONTENT_QUERY：查詢，結果包含名為 content 的 STRING 資料欄。
  • FLATTEN_JSON：BOOL，指出是否要將嵌入內容剖析至獨立資料欄。預設值為 TRUE。
  • OUTPUT_DIMENSIONALITY：INT64 值，用於指定產生嵌入時使用的維度數量。有效值為 128、256、512 和 1408。預設值為 1408。舉例來說，如果您指定 256 AS output_dimensionality，則輸出資料欄會為每個輸入值包含 256 個嵌入。ml_generate_embedding_result

範例

下列範例說明如何在資料表和查詢中呼叫 ML.GENERATE_EMBEDDING 函式。

在表格中嵌入文字

以下範例顯示要求內嵌 text_data 資料表的 content 欄：

SELECT *
FROM
  ML.GENERATE_EMBEDDING(
    MODEL `mydataset.embedding_model`,
    TABLE mydataset.text_data,
    STRUCT(TRUE AS flatten_json_output, 'CLASSIFICATION' AS task_type)
  );

使用嵌入功能依語意相似度排序

以下範例會嵌入一系列電影評論，並使用 VECTOR_SEARCH 函式，依據與「這部電影很普通」評論的餘弦距離排序。距離越小，表示語意相似度越高。

如要進一步瞭解向量搜尋和向量索引，請參閱「向量搜尋簡介」。

CREATE TEMPORARY TABLE movie_review_embeddings AS (
  SELECT *
  FROM
    ML.GENERATE_EMBEDDING(
      MODEL `bqml_tutorial.embedding_model`,
      (
        SELECT "This movie was fantastic" AS content
        UNION ALL
        SELECT "This was the best movie I've ever seen!!" AS content
        UNION ALL
        SELECT "This movie was just okay..." AS content
        UNION ALL
        SELECT "This movie was terrible." AS content
      ),
      STRUCT(TRUE AS flatten_json_output)
    )
);

WITH average_review_embedding AS (
  SELECT ml_generate_embedding_result
  FROM
    ML.GENERATE_EMBEDDING(
      MODEL `bqml_tutorial.embedding_model`,
      (SELECT "This movie was average" AS content),
      STRUCT(TRUE AS flatten_json_output)
    )
)
SELECT
  base.content AS content,
  distance AS distance_to_average_review
FROM
  VECTOR_SEARCH(
    TABLE movie_review_embeddings,
    "ml_generate_embedding_result",
    (SELECT ml_generate_embedding_result FROM average_review_embedding),
    distance_type=>"COSINE",
    top_k=>-1
  )
ORDER BY distance_to_average_review;

結果如下：

+------------------------------------------+----------------------------+
| content                                  | distance_to_average_review |
+------------------------------------------+----------------------------+
| This movie was just okay...              | 0.062789813467745592       |
| This movie was fantastic                 |  0.18579561313064263       |
| This movie was terrible.                 |  0.35707466240930985       |
| This was the best movie I've ever seen!! |  0.41844932504542975       |
+------------------------------------------+----------------------------+

後續步驟