使用 ML.GENERATE_EMBEDDING 函式生成文字嵌入
本文件說明如何建立參照 Vertex AI 嵌入模型的 BigQuery ML 遠端模型。接著,您可以使用該模型搭配 ML.GENERATE_EMBEDDING
函式,透過 BigQuery 標準資料表中的資料建立文字嵌入。
必要的角色
如要建立連結,您必須具備下列身分與存取權管理 (IAM) 角色的成員資格:
roles/bigquery.connectionAdmin
如要將權限授予連線的服務帳戶,您必須具備下列權限:
resourcemanager.projects.setIamPolicy
如要使用 BigQuery ML 建立模型,您需要具備下列 IAM 權限:
bigquery.jobs.create
bigquery.models.create
bigquery.models.getData
bigquery.models.updateData
bigquery.models.updateMetadata
如要執行推論,您需要具備下列權限:
bigquery.tables.getData
在桌上- 模型的
bigquery.models.getData
bigquery.jobs.create
事前準備
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the BigQuery, BigQuery Connection, and Vertex AI APIs.
建立資料集
建立 BigQuery 資料集來容納資源:
控制台
前往 Google Cloud 控制台的「BigQuery」頁面。
在「Explorer」窗格中,按一下專案名稱。
依序點選
「View actions」(查看動作) >「Create dataset」(建立資料集)。在「Create dataset」頁面上執行下列操作:
在「Dataset ID」(資料集 ID) 部分,輸入資料集名稱。
在「位置類型」中,選取資料集的位置。
點選「建立資料集」。
bq
建立連線
如果您已設定具備適當權限的預設連線,可以略過這個步驟。
為遠端模型建立Cloud 資源連線,並取得連線的服務帳戶。請在與您在上一個步驟中建立的資料集相同的位置建立連線。
選取下列選項之一:
主控台
前往「BigQuery」頁面
在「Explorer」窗格中,按一下
「新增資料」:「Add data」對話方塊隨即開啟。
在「Filter By」窗格中的「Data Source Type」部分,選取「Business Applications」。
或者,您也可以在「Search for data sources」欄位中輸入
Vertex AI
。在「精選資料來源」部分,按一下「Vertex AI」。
按一下「Vertex AI 模型:BigQuery 聯盟」解決方案資訊卡。
在「連線類型」清單中,選取「Vertex AI 遠端模型、遠端函式和 BigLake (Cloud 資源)」。
在「連線 ID」欄位中,輸入連線的名稱。
點選「建立連線」。
按一下「前往連線」。
在「連線資訊」窗格中,複製服務帳戶 ID,以便在後續步驟中使用。
bq
在指令列環境中建立連線:
bq mk --connection --location=REGION --project_id=PROJECT_ID \ --connection_type=CLOUD_RESOURCE CONNECTION_ID
--project_id
參數會覆寫預設專案。更改下列內容:
REGION
:您的連線區域PROJECT_ID
:您的 Google Cloud 專案 IDCONNECTION_ID
:連線 ID
建立連線資源時,BigQuery 會建立專屬的系統服務帳戶,並將該帳戶與連線建立關聯。
疑難排解:如果您收到下列連線錯誤,請更新 Google Cloud SDK:
Flags parsing error: flag --connection_type=CLOUD_RESOURCE: value should be one of...
擷取並複製服務帳戶 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 資源連線:
如要在 Google Cloud 專案中套用 Terraform 設定,請完成下列各節中的步驟。
準備 Cloud Shell
- 啟動 Cloud Shell。
-
設定要套用 Terraform 設定的預設 Google Cloud 專案。
您只需為每個專案執行這個指令一次,而且可以在任何目錄中執行。
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
如果您在 Terraform 設定檔中設定明確的值,系統就會覆寫環境變數。
準備目錄
每個 Terraform 設定檔都必須有自己的目錄 (也稱為根模組)。
-
在 Cloud Shell 中建立目錄,並在該目錄中建立新檔案。檔案名稱必須包含
.tf
副檔名,例如main.tf
。在本教學課程中,檔案稱為main.tf
。mkdir DIRECTORY && cd DIRECTORY && touch main.tf
-
如果您正在參考教學課程,可以複製各個章節或步驟中的程式碼範例。
將範例程式碼複製到新建立的
main.tf
中。您可以視需要從 GitHub 複製程式碼。如果 Terraform 程式碼片段是端對端解決方案的一部分,建議您採用這種做法。
- 查看並修改要套用至環境的範例參數。
- 儲存變更。
-
初始化 Terraform。這項操作只需對每個目錄執行一次。
terraform init
如要使用最新版的 Google 供應器,您可以選擇加入
-upgrade
選項:terraform init -upgrade
套用變更
-
檢查設定,確認 Terraform 要建立或更新的資源符合您的預期:
terraform plan
視需要修正設定。
-
執行下列指令,並在提示中輸入
yes
,即可套用 Terraform 設定:terraform apply
等待 Terraform 顯示「Apply complete!」(套用完成) 訊息。
- 開啟 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-004'
),請在網址中指定的專案中授予這個角色。
如果您打算在建立遠端模型時,使用模型名稱指定端點 (例如 endpoint = 'text-embedding-004'
),請在您打算建立遠端模型的專案中授予這個角色。
在其他專案中授予角色會導致 bqcx-1234567890-xxxx@gcp-sa-bigquery-condel.iam.gserviceaccount.com does not have the permission to access resource
錯誤。
如要授予角色,請按照下列步驟操作:
主控台
前往「IAM & Admin」(IAM 與管理) 頁面。
按一下「授予存取權」
。系統會開啟「Add principals」對話方塊。
在「新增主體」欄位,輸入先前複製的服務帳戶 ID。
在「請選擇角色」欄位中,依序選取「Vertex AI」和「Vertex AI 使用者」。
按一下 [儲存]。
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
建立模型
前往 Google Cloud 控制台的「BigQuery」頁面。
使用 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
:您的專案 IDDATASET_ID
:包含模型的資料集 IDMODEL_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 FROMmydataset.publications
), STRUCT(TRUE AS flatten_json_output, 'RETRIEVAL_DOCUMENT' as task_type) );在輸入查詢中指定標題欄,系統就會在傳送至模型的請求主體中填入
title
欄位。SEMANTIC_SIMILARITY
:指定指定文字將用於語意文字相似度 (STS)。CLASSIFICATION
:指定嵌入值將用於分類。CLUSTERING
:指定要將嵌入值用於叢集。QUESTION_ANSWERING
:指定要將嵌入值用於回答問題。FACT_VERIFICATION
:指定要將嵌入值用於事實驗證。CODE_RETRIEVAL_QUERY
:指定要使用嵌入資料來擷取程式碼。
OUTPUT_DIMENSIONALITY
:INT64
值,可指定產生嵌入資料時要使用的維度數量。舉例來說,如果您指定256 AS output_dimensionality
,ml_generate_embedding_result
輸出資料欄就會針對每個輸入值包含 256 個嵌入值。只有在
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
,ml_generate_embedding_result
輸出資料欄就會針對每個輸入值包含 256 個嵌入值。
使用查詢資料產生文字嵌入
使用查詢和遠端模型提供的文字資料,透過嵌入模型產生文字嵌入資料,並使用 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 FROMmydataset.publications
), STRUCT(TRUE AS flatten_json_output, 'RETRIEVAL_DOCUMENT' as task_type) );在輸入查詢中指定標題欄,系統就會在傳送至模型的請求主體中填入
title
欄位。SEMANTIC_SIMILARITY
:指定指定文字將用於語意文字相似度 (STS)。CLASSIFICATION
:指定嵌入值將用於分類。CLUSTERING
:指定要將嵌入值用於叢集。QUESTION_ANSWERING
:指定要將嵌入值用於回答問題。FACT_VERIFICATION
:指定要將嵌入值用於事實驗證。CODE_RETRIEVAL_QUERY
:指定要使用嵌入資料來擷取程式碼。
OUTPUT_DIMENSIONALITY
:INT64
值,可指定產生嵌入資料時要使用的維度數量。舉例來說,如果您指定256 AS output_dimensionality
,ml_generate_embedding_result
輸出資料欄就會針對每個輸入值包含 256 個嵌入值。只有在
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
,ml_generate_embedding_result
輸出資料欄就會針對每個輸入值包含 256 個嵌入值。
範例
以下範例說明如何在資料表和查詢上呼叫 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 "Movie 1" AS title, "This movie was fantastic" AS content UNION ALL SELECT "Movie 2" AS title, "This was the best movie I've ever seen!!" AS content UNION ALL SELECT "Movie 3" AS title, "This movie was just okay..." AS content UNION ALL SELECT "Movie 4" AS title, "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 | +------------------------------------------+----------------------------+