Gerar embeddings de vetor para dados textuais em massa usando DML particionada

Este documento explica como gerar e preencher embeddings vetoriais em massa para dados textuais (STRING ou JSON) armazenados no Spanner usando SQL e os modelos de embedding de texto da Vertex AI.

Pré-requisitos

Você precisa ter uma tabela no banco de dados do Spanner que contenha dados textuais (STRING ou JSON). Para mais informações sobre como importar dados, consulte a visão geral da importação e exportação do Spanner.

Exemplo de caso de uso:

Suponha que você tenha uma tabela no Spanner com o seguinte esquema. Essa tabela contém milhões de registros.

GoogleSQL 

CREATE TABLE Products (
  product_id INT64 NOT NULL,
  name STRING(MAX),
  description STRING(MAX)
) PRIMARY KEY(product_id);

PostgreSQL 

CREATE TABLE Products (
  product_id INT8 NOT NULL,
  name TEXT,
  description TEXT,
  PRIMARY KEY(product_id)
);

Seu objetivo é gerar embeddings de vetor para a coluna description nesta tabela e encontrar itens semelhantes para recomendar aos clientes e melhorar a experiência de compra deles usando a pesquisa vetorial.

Registrar um modelo de embedding

GoogleSQL

Registre um modelo de incorporação de texto com o endpoint de modelo da Vertex AI no banco de dados do Spanner:

CREATE MODEL MODEL_NAME
INPUT(
  content STRING(MAX)
)
OUTPUT(
  embeddings STRUCT<values ARRAY<FLOAT32>>
)
REMOTE OPTIONS(
    endpoint = '//aiplatform.googleapis.com/projects/PROJECT/locations/LOCATION/publishers/google/models/$MODEL_NAME',
  default_batch_size = 5
)

Substitua:

  • MODEL_NAME: o nome do modelo de embedding de texto da Vertex AI.
  • PROJECT: o projeto que hospeda o endpoint da Vertex AI
  • LOCATION: o local do endpoint da Vertex AI

PostgreSQL

No dialeto PostgreSQL, não é necessário registrar o modelo. Você transmite o nome do endpoint diretamente para a chamada de função spanner.ML_PREDICT_ROW.

Para conferir as práticas recomendadas, considere o seguinte:

  • Para manter o isolamento das cotas, use um endpoint em um projeto diferente para gerar e fazer o backfill de incorporações do que o endpoint de produção. Reserve o endpoint de produção para veicular o tráfego de produção.
  • Verifique se o endpoint do modelo aceita o valor de default_batch_size. É possível substituir o default_batch_size com a dica de consulta @{remote_udf_max_rows_per_rpc=NEW_NUMBER}. Para informações sobre o limite de default_batch_size em cada região, consulte Usar embeddings de texto para um snippet de texto.
  • Defina o endpoint com uma versão específica do modelo (por exemplo, @003) em vez de @latest. Isso acontece porque os vetores de embedding gerados para o mesmo trecho de texto podem variar dependendo da versão do modelo usada. Por isso, evite usar versões diferentes do modelo para gerar embeddings no mesmo conjunto de dados. Além disso, atualizar a versão do modelo na instrução de definição do modelo não atualiza os embeddings já gerados com esse modelo. Uma maneira de gerenciar a versão do modelo para embeddings é criar uma coluna adicional na tabela que armazena a versão do modelo.
  • Os modelos de embedding de texto ajustados personalizados não são compatíveis com as funções ML.PREDICT do GoogleSQL e spanner.ML_PREDICT_ROW do PostgreSQL.

Testar a integração completa do modelo de embeddings

Você pode executar uma consulta para testar se o modelo de embedding foi configurado corretamente e se os embeddings foram recuperados. Por exemplo, execute a seguinte consulta:

GoogleSQL 

SELECT embeddings.values
FROM SAFE.ML.PREDICT(
  MODEL MODEL_NAME,
  (SELECT description AS content FROM products LIMIT 10)
);

Substitua:

  • MODEL_NAME: o nome do modelo de embedding de texto da Vertex AI.

PostgreSQL 

SELECT spanner.ML_PREDICT_ROW(
    'projects/PROJECT/locations/LOCATION/publishers/google/models/$MODEL_NAME',
    JSONB_BUILD_OBJECT('instances', JSONB_BUILD_ARRAY(JSONB_BUILD_OBJECT('content', description))))
FROM Products
LIMIT 10;

Substitua:

  • PROJECT: o projeto que hospeda o endpoint da Vertex AI
  • LOCATION: o local do endpoint da Vertex AI
  • MODEL_NAME: o nome do modelo de embedding de texto da Vertex AI.

Atualize a tabela de origem para incluir outras colunas para armazenar os embeddings

Em seguida, atualize o esquema da tabela de origem para incluir uma coluna adicional do tipo de dados ARRAY<FLOAT32> para armazenar os embeddings gerados:

GoogleSQL 

ALTER TABLE TABLE_NAME
ADD COLUMN EMBEDDING_COLUMN_NAME ARRAY<FLOAT32>;

Substitua:

  • TABLE_NAME: o nome da tabela de origem
  • EMBEDDING_COLUMN_NAME: o nome da coluna em que você quer adicionar os embeddings gerados

PostgreSQL 

ALTER TABLE TABLE_NAME
ADD COLUMN EMBEDDING_COLUMN_NAME real[];

Substitua:

  • TABLE_NAME: o nome da tabela de origem
  • EMBEDDING_COLUMN_NAME: o nome da coluna em que você quer adicionar os embeddings gerados

Por exemplo, usando o exemplo da tabela products, execute:

GoogleSQL 

ALTER TABLE Products
ADD COLUMN desc_embed ARRAY<FLOAT32>;

PostgreSQL 

ALTER TABLE Products
ADD COLUMN desc_embed real[];

Você pode adicionar outra coluna para gerenciar a versão do modelo de incorporação.

GoogleSQL 

ALTER TABLE Products
ADD COLUMN desc_embed_model_version INT64;

PostgreSQL 

ALTER TABLE Products
ADD COLUMN desc_embed_model_version INT8;

Aumentar a cota da Vertex AI

Talvez seja necessário aumentar a cota da API Vertex AI para a região que usa o modelo de embedding de texto. Para solicitar um aumento, consulte Aumentos de cota da Vertex AI.

Para mais informações, consulte Cotas e limites da Vertex AI.

Embeddings de preenchimento

Por fim, execute a seguinte instrução UPDATE usando DML particionada para gerar embeddings da coluna de dados textuais e armazenar os embeddings no banco de dados. É possível armazenar a versão do modelo com os embeddings. Recomendamos que você execute essa consulta durante um período de baixo tráfego no banco de dados.

GoogleSQL 

UPDATE TABLE_NAME
SET
  TABLE_NAME.EMBEDDING_COLUMN_NAME = (
    SELECT embeddings.values
    FROM SAFE.ML.PREDICT(
      MODEL MODEL_NAME,
      (SELECT TABLE_NAME.DATA_COLUMN_NAME AS content)
    ) @{remote_udf_max_rows_per_rpc=MAX_ROWS}
  ),
  TABLE_NAME.EMBEDDING_VERSION_COLUMN = MODEL_VERSION
WHERE FILTER_CONDITION;

Substitua:

  • TABLE_NAME: o nome da tabela com os dados textuais
  • EMBEDDING_COLUMN_NAME: o nome da coluna em que você quer adicionar os embeddings gerados
  • DATA_COLUMN_NAME: o nome da coluna com os dados textuais.
  • MODEL_NAME: o nome do modelo de embedding da Vertex AI.
  • MAX_ROWS: o número máximo de linhas por RPC
  • EMBEDDING_VERSION_COLUMN: a coluna que gerencia a versão do modelo de embedding usado para fazer o backfill dos seus embeddings.
  • MODEL_VERSION: a versão do modelo de embedding de texto.
  • FILTER_CONDITION: uma condição de filtro particionável que você quer aplicar

Usar SAFE.ML.PREDICT retorna NULL para solicitações com falha. Também é possível usar SAFE.ML.PREDICT com um filtro WHERE embedding_column IS NULL para executar a consulta novamente sem calcular os embeddings dos campos que já foram calculados.

PostgreSQL 

UPDATE TABLE_NAME
SET
  EMBEDDING_COLUMN_NAME = spanner.FLOAT32_ARRAY(spanner.ML_PREDICT_ROW(
    'projects/PROJECT/locations/LOCATION/publishers/google/models/$MODEL_NAME',
    JSONB_BUILD_OBJECT('instances', JSONB_BUILD_ARRAY(JSONB_BUILD_OBJECT('content', DATA_COLUMN_NAME)))
  ) /*@ remote_udf_max_rows_per_rpc=MAX_ROWS */ ->'predictions'->0->'embeddings'->'values'),
  EMBEDDING_VERSION_COLUMN = MODEL_VERSION
WHERE FILTER_CONDITION;

Substitua:

  • TABLE_NAME: o nome da tabela com os dados textuais
  • EMBEDDING_COLUMN_NAME: o nome da coluna em que você quer adicionar os embeddings gerados
  • DATA_COLUMN_NAME: o nome da coluna com os dados textuais.
  • PROJECT: o projeto que hospeda o endpoint da Vertex AI
  • LOCATION: o local do endpoint da Vertex AI
  • MODEL_NAME: o nome do modelo de embedding da Vertex AI.
  • MODEL_VERSION: a versão do modelo de incorporação da Vertex AI.
  • MAX_ROWS: o número máximo de linhas por RPC
  • EMBEDDING_VERSION_COLUMN: a coluna que gerencia a versão do modelo de embedding de texto usado para preencher seus embeddings.
  • FILTER_CONDITION: uma condição de filtro particionável que você quer aplicar

Exemplo de consulta de backfill para a tabela products:

GoogleSQL 

UPDATE products
SET
  products.desc_embed = (
    SELECT embeddings.values
    FROM SAFE.ML.PREDICT(
      MODEL embedding_model,
      (SELECT products.description AS content)
    ) @{remote_udf_max_rows_per_rpc=200}
  ),
  products.desc_embed_model_version = 3
WHERE products.desc_embed IS NULL;

PostgreSQL 

UPDATE products
SET
  desc_embed = spanner.FLOAT32_ARRAY(spanner.ML_PREDICT_ROW(
    'projects/PROJECT/locations/LOCATION/publishers/google/models/$MODEL_NAME',
    JSONB_BUILD_OBJECT('instances', JSONB_BUILD_ARRAY(JSONB_BUILD_OBJECT('content', description)))
  ) /*@ remote_udf_max_rows_per_rpc=200 */ ->'predictions'->0->'embeddings'->'values'),
  desc_embed_model_version = 3
WHERE desc_embed IS NULL;

Para conferir as práticas recomendadas, considere o seguinte:

  • O tempo limite padrão do gRPC para a API Spanner é de uma hora. Dependendo da quantidade de incorporações que você está fazendo backfill, talvez seja necessário aumentar esse tempo limite para garantir que a DML particionada UPDATE tenha tempo suficiente para ser concluída. Para mais informações, consulte Configurar tempos limite e novas tentativas personalizados.

Performance e outras considerações

Considere o seguinte para otimizar a performance ao fazer backfill de dados de incorporação.

Número de nós

A DML particionada executa a instrução DML especificada em diferentes partições em paralelo. Em instâncias com um grande número de nós, talvez você observe erros de cota durante a execução da DML particionada. Se as solicitações da API Vertex AI forem limitadas devido aos limites de cota da API Vertex AI, o Spanner vai tentar novamente essas falhas no modo de transação DML particionada no máximo 20 vezes. Se você observar uma alta taxa de erros de cota na Vertex AI, aumente a cota da Vertex AI. Também é possível ajustar o paralelismo usando a dica no nível da instrução @{pdml_max_parallelism=DESIRED_NUMBER} ao usar o GoogleSQL. O exemplo a seguir define o paralelismo como "5":

GoogleSQL 

@{pdml_max_parallelism=5} UPDATE products
SET products.desc_embed =(
  SELECT embeddings.values
  FROM SAFE.ML.PREDICT(MODEL embedding_model, (
        SELECT products.value AS CONTENT
        )
  )
      @{remote_udf_max_rows_per_rpc=200}
),
products.desc_embed_model_version = MODEL_VERSION
WHERE products.desc_embed IS NULL;

Tamanho do texto na coluna de dados

O modelo de embedding da Vertex AI tem limites para o número máximo de tokens em cada entrada de texto. Cada versão do modelo tem um limite de tokens diferente. Cada solicitação da Vertex AI pode ter vários campos de texto de entrada, mas há um limite para o número máximo de tokens em uma única solicitação. Para bancos de dados do GoogleSQL, se você encontrar um erro INVALID_ARGUMENT com a mensagem "A solicitação é muito grande", tente reduzir o tamanho do lote para evitar o erro. Para isso, configure default_batch_size ou use a dica de consulta @{remote_udf_max_outstanding_rpcs} ao registrar o modelo.

Número de solicitações de API enviadas para a Vertex AI

É possível usar a dica de consulta @{remote_udf_max_outstanding_rpcs} para aumentar ou diminuir o número de solicitações enviadas à Vertex AI pelo Spanner. Aumentar esse limite pode aumentar o uso de CPU e memória da instância do Spanner. Para bancos de dados GoogleSQL, usar essa dica de consulta substitui o default_batch_size configurado para seu modelo.

Monitorar o progresso do preenchimento

É possível monitorar o número de solicitações, a latência e os bytes de rede enviados para a Vertex AI do Spanner usando o painel de insights do sistema.

A seguir