Generar incrustaciones de texto con la función ML.GENERATE_EMBEDDING
En este documento se explica cómo crear un modelo remoto de BigQuery ML que haga referencia a un modelo de inserciones. Después, puedes usar ese modelo con la función ML.GENERATE_EMBEDDING
para crear representaciones de texto mediante datos de una tabla estándar de BigQuery.
Se admiten los siguientes tipos de modelos remotos:
- Modelos remotos en comparación con modelos de inserción de Vertex AI.
- Modelos remotos sobre modelos abiertos compatibles (Vista previa).
Roles obligatorios
Para crear un modelo remoto y usar la función ML.GENERATE_EMBEDDING
, necesitas los siguientes roles de Gestión de Identidades y Accesos (IAM):
- Crear y usar conjuntos de datos, tablas y modelos de BigQuery:
Editor de datos de BigQuery (
roles/bigquery.dataEditor
) en tu proyecto. Crear, delegar y usar conexiones de BigQuery: Administrador de conexiones de BigQuery (
roles/bigquery.connectionsAdmin
) en tu proyecto.Si no tiene configurada una conexión predeterminada, puede crear una y definirla al ejecutar la instrucción
CREATE MODEL
. Para ello, debes tener el rol Administrador de BigQuery (roles/bigquery.admin
) en tu proyecto. Para obtener más información, consulta Configurar la conexión predeterminada.Concede permisos a la cuenta de servicio de la conexión: administrador de gestión de identidades y accesos del proyecto (
roles/resourcemanager.projectIamAdmin
) en el proyecto que contiene el endpoint de Vertex AI. Este es el proyecto actual de los modelos remotos que creas especificando el nombre del modelo como endpoint. Es el proyecto identificado en la URL de los modelos remotos que creas especificando una URL como endpoint.Crear tareas de BigQuery: Usuario de tareas de BigQuery (
roles/bigquery.jobUser
) en tu proyecto.
Estos roles predefinidos contienen los permisos necesarios para realizar las tareas descritas en este documento. Para ver los permisos exactos que se necesitan, despliega la sección Permisos necesarios:
Permisos obligatorios
- Crea un conjunto de datos:
bigquery.datasets.create
- Crear, delegar y usar una conexión:
bigquery.connections.*
- Define los permisos de la cuenta de servicio:
resourcemanager.projects.getIamPolicy
yresourcemanager.projects.setIamPolicy
- Crea un modelo y ejecuta la inferencia:
bigquery.jobs.create
bigquery.models.create
bigquery.models.getData
bigquery.models.updateData
bigquery.models.updateMetadata
- Consultar datos de tabla:
bigquery.tables.getData
También puedes obtener estos permisos con roles personalizados u otros roles predefinidos.
Antes de empezar
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator
(
roles/resourcemanager.projectCreator
), which contains theresourcemanager.projects.create
permission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
-
Enable the BigQuery, BigQuery Connection, and Vertex AI APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin
), which contains theserviceusage.services.enable
permission. Learn how to grant roles.
Crear conjunto de datos
Crea un conjunto de datos de BigQuery para que contenga tus recursos:
Consola
En la Google Cloud consola, ve a la página BigQuery.
En el panel Explorador, haz clic en el nombre de tu proyecto.
Haz clic en
Ver acciones > Crear conjunto de datos.En la página Crear conjunto de datos, haz lo siguiente:
En ID del conjunto de datos, escribe un nombre para el conjunto de datos.
En Tipo de ubicación, seleccione una ubicación para el conjunto de datos.
Haz clic en Crear conjunto de datos.
bq
Para crear un conjunto de datos, usa el comando
bq mk
con la marca--location
:bq --location=LOCATION mk -d DATASET_ID
Haz los cambios siguientes:
LOCATION
: la ubicación del conjunto de datos.DATASET_ID
es el ID del conjunto de datos que vas a crear.
Confirma que se ha creado el conjunto de datos:
bq ls
Crear una conexión
Puedes saltarte este paso si tienes una conexión predeterminada configurada o si tienes el rol Administrador de BigQuery.
Crea una conexión de recursos de Cloud para que la use el modelo remoto y obtén la cuenta de servicio de la conexión. Crea la conexión en la misma ubicación que el conjunto de datos que has creado en el paso anterior.
Selecciona una de las opciones siguientes:
Consola
Ve a la página BigQuery.
En el panel Explorador, haga clic en
Añadir datos:Se abrirá el cuadro de diálogo Añadir datos.
En el panel Filtrar por, en la sección Tipo de fuente de datos, selecciona Aplicaciones empresariales.
También puede introducir
Vertex AI
en el campo Buscar fuentes de datos.En la sección Fuentes de datos destacadas, haga clic en Vertex AI.
Haz clic en la tarjeta de solución Modelos de Vertex AI: federación de BigQuery.
En la lista Tipo de conexión, selecciona Modelos remotos, funciones remotas y BigLake (recurso de Cloud) de Vertex AI.
En el campo ID de conexión, introduce un nombre para la conexión.
Haga clic en Crear conexión.
Haz clic en Ir a la conexión.
En el panel Información de conexión, copia el ID de la cuenta de servicio para usarlo en un paso posterior.
bq
En un entorno de línea de comandos, crea una conexión:
bq mk --connection --location=REGION --project_id=PROJECT_ID \ --connection_type=CLOUD_RESOURCE CONNECTION_ID
El parámetro
--project_id
anula el proyecto predeterminado.Haz los cambios siguientes:
REGION
: tu región de conexiónPROJECT_ID
: tu ID de proyecto Google CloudCONNECTION_ID
: un ID para tu conexión
Cuando creas un recurso de conexión, BigQuery crea una cuenta de servicio del sistema única y la asocia a la conexión.
Solución de problemas: si aparece el siguiente error de conexión, actualiza el SDK de Google Cloud:
Flags parsing error: flag --connection_type=CLOUD_RESOURCE: value should be one of...
Obtén y copia el ID de la cuenta de servicio para usarlo en un paso posterior:
bq show --connection PROJECT_ID.REGION.CONNECTION_ID
El resultado debería ser similar al siguiente:
name properties 1234.REGION.CONNECTION_ID {"serviceAccountId": "connection-1234-9u56h9@gcp-sa-bigquery-condel.iam.gserviceaccount.com"}
Terraform
Usa el recurso google_bigquery_connection
.
Para autenticarte en BigQuery, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configurar la autenticación para bibliotecas de cliente.
En el siguiente ejemplo se crea una conexión de recursos de Cloud llamada my_cloud_resource_connection
en la región US
:
Para aplicar la configuración de Terraform en un proyecto, sigue los pasos que se indican en las siguientes secciones. Google Cloud
Preparar Cloud Shell
- Abre Cloud Shell.
-
Define el Google Cloud proyecto Google Cloud predeterminado en el que quieras aplicar tus configuraciones de Terraform.
Solo tiene que ejecutar este comando una vez por proyecto y puede hacerlo en cualquier directorio.
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
Las variables de entorno se anulan si defines valores explícitos en el archivo de configuración de Terraform.
Preparar el directorio
Cada archivo de configuración de Terraform debe tener su propio directorio (también llamado módulo raíz).
-
En Cloud Shell, crea un directorio y un archivo nuevo en ese directorio. El nombre del archivo debe tener la extensión
.tf
. Por ejemplo,main.tf
. En este tutorial, nos referiremos al archivo comomain.tf
.mkdir DIRECTORY && cd DIRECTORY && touch main.tf
-
Si estás siguiendo un tutorial, puedes copiar el código de ejemplo de cada sección o paso.
Copia el código de ejemplo en el archivo
main.tf
que acabas de crear.También puedes copiar el código de GitHub. Se recomienda cuando el fragmento de Terraform forma parte de una solución integral.
- Revisa y modifica los parámetros de ejemplo para aplicarlos a tu entorno.
- Guarda los cambios.
-
Inicializa Terraform. Solo tienes que hacerlo una vez por directorio.
terraform init
Si quieres usar la versión más reciente del proveedor de Google, incluye la opción
-upgrade
:terraform init -upgrade
Aplica los cambios
-
Revisa la configuración y comprueba que los recursos que va a crear o actualizar Terraform se ajustan a tus expectativas:
terraform plan
Haga las correcciones necesarias en la configuración.
-
Aplica la configuración de Terraform ejecutando el siguiente comando e introduciendo
yes
en la petición:terraform apply
Espera hasta que Terraform muestre el mensaje "Apply complete!".
- Abre tu Google Cloud proyecto para ver los resultados. En la Google Cloud consola, ve a tus recursos en la interfaz de usuario para asegurarte de que Terraform los ha creado o actualizado.
Dar acceso a la cuenta de servicio
Asigna el rol Usuario de Vertex AI a la cuenta de servicio de la conexión.
Si tiene previsto especificar el endpoint como una URL al crear el modelo remoto,
por ejemplo,
endpoint = 'https://us-central1-aiplatform.googleapis.com/v1/projects/myproject/locations/us-central1/publishers/google/models/text-embedding-005'
,
asigne este rol en el mismo proyecto que especifique en la URL.
Si tienes previsto especificar el endpoint usando el nombre del modelo al crear el modelo remoto (por ejemplo, endpoint = 'text-embedding-005'
), otorga este rol en el mismo proyecto en el que tengas previsto crear el modelo remoto.
Si se asigna el rol en otro proyecto, se produce el error
bqcx-1234567890-wxyz@gcp-sa-bigquery-condel.iam.gserviceaccount.com does not have the permission to access resource
.
Para conceder el rol, sigue estos pasos:
Consola
Ve a la página IAM y administración.
Haz clic en
Conceder acceso.Se abrirá el cuadro de diálogo Añadir principales.
En el campo Nuevos principales, introduce el ID de la cuenta de servicio que has copiado anteriormente.
En el campo Selecciona un rol, elige Vertex AI y, a continuación, Usuario de Vertex AI.
Haz clic en Guardar.
gcloud
Usa el comando gcloud projects add-iam-policy-binding
:
gcloud projects add-iam-policy-binding 'PROJECT_NUMBER' --member='serviceAccount:MEMBER' --role='roles/aiplatform.user' --condition=None
Haz los cambios siguientes:
PROJECT_NUMBER
: tu número de proyectoMEMBER
: el ID de la cuenta de servicio que has copiado antes
Desplegar un modelo abierto
Si quieres usar un modelo abierto compatible, primero debes desplegarlo en Vertex AI. Para obtener más información sobre cómo hacerlo, consulta Implementar modelos abiertos.
Crear un modelo
En la Google Cloud consola, ve a la página BigQuery.
En el editor de SQL, crea un modelo remoto:
CREATE OR REPLACE MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME` REMOTE WITH CONNECTION {DEFAULT | `PROJECT_ID.REGION.CONNECTION_ID`} OPTIONS (ENDPOINT = 'ENDPOINT');
Haz los cambios siguientes:
PROJECT_ID
: tu ID de proyectoDATASET_ID
: ID del conjunto de datos que contendrá el modeloMODEL_NAME
: el nombre del modeloREGION
: la región que usa la conexión.CONNECTION_ID
: el ID de tu conexión de BigQueryCuando consultas los detalles de la conexión en la consola de Google Cloud , este es el valor de la última sección del ID de conexión completo que se muestra en ID de conexión, por ejemplo,
projects/myproject/locations/connection_location/connections/myconnection
ENDPOINT
: el nombre de un modelo de inserción que se va a usar. Para obtener más información sobre las versiones y los alias de los modelos de Vertex AI, consultaENDPOINT
. Para obtener más información sobre los modelos abiertos, consulte los modelos abiertos admitidos.El modelo de Vertex AI que especifiques debe estar disponible en la ubicación en la que crees el modelo remoto. Para obtener más información, consulta Ubicaciones.
Generar embeddings de texto
Genera incrustaciones de texto con la función ML.GENERATE_EMBEDDING
usando datos de texto de una columna de una tabla o de una consulta.
Normalmente, se usa un modelo de inserciones de texto en los casos prácticos en los que solo se utiliza texto, y un modelo de inserciones multimodal en los casos prácticos de búsqueda entre modalidades, en los que las inserciones de texto y de contenido visual se generan en el mismo espacio semántico.
Texto de Vertex AI
Genera inserciones de texto mediante un modelo remoto a través de un modelo de inserciones de texto de Vertex AI:
SELECT * FROM ML.GENERATE_EMBEDDING( MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME`, {TABLE PROJECT_ID.DATASET_ID.TABLE_NAME | (CONTENT_QUERY)}, STRUCT(FLATTEN_JSON AS flatten_json_output, TASK_TYPE AS task_type, OUTPUT_DIMENSIONALITY AS output_dimensionality) );
Haz los cambios siguientes:
PROJECT_ID
: tu ID de proyecto.DATASET_ID
: el ID del conjunto de datos que contiene el modelo.MODEL_NAME
: el nombre del modelo remoto sobre un modelo de inserción.TABLE_NAME
: el nombre de la tabla que contiene el texto que se va a insertar. Esta tabla debe tener una columna llamadacontent
. También puedes usar un alias para usar una columna con otro nombre.CONTENT_QUERY
: una consulta cuyo resultado contiene una columnaSTRING
llamadacontent
.FLATTEN_JSON
: un valorBOOL
que indica si se debe analizar la inserción en una columna independiente. El valor predeterminado esTRUE
.TASK_TYPE
: unSTRING
literal que especifica la aplicación de destino para ayudar al modelo a generar inserciones de mejor calidad.TASK_TYPE
acepta los siguientes valores:RETRIEVAL_QUERY
: especifica que el texto proporcionado es una consulta en un ajuste de búsqueda o recuperación.RETRIEVAL_DOCUMENT
: especifica que el texto proporcionado es un documento en un contexto de búsqueda o recuperación.Cuando se usa este tipo de tarea, es útil incluir el título del documento en la consulta para mejorar la calidad de la inserción. El título del documento debe estar en una columna con el nombre
title
o con el aliastitle
. Por ejemplo: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) );Si se especifica la columna de título en la consulta de entrada, se rellena el campo
title
del cuerpo de la solicitud enviada al modelo. Si especifica un valor detitle
al usar cualquier otro tipo de tarea, esa entrada se ignora y no tiene ningún efecto en los resultados de la inserción.SEMANTIC_SIMILARITY
: especifica que el texto proporcionado se usará para la similitud textual semántica (STS).CLASSIFICATION
: especifica que las inserciones se usarán para la clasificación.CLUSTERING
: especifica que las inserciones se usarán para la creación de clústeres.QUESTION_ANSWERING
: especifica que las inserciones se usarán para responder preguntas.FACT_VERIFICATION
: especifica que las inserciones se usarán para verificar hechos.CODE_RETRIEVAL_QUERY
: especifica que las inserciones se usarán para recuperar código.
OUTPUT_DIMENSIONALITY
: valorINT64
que especifica el número de dimensiones que se deben usar al generar inserciones. Por ejemplo, si especifica256 AS output_dimensionality
, la columna de salidaml_generate_embedding_result
contendrá 256 inserciones por cada valor de entrada.En el caso de los modelos remotos de más de
gemini-embedding-001
modelos, el valor deOUTPUT_DIMENSIONALITY
debe estar en el intervalo[1, 3072]
. El valor predeterminado es3072
. En los modelos remotos detext-embedding
otext-multilingual-embedding
, el valorOUTPUT_DIMENSIONALITY
debe estar en el intervalo[1, 768]
. El valor predeterminado es768
.Si usas un modelo remoto a través de un modelo
text-embedding
, la versión del modelotext-embedding
debe sertext-embedding-004
o una posterior. Si usas un modelo remoto con un modelotext-multilingual-embedding
, la versión del modelotext-multilingual-embedding
debe sertext-multilingual-embedding-002
o posterior.
Ejemplo: insertar texto en una tabla
En el siguiente ejemplo se muestra una solicitud para insertar la columna content
de la tabla text_data
:
SELECT * FROM ML.GENERATE_EMBEDDING( MODEL `mydataset.embedding_model`, TABLE mydataset.text_data, STRUCT(TRUE AS flatten_json_output, 'CLASSIFICATION' AS task_type) );
Texto abierto
Genera incrustaciones de texto usando un modelo remoto en un modelo de incrustaciones abierto:
SELECT * FROM ML.GENERATE_EMBEDDING( MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME`, {TABLE PROJECT_ID.DATASET_ID.TABLE_NAME | (CONTENT_QUERY)}, STRUCT(FLATTEN_JSON AS flatten_json_output) );
Haz los cambios siguientes:
PROJECT_ID
: tu ID de proyecto.DATASET_ID
: el ID del conjunto de datos que contiene el modelo.MODEL_NAME
: el nombre del modelo remoto sobre un modelo de inserción.TABLE_NAME
: el nombre de la tabla que contiene el texto que se va a insertar. Esta tabla debe tener una columna llamadacontent
. También puedes usar un alias para usar una columna con otro nombre.CONTENT_QUERY
: una consulta cuyo resultado contiene una columnaSTRING
llamadacontent
.FLATTEN_JSON
: un valorBOOL
que indica si se debe analizar la inserción en una columna independiente. El valor predeterminado esTRUE
.
Vertex AI multimodal
Genera representaciones de texto mediante un modelo remoto a través de un modelo de representación multimodal de Vertex AI:
SELECT * FROM ML.GENERATE_EMBEDDING( MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME`, {TABLE PROJECT_ID.DATASET_ID.TABLE_NAME | (CONTENT_QUERY)}, STRUCT(FLATTEN_JSON AS flatten_json_output, OUTPUT_DIMENSIONALITY AS output_dimensionality) );
Haz los cambios siguientes:
PROJECT_ID
: tu ID de proyecto.DATASET_ID
: el ID del conjunto de datos que contiene el modelo.MODEL_NAME
: el nombre del modelo remoto en un modelomultimodalembedding@001
.TABLE_NAME
: el nombre de la tabla que contiene el texto que se va a insertar. Esta tabla debe tener una columna llamadacontent
. También puedes usar un alias para usar una columna con otro nombre.CONTENT_QUERY
: una consulta cuyo resultado contiene una columnaSTRING
llamadacontent
.FLATTEN_JSON
: unBOOL
que indica si se debe analizar la inserción en una columna independiente. El valor predeterminado esTRUE
.OUTPUT_DIMENSIONALITY
: valorINT64
que especifica el número de dimensiones que se deben usar al generar inserciones. Los valores válidos son128
,256
,512
y1408
. El valor predeterminado es1408
. Por ejemplo, si especifica256 AS output_dimensionality
, la columna de salidaml_generate_embedding_result
contiene 256 inserciones por cada valor de entrada.
Ejemplo: usar las inserciones para clasificar la similitud semántica
En el siguiente ejemplo se inserta una colección de reseñas de películas y se ordenan por distancia de coseno con respecto a la reseña "Esta película era normal" mediante la función VECTOR_SEARCH
.
Cuanto menor sea la distancia, mayor será la similitud semántica.
Para obtener más información sobre la búsqueda vectorial y el índice vectorial, consulta el artículo Introducción a la búsqueda vectorial.
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;
El resultado es el siguiente:
+------------------------------------------+----------------------------+ | 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 | +------------------------------------------+----------------------------+
Siguientes pasos
- Consulta cómo usar las inserciones de texto e imagen para realizar una búsqueda semántica de texto a imagen.
- Consulta cómo usar las incrustaciones de texto para la búsqueda semántica y la generación aumentada de recuperación (RAG).