Gerar embeddings de texto usando a função AI.GENERATE_EMBEDDING

Neste documento, mostramos como criar um modelo remoto do BigQuery ML que faz referência a um modelo de embedding. Em seguida, use esse modelo com a função AI.GENERATE_EMBEDDING para criar embeddings de texto usando dados de uma tabela padrão do BigQuery.

Os seguintes tipos de modelos remotos são compatíveis:

• Modelos remotos em modelos de embedding da Agent Platform.
• Modelos remotos em modelos abertos compatíveis.

Funções exigidas

Para criar um modelo remoto e usar a função AI.GENERATE_EMBEDDING, você precisa dos seguintes papéis do Identity and Access Management (IAM):

• Criar e usar conjuntos de dados, tabelas e modelos do BigQuery: Editor de dados do BigQuery (roles/bigquery.dataEditor) no projeto.

• Criar, delegar e usar conexões do BigQuery: administrador de conexões do BigQuery (roles/bigquery.connectionsAdmin) no seu projeto.

  Se você não tiver uma conexão padrão configurada, crie e defina uma como parte da execução da instrução CREATE MODEL. Para fazer isso, é preciso ter o papel de administrador do BigQuery (roles/bigquery.admin) no projeto. Para mais informações, consulte Configurar a conexão padrão.

• Conceda permissões à conta de serviço da conexão: administrador do IAM do projeto (roles/resourcemanager.projectIamAdmin) no projeto que contém o endpoint da Gemini Enterprise Agent Platform. Este é o projeto atual para modelos remotos criados especificando o nome do modelo como um endpoint. Esse é o projeto identificado no URL para modelos remotos que você cria especificando um URL como um endpoint.

• Criar jobs do BigQuery: usuário de jobs do BigQuery (roles/bigquery.jobUser) no projeto.

Esses papéis predefinidos contêm as permissões necessárias para executar as tarefas neste documento. Para acessar as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

• Crie um conjunto de dados: bigquery.datasets.create
• Criar, delegar e usar uma conexão: bigquery.connections.*
• Defina as permissões da conta de serviço: resourcemanager.projects.getIamPolicy e resourcemanager.projects.setIamPolicy
• Crie um modelo e execute a inferência:
  • bigquery.jobs.create
  • bigquery.models.create
  • bigquery.models.getData
  • bigquery.models.updateData
  • bigquery.models.updateMetadata
• Consultar dados da tabela: bigquery.tables.getData

Essas permissões também podem ser concedidas com papéis personalizados ou outros papéis predefinidos.

Antes de começar

1. No console do Google Cloud , na página do seletor de projetos, selecione ou crie um projeto do Google Cloud .

   Papéis necessários para selecionar ou criar um projeto

   • Selecionar um projeto: para selecionar um projeto, não é necessário ter um papel do IAM específico. É possível selecionar qualquer projeto em que você tenha um papel.
   • Criar um projeto: para criar um projeto, é preciso ter o papel de Criador de projetos (roles/resourcemanager.projectCreator), que contém a permissão resourcemanager.projects.create. Saiba como conceder papéis.
   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

2. Verifique se o faturamento está ativado para o projeto do Google Cloud .

3. Ative as APIs BigQuery, BigQuery Connection e Agent Platform, se ainda não estiverem ativadas.

   Funções necessárias para ativar APIs

   Para ativar APIs, você precisa da permissão serviceusage.services.enable. Se você criou o projeto, provavelmente já tem essa permissão pelo papel de proprietário (roles/owner). Caso contrário, é possível conseguir essa permissão pelo papel de administrador do Service Usage (roles/serviceusage.serviceUsageAdmin). Saiba como conceder papéis.

   Ativar as APIs

Criar um conjunto de dados

Crie um conjunto de dados do BigQuery para conter seus recursos:

Console

1. No console do Google Cloud , acesse a página BigQuery.

   Acessar o BigQuery

2. No painel à esquerda, clique em Explorer:

   

   Se o painel esquerdo não aparecer, clique em Expandir painel esquerdo para abrir.

3. No painel Explorer, clique no nome do seu projeto.

4. Clique em Conferir ações > Criar conjunto de dados.

5. Na página Criar conjunto de dados, faça o seguinte:

   1. Em ID do conjunto de dados, digite um nome para o conjunto de dados.

   2. Em Tipo de local, selecione Região ou Multirregional.

      • Se você selecionou Região, escolha um local na lista Região.
      • Se você selecionou Multirregional, selecione EUA ou Europa na lista Multirregional.

   3. Clique em Criar conjunto de dados.

bq

1. Para criar um novo conjunto de dados, use o comando bq mk com a flag --location:

   bq --location=LOCATION mk -d DATASET_ID

   Substitua:

   • LOCATION: o local do conjunto de dados.
   • DATASET_ID: o ID do conjunto de dados que você está criando.

2. Confirme se o conjunto de dados foi criado:

   bq ls

Crie uma conexão

Crie uma conexão a recursos do Cloud e tenha acesso à conta de serviço da conexão. Crie a conexão no mesmo local do conjunto de dados criado na etapa anterior.

Pule esta etapa se você tiver uma conexão padrão configurada ou o papel de administrador do BigQuery.

Selecione uma das seguintes opções:

Console

1. Acessar a página do BigQuery.

   Acessar o BigQuery

2. No painel à esquerda, clique em Explorer:

   

   Se o painel esquerdo não aparecer, clique em Expandir painel esquerdo para abrir.

3. No painel Explorer, expanda o nome do projeto e clique em Conexões.

4. Na página Conexões, clique em Criar conexão.

5. Em Tipo de conexão, escolha Modelos remotos da Vertex AI, funções remotas, BigLake e Spanner (recurso do Cloud).

6. No campo ID da conexão, insira um nome para a conexão.

7. Em Tipo de local, selecione um local para a conexão. A conexão precisa estar no mesmo local que os outros recursos, como conjuntos de dados.

8. Clique em Criar conexão.

9. Clique em Ir para conexão.

10. No painel Informações da conexão, copie o ID da conta de serviço para uso em uma etapa posterior.

SQL

Use a instrução CREATE CONNECTION:

1. No console do Google Cloud , acesse a página BigQuery.

   Acessar o BigQuery

2. No editor de consultas, digite a seguinte instrução:

   CREATE CONNECTION [IF NOT EXISTS] `CONNECTION_NAME`
   OPTIONS (
     connection_type = "CLOUD_RESOURCE",
     friendly_name = "FRIENDLY_NAME",
     description = "DESCRIPTION"
     );

   Substitua:

   • CONNECTION_NAME: o nome da conexão no formato PROJECT_ID.LOCATION.CONNECTION_ID, LOCATION.CONNECTION_ID ou CONNECTION_ID. Se o projeto ou o local forem omitidos, eles serão inferidos do projeto e do local em que a instrução é executada.
   • FRIENDLY_NAME (opcional): um nome descritivo para a conexão.
   • DESCRIPTION (opcional): uma descrição da conexão.

3. Clique em Executar.

Para mais informações sobre como executar consultas, acesse Executar uma consulta interativa.

bq

1. Em um ambiente de linha de comando, crie uma conexão:

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

   O parâmetro --project_id substitui o projeto padrão.

   Substitua:

   • REGION: sua região de conexão
   • PROJECT_ID: o ID do projeto do Google Cloud .
   • CONNECTION_ID: um ID para sua conexão

   Quando você cria um recurso de conexão, o BigQuery cria uma conta de serviço do sistema exclusiva e a associa à conexão.

   Solução de problemas: se você receber o seguinte erro de conexão, atualize o SDK Google Cloud:

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

2. Recupere e copie o ID da conta de serviço para uso em uma etapa posterior:

   bq show --connection PROJECT_ID.REGION.CONNECTION_ID

   O resultado será o seguinte:

   name                          properties
   1234.REGION.CONNECTION_ID     {"serviceAccountId": "[e-mail]"}
   

Python

Antes de testar esta amostra, siga as instruções de configuração do Python no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API BigQuery em Python.

Para autenticar no BigQuery, configure o Application Default Credentials. Para mais informações, acesse Configurar a autenticação para bibliotecas de cliente.

import google.api_core.exceptions
from google.cloud import bigquery_connection_v1

client = bigquery_connection_v1.ConnectionServiceClient()


def create_connection(
    project_id: str,
    location: str,
    connection_id: str,
):
    """Creates a BigQuery connection to a Cloud Resource.

    Cloud Resource connection creates a service account which can then be
    granted access to other Google Cloud resources for federated queries.

    Args:
        project_id: The Google Cloud project ID.
        location: The location of the connection (for example, "us-central1").
        connection_id: The ID of the connection to create.
    """

    parent = client.common_location_path(project_id, location)

    connection = bigquery_connection_v1.Connection(
        friendly_name="Example Connection",
        description="A sample connection for a Cloud Resource.",
        cloud_resource=bigquery_connection_v1.CloudResourceProperties(),
    )

    try:
        created_connection = client.create_connection(
            parent=parent, connection_id=connection_id, connection=connection
        )
        print(f"Successfully created connection: {created_connection.name}")
        print(f"Friendly name: {created_connection.friendly_name}")
        print(
            f"Service Account: {created_connection.cloud_resource.service_account_id}"
        )

    except google.api_core.exceptions.AlreadyExists:
        print(f"Connection with ID '{connection_id}' already exists.")
        print("Please use a different connection ID.")
    except Exception as e:
        print(f"An unexpected error occurred while creating the connection: {e}")

Node.js

Antes de testar esta amostra, siga as instruções de configuração do Node.js no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API BigQuery em Node.js.

Para autenticar no BigQuery, configure o Application Default Credentials. Para mais informações, acesse Configurar a autenticação para bibliotecas de cliente.

const {ConnectionServiceClient} =
  require('@google-cloud/bigquery-connection').v1;
const {status} = require('@grpc/grpc-js');

const client = new ConnectionServiceClient();

/**
 * Creates a new BigQuery connection to a Cloud Resource.
 *
 * A Cloud Resource connection creates a service account that can be granted access
 * to other Google Cloud resources.
 *
 * @param {string} projectId The Google Cloud project ID. for example, 'example-project-id'
 * @param {string} location The location of the project to create the connection in. for example, 'us-central1'
 * @param {string} connectionId The ID of the connection to create. for example, 'example-connection-id'
 */
async function createConnection(projectId, location, connectionId) {
  const parent = client.locationPath(projectId, location);

  const connection = {
    friendlyName: 'Example Connection',
    description: 'A sample connection for a Cloud Resource',
    // The service account for this cloudResource will be created by the API.
    // Its ID will be available in the response.
    cloudResource: {},
  };

  const request = {
    parent,
    connectionId,
    connection,
  };

  try {
    const [response] = await client.createConnection(request);

    console.log(`Successfully created connection: ${response.name}`);
    console.log(`Friendly name: ${response.friendlyName}`);

    console.log(`Service Account: ${response.cloudResource.serviceAccountId}`);
  } catch (err) {
    if (err.code === status.ALREADY_EXISTS) {
      console.log(`Connection '${connectionId}' already exists.`);
    } else {
      console.error(`Error creating connection: ${err.message}`);
    }
  }
}

Java

Antes de testar esta amostra, siga as instruções de configuração do Java no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API BigQuery em Java.

Para autenticar no BigQuery, configure o Application Default Credentials. Para mais informações, acesse Configurar a autenticação para bibliotecas de cliente.

import com.google.api.gax.rpc.AlreadyExistsException;
import com.google.api.gax.rpc.ApiException;
import com.google.cloud.bigquery.connection.v1.CloudResourceProperties;
import com.google.cloud.bigquery.connection.v1.Connection;
import com.google.cloud.bigquery.connection.v1.CreateConnectionRequest;
import com.google.cloud.bigquery.connection.v1.LocationName;
import com.google.cloud.bigqueryconnection.v1.ConnectionServiceClient;
import java.io.IOException;

public class CreateConnection {

  /**
   * Creates a BigQuery connection to a Cloud Resource. A Cloud Resource connection provisions a
   * service account that can be granted access to other Google Cloud resources for federated
   * queries.
   *
   * @param projectId The Google Cloud project ID (for example, "example-project-id").
   * @param location The geographic location of the connection (for example, "us-central1").
   * @param connectionId The ID of the connection to create (for example, "example-connection-id").
   */
  public static void createConnection(String projectId, String location, String connectionId) {
    LocationName parent = LocationName.of(projectId, location);

    // CloudResourceProperties provisions a managed Google Cloud service account on creation.
    CloudResourceProperties cloudResourceProperties = CloudResourceProperties.newBuilder().build();
    Connection connection =
        Connection.newBuilder()
            .setFriendlyName("Example Connection")
            .setDescription("Cloud Resource connection for federated queries.")
            .setCloudResource(cloudResourceProperties)
            .build();

    CreateConnectionRequest request =
        CreateConnectionRequest.newBuilder()
            .setParent(parent.toString())
            .setConnectionId(connectionId)
            .setConnection(connection)
            .build();

    try (ConnectionServiceClient client = ConnectionServiceClient.create()) {
      Connection response = client.createConnection(request);

      System.out.printf("Successfully created connection: %s%n", response.getName());
      System.out.printf("Friendly name: %s%n", response.getFriendlyName());
      System.out.printf(
          "Service Account: %s%n", response.getCloudResource().getServiceAccountId());
    } catch (AlreadyExistsException err) {
      System.err.printf(
          "error: connection '%s' already exists in location '%s' for project '%s': %s%n",
          connectionId, location, projectId, err.getMessage());
    } catch (ApiException | IOException err) {
      System.err.printf(
          "error: failed to create connection '%s' in location '%s' for project '%s': %s%n",
          connectionId, location, projectId, err.getMessage());
    }
  }

Terraform

Use o recurso google_bigquery_connection.

Observação: para criar objetos do BigQuery usando o Terraform, é necessário ativar a API Cloud Resource Manager.

Para autenticar no BigQuery, configure o Application Default Credentials. Para mais informações, acesse Configurar a autenticação para bibliotecas de cliente.

O exemplo a seguir cria uma conexão a recursos do Cloud chamada my_cloud_resource_connection na região US:

# 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 {}
}

Para aplicar a configuração do Terraform em um projeto do Google Cloud , conclua as etapas nas seções a seguir.

Preparar o Cloud Shell

1. Inicie o Cloud Shell.

2. Defina o projeto padrão do Google Cloud em que você quer aplicar as configurações do Terraform.

   Você só precisa executar esse comando uma vez por projeto, e ele pode ser executado em qualquer diretório.

   export GOOGLE_CLOUD_PROJECT=PROJECT_ID

   As variáveis de ambiente serão substituídas se você definir valores explícitos no arquivo de configuração do Terraform.

Preparar o diretório

Cada arquivo de configuração do Terraform precisa ter o próprio diretório, também chamado de módulo raiz.

1. No Cloud Shell, crie um diretório e um novo arquivo dentro dele. O nome do arquivo precisa ter a extensão .tf, por exemplo, main.tf. Neste tutorial, o arquivo é chamado de main.tf.

   mkdir DIRECTORY && cd DIRECTORY && touch main.tf

2. Se você estiver seguindo um tutorial, poderá copiar o exemplo de código em cada seção ou etapa.

   Copie o exemplo de código no main.tf recém-criado.

   Se preferir, copie o código do GitHub. Isso é recomendado quando o snippet do Terraform faz parte de uma solução de ponta a ponta.

3. Revise e modifique os parâmetros de amostra para aplicar ao seu ambiente.
4. Salve as alterações.
5. Inicialize o Terraform. Você só precisa fazer isso uma vez por diretório.

   terraform init

   Opcionalmente, para usar a versão mais recente do provedor do Google, inclua a opção -upgrade:

   terraform init -upgrade

Aplique as alterações

1. Revise a configuração e verifique se os recursos que o Terraform vai criar ou atualizar correspondem às suas expectativas:

   terraform plan

   Faça as correções necessárias na configuração.

2. Para aplicar a configuração do Terraform, execute o comando a seguir e digite yes no prompt:

   terraform apply

   Aguarde até que o Terraform exiba a mensagem "Apply complete!".

3. Abra seu projeto do Google Cloud para ver os resultados. No console do Google Cloud , navegue até seus recursos na UI para verificar se foram criados ou atualizados pelo Terraform.

Observação:as amostras do Terraform geralmente presumem que as APIs necessárias estejam ativadas no projeto do Google Cloud .

Conceder um papel à conta de serviço da conexão do modelo remoto

Você precisa conceder à conta de serviço da conexão o papel de usuário da Agent Platform.

Se você planeja especificar o endpoint como um URL ao criar o modelo remoto, por exemplo, endpoint = 'https://us-central1-aiplatform.googleapis.com/v1/projects/myproject/locations/us-central1/publishers/google/models/text-embedding-005', conceda esse papel no mesmo projeto especificado no URL.

Se você planeja especificar o endpoint usando o nome do modelo ao criar o modelo remoto, por exemplo, endpoint = 'text-embedding-005', conceda esse papel no mesmo projeto em que planeja criar o modelo remoto.

Conceder o papel em um projeto diferente resulta no erro [e-mail] does not have the permission to access resource.

Para conceder o papel, siga estas etapas:

Console

1. Acesse a página IAM e administrador.

   Acessar IAM e administrador

2. Clique em CONCEDER ACESSO.

   A caixa de diálogo Adicionar principais é aberta.

3. No campo Novos principais, digite o ID da conta de serviço que você copiou anteriormente.

4. No campo Selecionar um papel, pesquise Usuário da Agent Platform.

5. Clique em Salvar.

gcloud

Use o comando gcloud projects add-iam-policy-binding (em inglês).

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

Substitua:

• PROJECT_NUMBER: o ID do seu projeto
• MEMBER: o ID da conta de serviço que você copiou anteriormente

Escolher um método de implantação de modelo aberto

Se você estiver criando um modelo remoto com base em um modelo aberto compatível, poderá implantar automaticamente o modelo aberto ao mesmo tempo em que cria o modelo remoto especificando o ID do modelo do Model Garden da Agent Platform ou do Hugging Face na instrução CREATE MODEL. Como alternativa, é possível implantar manualmente o modelo aberto primeiro e, em seguida, usá-lo com o modelo remoto especificando o endpoint do modelo na instrução CREATE MODEL. Para mais informações, consulte Implantar modelos abertos.

Criar um modelo remoto do BigQuery ML

Crie um modelo remoto:

Modelos da Agent Platform

1. No console do Google Cloud , acesse a página BigQuery.

   Acessar o BigQuery

2. Usando o editor de SQL, crie um modelo remoto:

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

   Substitua:

   • PROJECT_ID: o ID do projeto.
   • DATASET_ID: o ID do conjunto de dados para conter o modelo. Esse conjunto de dados precisa estar no mesmo local que a conexão que você está usando.
   • MODEL_NAME: o nome do modelo
   • REGION: a região usada pela conexão.
   • CONNECTION_ID: o ID da conexão do BigQuery

     Para conseguir esse valor, acesse os detalhes da conexão no console do Google Cloud e copie o valor na última seção do ID da conexão totalmente qualificado, mostrado em ID da conexão. Por exemplo: projects/myproject/locations/connection_location/connections/myconnection.

   • ENDPOINT: o nome de um modelo de embedding a ser usado. Para mais informações, consulte ENDPOINT.

     O modelo da Agent Platform especificado precisa estar disponível no local em que você está criando o modelo remoto. Veja mais informações em Locais.

Novos modelos abertos

1. No console do Google Cloud , acesse a página BigQuery.

   Acessar o BigQuery

2. Usando o editor de SQL, crie um modelo remoto:

   CREATE OR REPLACE MODEL
   `PROJECT_ID.DATASET_ID.MODEL_NAME`
   REMOTE WITH CONNECTION {DEFAULT | `PROJECT_ID.REGION.CONNECTION_ID`}
   OPTIONS (
     {HUGGING_FACE_MODEL_ID = 'HUGGING_FACE_MODEL_ID' |
        MODEL_GARDEN_MODEL_NAME = 'MODEL_GARDEN_MODEL_NAME'}
     [, HUGGING_FACE_TOKEN = 'HUGGING_FACE_TOKEN' ]
     [, MACHINE_TYPE = 'MACHINE_TYPE' ]
     [, MIN_REPLICA_COUNT = MIN_REPLICA_COUNT ]
     [, MAX_REPLICA_COUNT = MAX_REPLICA_COUNT ]
     [, RESERVATION_AFFINITY_TYPE = {'NO_RESERVATION' | 'ANY_RESERVATION' | 'SPECIFIC_RESERVATION'} ]
     [, RESERVATION_AFFINITY_KEY = 'compute.googleapis.com/reservation-name' ]
     [, RESERVATION_AFFINITY_VALUES = RESERVATION_AFFINITY_VALUES ]
     [, ENDPOINT_IDLE_TTL = ENDPOINT_IDLE_TTL ]
   );

   Substitua:

   • PROJECT_ID: o ID do projeto.
   • DATASET_ID: o ID do conjunto de dados para conter o modelo. Esse conjunto de dados precisa estar no mesmo local que a conexão que você está usando.
   • MODEL_NAME: o nome do modelo
   • REGION: a região usada pela conexão.
   • CONNECTION_ID: o ID da conexão do BigQuery

     Para conseguir esse valor, acesse os detalhes da conexão no console do Google Cloud e copie o valor na última seção do ID da conexão totalmente qualificado, mostrado em ID da conexão. Por exemplo: projects/myproject/locations/connection_location/connections/myconnection.

   • HUGGING_FACE_MODEL_ID: um valor STRING que especifica o ID de um modelo compatível do Hugging Face, no formato provider_name/model_name. Por exemplo, deepseek-ai/DeepSeek-R1. Para encontrar o ID do modelo, clique no nome dele no Hub de modelos do Hugging Face e copie o ID na parte de cima do card do modelo.
   • MODEL_GARDEN_MODEL_NAME: um valor STRING que especifica o ID e a versão de um modelo compatível do Model Garden da Gemini Enterprise Agent Platform, no formato publishers/publisher/models/model_name@model_version. Exemplo: publishers/openai/models/gpt-oss@gpt-oss-120b. Para encontrar o ID do modelo, clique no card do modelo no Model Garden da Agent Platform e copie o ID do campo ID do modelo. Para acessar a versão padrão do modelo, copie-a do campo Versão no card do modelo. Para ver outras versões de modelo que podem ser usadas, clique em Implantar modelo e, em seguida, no campo ID do recurso.
   • HUGGING_FACE_TOKEN: um valor STRING que especifica o token de acesso de usuário do Hugging Face a ser usado. Só é possível especificar um valor para essa opção se você também especificar um valor para a opção HUGGING_FACE_MODEL_ID.

     O token precisa ter pelo menos o papel read, mas tokens com um escopo mais amplo também são aceitáveis. Essa opção é obrigatória quando o modelo identificado pelo valor HUGGING_FACE_MODEL_ID é um modelo restrito ou privado do Hugging Face.

     Alguns modelos restritos exigem que você concorde explicitamente com os Termos de Serviço antes de receber acesso. Para aceitar esses termos, siga estas etapas:

     1. Acesse a página do modelo no site do Hugging Face.
     2. Localize e leia os Termos de Serviço do modelo. Um link para o contrato de serviço geralmente é encontrado no card de modelo.
     3. Aceite os termos conforme solicitado na página.
   • MACHINE_TYPE: um valor STRING que especifica o tipo de máquina a ser usado ao implantar o modelo na Agent Platform. Para informações sobre os tipos de máquina compatíveis, consulte Tipos de máquina. Se você não especificar um valor para a opção MACHINE_TYPE, será usado o tipo de máquina padrão do Model Garden da plataforma de agente para o modelo.
   • MIN_REPLICA_COUNT: um valor INT64 que especifica o número mínimo de réplicas de máquina usadas ao implantar o modelo em um endpoint da plataforma de agentes. O serviço aumenta ou diminui a contagem de réplicas conforme exigido pela carga de inferência no endpoint. O número de réplicas usadas nunca é menor que o valor de MIN_REPLICA_COUNT e nunca maior que o valor de MAX_REPLICA_COUNT. O valor MIN_REPLICA_COUNT precisa estar no intervalo [1, 4096]. O valor padrão é 1.
   • MAX_REPLICA_COUNT: um valor INT64 que especifica o número máximo de réplicas de máquina usadas ao implantar o modelo em um endpoint da plataforma de agentes. O serviço aumenta ou diminui a contagem de réplicas conforme exigido pela carga de inferência no endpoint. O número de réplicas usadas nunca é menor que o valor de MIN_REPLICA_COUNT e nunca maior que o valor de MAX_REPLICA_COUNT. O valor MAX_REPLICA_COUNT precisa estar no intervalo [1, 4096]. O valor padrão é o valor MIN_REPLICA_COUNT.
   • RESERVATION_AFFINITY_TYPE: determina se o modelo implantado usa reservas do Compute Engine para garantir a disponibilidade da máquina virtual (VM) ao exibir previsões e especifica se o modelo usa VMs de todas as reservas disponíveis ou apenas de uma reserva específica. Para mais informações, consulte Afinidade de reserva do Compute Engine.

     Só é possível usar as reservas do Compute Engine que são compartilhadas com a Agent Platform. Para mais informações, consulte Permitir que uma reserva seja consumida.

     Os valores compatíveis são os seguintes:

     • NO_RESERVATION: nenhuma reserva é consumida quando o modelo é implantado em um endpoint da Agent Platform. Especificar NO_RESERVATION tem o mesmo efeito que não especificar uma afinidade de reserva.
     • ANY_RESERVATION: a implantação do modelo da Agent Platform consome máquinas virtuais (VMs) de reservas do Compute Engine que estão no projeto atual ou que são compartilhadas com o projeto e que estão configuradas para consumo automático. Somente as VMs que atendem às seguintes qualificações são usadas:
       • Eles usam o tipo de máquina especificado pelo valor MACHINE_TYPE.
       • Se o conjunto de dados do BigQuery em que você está criando o modelo remoto for uma única região, a reserva precisará estar na mesma região. Se o conjunto de dados estiver na multirregião US, a reserva precisará estar na região us-central1. Se o conjunto de dados estiver na multirregião EU, a reserva precisará estar na região europe-west4.

       Se não houver capacidade suficiente nas reservas disponíveis ou se nenhuma reserva adequada for encontrada, o sistema provisionará VMs do Compute Engine on demand para atender aos requisitos de recursos.

     • SPECIFIC_RESERVATION: a implantação do modelo da Agent Platform consome VMs apenas da reserva especificada no valor RESERVATION_AFFINITY_VALUES. Essa reserva precisa ser configurada para consumo segmentado especificamente. A implantação falhará se a reserva especificada não tiver capacidade suficiente.
   • RESERVATION_AFFINITY_KEY: a string compute.googleapis.com/reservation-name. É necessário especificar essa opção quando o valor de RESERVATION_AFFINITY_TYPE for SPECIFIC_RESERVATION.
   • RESERVATION_AFFINITY_VALUES: um valor ARRAY<STRING> que especifica o nome completo do recurso da reserva do Compute Engine, no seguinte formato:
     
     projects/myproject/zones/reservation_zone/reservations/reservation_name

     Por exemplo, RESERVATION_AFFINITY_values = ['projects/myProject/zones/us-central1-a/reservations/myReservationName'].

     É possível conferir o nome e a zona da reserva na página Reservas do console do Google Cloud . Para mais informações, consulte Ver reservas.

     É necessário especificar essa opção quando o valor de RESERVATION_AFFINITY_TYPE for SPECIFIC_RESERVATION.

   • ENDPOINT_IDLE_TTL: um valor INTERVAL que especifica a duração da inatividade após a qual o modelo aberto é automaticamente removido do endpoint da Agent Platform.

     Para ativar o cancelamento automático da implantação, especifique um valor de literal de intervalo entre 390 minutos (6,5 horas) e 7 dias. Por exemplo, especifique INTERVAL 8 HOUR para que o modelo seja removido após 8 horas de inatividade. O valor padrão é 390 minutos (6,5 horas).

     A inatividade do modelo é definida como o tempo decorrido desde que qualquer uma das seguintes operações foi realizada no modelo:

     • Executar a instrução CREATE MODEL.
     • Executar a instrução ALTER MODEL com o argumento DEPLOY_MODEL definido como TRUE.
     • Enviar uma solicitação de inferência ao endpoint do modelo. Por exemplo, executando a função AI.GENERATE_EMBEDDING ou AI.GENERATE_TEXT.

     Cada uma dessas operações redefine o timer de inatividade para zero. A redefinição é acionada no início do job do BigQuery que executa a operação.

     Depois que a implantação do modelo é cancelada, as solicitações de inferência enviadas a ele retornam um erro. O objeto do modelo do BigQuery permanece inalterado, incluindo os metadados do modelo. Para usar o modelo para inferência novamente, é necessário reimplantá-lo executando a instrução ALTER MODEL no modelo e definindo a opção DEPLOY_MODEL como TRUE.

Modelos abertos implantados

1. No console do Google Cloud , acesse a página BigQuery.

   Acessar o BigQuery

2. Usando o editor de SQL, crie um modelo remoto:

   CREATE OR REPLACE MODEL
   `PROJECT_ID.DATASET_ID.MODEL_NAME`
   REMOTE WITH CONNECTION {DEFAULT | `PROJECT_ID.REGION.CONNECTION_ID`}
   OPTIONS (
     ENDPOINT = 'https://ENDPOINT_REGION-aiplatform.googleapis.com/v1/projects/ENDPOINT_PROJECT_ID/locations/ENDPOINT_REGION/endpoints/ENDPOINT_ID'
   );

   Substitua:

   • PROJECT_ID: o ID do projeto.
   • DATASET_ID: o ID do conjunto de dados para conter o modelo. Esse conjunto de dados precisa estar no mesmo local que a conexão que você está usando.
   • MODEL_NAME: o nome do modelo
   • REGION: a região usada pela conexão.
   • CONNECTION_ID: o ID da conexão do BigQuery

     Para conseguir esse valor, acesse os detalhes da conexão no console do Google Cloud e copie o valor na última seção do ID da conexão totalmente qualificado, mostrado em ID da conexão. Por exemplo: projects/myproject/locations/connection_location/connections/myconnection.

   • ENDPOINT_REGION: a região em que o modelo aberto está implantado.
   • ENDPOINT_PROJECT_ID: o projeto em que o modelo aberto está implantado.
   • ENDPOINT_ID: o ID do endpoint HTTPS usado pelo modelo aberto. Para conseguir o ID do endpoint, localize o modelo aberto na página Previsão on-line e copie o valor no campo ID.

Gerar embeddings de texto

Gere embeddings de texto com a função AI.GENERATE_EMBEDDING usando dados de texto de uma coluna da tabela ou de uma consulta.

Normalmente, você usaria um modelo de embedding de texto para casos de uso somente de texto e um modelo de embedding multimodal para casos de uso de pesquisa multimodal, em que os embeddings para conteúdo de texto e visual são gerados no mesmo espaço semântico.

Texto da Agent Platform

Gere embeddings de texto usando um modelo remoto em um modelo de embedding de texto da Agent Platform:

SELECT *
FROM AI.GENERATE_EMBEDDING(
  MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME`,
  {TABLE PROJECT_ID.DATASET_ID.TABLE_NAME | (CONTENT_QUERY)},
  STRUCT(TASK_TYPE AS task_type,
    OUTPUT_DIMENSIONALITY AS output_dimensionality)
);

Substitua:

• PROJECT_ID: o ID do projeto.
• DATASET_ID: o ID do conjunto de dados que contém o modelo.
• MODEL_NAME: o nome do modelo remoto sobre um modelo de embedding.
• TABLE_NAME: o nome da tabela que contém o texto a ser incorporado. Essa tabela precisa ter uma tabela chamada content ou é possível utilizar um alias para usar uma coluna com um nome diferente.
• CONTENT_QUERY: uma consulta cujo resultado contém uma coluna STRING chamada content.
• TASK_TYPE: um literal STRING que especifica o aplicativo downstream pretendido para ajudar o modelo a produzir embeddings de melhor qualidade. TASK_TYPE aceita os seguintes valores:
  • RETRIEVAL_QUERY: especifica que o texto é uma consulta em uma configuração de pesquisa ou recuperação.
  • RETRIEVAL_DOCUMENT: especifica que o texto é um documento em uma configuração de pesquisa ou recuperação.

    Ao usar esse tipo de tarefa, vale a pena incluir o título do documento na declaração de consulta para melhorar a qualidade da incorporação. O título do documento precisa estar em uma coluna chamada title ou com o alias como title, por exemplo:

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

    Especificar a coluna de título na consulta de entrada preenche o campo title do corpo da solicitação enviado ao modelo. Se você especificar um valor title ao usar qualquer outro tipo de tarefa, essa entrada será ignorada e não terá efeito nos resultados do embedding.

  • SEMANTIC_SIMILARITY: especifica o texto a ser usado para similaridade textual semântica (STS).
  • CLASSIFICATION: especifica que os embeddings serão usados para classificação.
  • CLUSTERING: especifica que os embeddings serão usados para clustering.
  • QUESTION_ANSWERING: especifica que os embeddings serão usados para responder a perguntas.
  • FACT_VERIFICATION: especifica que os embeddings serão usados para verificação de fatos.
  • CODE_RETRIEVAL_QUERY: especifica que os embeddings serão usados para recuperação de código.
• OUTPUT_DIMENSIONALITY: um INT64 valor que especifica o número de dimensões a serem usadas ao gerar os embeddings de vários tipos. Por exemplo, se você especificar 256 AS output_dimensionality, a coluna de saída embedding vai conter um embedding de 256 dimensões para cada valor de entrada.

  Para modelos remotos em modelos gemini-embedding-2-preview ou gemini-embedding-001, o valor OUTPUT_DIMENSIONALITY precisa estar no intervalo [1, 3072]. O valor padrão é 3072. Para modelos remotos em modelos text-embedding, o valor OUTPUT_DIMENSIONALITY precisa estar no intervalo [1, 768]. O valor padrão é 768.

Exemplo: incorporar texto em uma tabela

O exemplo a seguir mostra uma solicitação para incorporar a coluna content da tabela text_data:

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

Texto livre

Visualizar

Este produto ou recurso está sujeito aos Termos das Soluções Pré-GA na seção Termos Gerais de Serviço dos Termos Específicos de Serviço. Os produtos e recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

Observação: para enviar feedback ou solicitar suporte para esse recurso, entre em contato com [e-mail].

Gere embeddings de texto usando um modelo remoto em um modelo de embedding aberto:

SELECT *
FROM AI.GENERATE_EMBEDDING(
  MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME`,
  {TABLE PROJECT_ID.DATASET_ID.TABLE_NAME | (CONTENT_QUERY)},
);

Substitua:

• PROJECT_ID: o ID do projeto.
• DATASET_ID: o ID do conjunto de dados que contém o modelo.
• MODEL_NAME: o nome do modelo remoto sobre um modelo de embedding.
• TABLE_NAME: o nome da tabela que contém o texto a ser incorporado. Essa tabela precisa ter uma tabela chamada content ou é possível utilizar um alias para usar uma coluna com um nome diferente.
• CONTENT_QUERY: uma consulta cujo resultado contém uma coluna STRING chamada content.

Agent Platform multimodal

Gere embeddings de texto usando um modelo remoto em um modelo de embedding multimodal da Agent Platform:

SELECT *
FROM AI.GENERATE_EMBEDDING(
  MODEL `PROJECT_ID.DATASET_ID.MODEL_NAME`,
  {TABLE PROJECT_ID.DATASET_ID.TABLE_NAME | (CONTENT_QUERY)},
  STRUCT(OUTPUT_DIMENSIONALITY AS output_dimensionality)
);

Substitua:

• PROJECT_ID: o ID do projeto.
• DATASET_ID: o ID do conjunto de dados que contém o modelo.
• MODEL_NAME: o nome do modelo remoto em um modelo multimodalembedding@001.
• TABLE_NAME: o nome da tabela que contém o texto a ser incorporado. Essa tabela precisa ter uma tabela chamada content ou é possível utilizar um alias para usar uma coluna com um nome diferente.
• CONTENT_QUERY: uma consulta cujo resultado contém uma coluna STRING chamada content.
• OUTPUT_DIMENSIONALITY: um INT64 valor que especifica o número de dimensões a serem usadas ao gerar os embeddings de vários tipos. Os valores válidos são: 128, 256, 512 e 1408. O valor padrão é 1408. Por exemplo, se você especificar 256 AS output_dimensionality, a coluna de saída embedding vai conter um embedding de 256 dimensões para cada valor de entrada.

Exemplo: usar embeddings para classificar semelhança semântica

O exemplo a seguir incorpora uma coleção de avaliações de filmes e as ordena pela distância do cosseno à avaliação "Este filme foi médio" usando a função VECTOR_SEARCH. Uma distância menor indica mais semelhança semântica.

Para mais informações sobre a busca vetorial e o índice vetorial, consulte Introdução à busca vetorial.

CREATE TEMPORARY TABLE movie_review_embeddings AS (
  SELECT *
  FROM
    AI.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
      )
    )
);

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

O resultado será semelhante ao seguinte:

+------------------------------------------+----------------------------+
| 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       |
+------------------------------------------+----------------------------+

A seguir

• Saiba como usar embeddings de texto e imagem para realizar uma pesquisa semântica de criação de imagens a partir de texto.
• Saiba como usar embeddings de texto para pesquisa semântica e geração aumentada por recuperação (RAG).