Importe dados de preenchimento automático para a pesquisa

O preenchimento automático é uma funcionalidade que prevê o resto de uma palavra que um utilizador está a escrever, o que pode melhorar a experiência de pesquisa do utilizador. Pode fornecer sugestões de preenchimento automático com base no conjunto de dados fornecido ou nos eventos de utilizadores que forneceu.

Pondere importar dados de preenchimento automático apenas se quiser ter controlos adicionais (lista de não remoção, lista de negação) ou se precisar de usar os seus próprios dados de preenchimento automático. A ativação da aprendizagem automática é suficiente na maioria dos casos em que o preenchimento automático é necessário. A aprendizagem automática fornece um conjunto de dados de sugestões com tecnologia de aprendizagem automática com base em eventos de pesquisa do utilizador. Consulte a secção Preenchimento automático para saber como ativar a aprendizagem automática.

Nota: a partir de setembro de 2022, pode usar a IU Consola da nuvem > Controlos > Controlos de preenchimento automático para acionar a importação de dados.

Estas instruções destinam-se apenas ao carregamento dos seus próprios dados de preenchimento automático. Mantenha-o atualizado se planear usar o conjunto de dados de preenchimento automático sempre. Para obter resultados de preenchimento automático no momento da consulta, consulte CompletionService.CompleteQuery. Os dados do preenchimento automático são usados apenas para a pesquisa. Estes dados não são usados pelas recomendações.

Antes de começar

Antes de poder importar as suas informações de preenchimento automático, tem de ter concluído as instruções em Antes de começar, especificamente configurar o seu projeto, criar uma conta de serviço e adicionar a conta de serviço ao seu ambiente local.

Tem de ter a função de IAM Editor de retalho para realizar a importação.

Práticas recomendadas para a importação da funcionalidade de preenchimento automático

Quando importa dados de preenchimento automático, certifique-se de que implementa as seguintes práticas recomendadas:

• Leia o esquema do BigQuery indicado nas seguintes secções e documentação da API.

• Não use valores de marcadores de posição.

• Inclua o maior número possível de campos.

• Mantenha o seu próprio conjunto de dados de preenchimento automático atualizado se planear usar o conjunto de dados carregado.

• A importação de dados de outro projeto não é permitida.

Importe dados de preenchimento automático

Importe dados de preenchimento automático do BigQuery

A Pesquisa do Vertex AI para comércio suporta a importação de dados do BigQuery para a lista de recusa, a lista de não remoção e a lista de termos de sugestão. Veja mais detalhes no Preenchimento automático.

Para importar dados de preenchimento automático no formato correto do BigQuery, use o esquema de preenchimento automático da Vertex AI Search for commerce para criar uma tabela do BigQuery com o formato correto e carregar a tabela com os seus dados de preenchimento automático. Em seguida, carregue os seus dados para o Vertex AI Search for commerce.

Para mais ajuda com as tabelas do BigQuery, consulte o artigo Introdução às tabelas. Para obter ajuda com as consultas do BigQuery, consulte o artigo Vista geral da consulta de dados do BigQuery.

Localização do conjunto de dados do BigQuery

Quando criar o conjunto de dados do BigQuery para as tabelas do BigQuery de preenchimento automático, certifique-se de que a localização do conjunto de dados está definida como a localização multirregional "US". Se não o definir corretamente, o pedido de importação vai falhar mais tarde. Para saber mais sobre as localizações dos conjuntos de dados do BigQuery, consulte o artigo Localizações dos conjuntos de dados na documentação do BigQuery.

Preencha dados no BigQuery

Use o esquema de preenchimento automático da Vertex AI Search para comércio para carregar os seus dados de preenchimento automático para o BigQuery.

O BigQuery pode usar o esquema para validar se os dados formatados em JSON têm nomes e tipos de campos corretos (como STRING, INTEGER e RECORD), mas não pode realizar validações como determinar:

• Se um campo de string for mapeado para um valor de enumeração reconhecível.
• Se um campo de string estiver a usar o formato correto.
• Se um campo de número inteiro ou de vírgula flutuante tem um valor num intervalo válido.
• Se um campo em falta for um campo obrigatório.

Para garantir a qualidade dos seus dados e a experiência de pesquisa do utilizador final, certifique-se de que consulta o esquema e a documentação de referência para obter detalhes sobre os valores e o formato.

Configure o acesso ao seu conjunto de dados do BigQuery

Para configurar o acesso, certifique-se de que o seu conjunto de dados do BigQuery está no mesmo projeto que o seu serviço Vertex AI Search for commerce e conclua os seguintes passos.

1. Abra a página IAM na Google Cloud consola.

   Abra a página do IAM

2. Selecione o seu projeto do Vertex AI Search for commerce.

3. Na página IAM e administrador, clique em  Conceder acesso.

4. Para Novos responsáveis, introduza [e-mail] e selecione a função BigQuery > Visualizador de dados do BigQuery.

   Se não quiser atribuir a função de leitor de dados a todo o projeto, pode adicioná-la diretamente ao conjunto de dados. Saiba mais.

5. Clique em Guardar.

Acione a importação de dados para o Vertex AI Search for commerce

Consola

1. Aceder à página Controlos

2. Aceda ao separador Controlos de preenchimento automático.

3. Na secção Listas de termos, encontre o tipo de lista que planeia importar (Lista de recusa, Lista de não remoção ou Lista de termos sugeridos) e clique em Importar ou Substituir.

   É aberto o painel Importar.

4. Introduza o caminho do BigQuery da localização dos dados ou selecione Procurar para selecionar a localização.

   O caminho do BigQuery tem de estar no mesmo projeto e o respetivo esquema tem de estar correto. Para verificar esta situação, clique em Procurar e clique no nome da tabela para ver o respetivo conteúdo na consola do BigQuery.

5. No painel Importar, clique em Importar.

   A importação começa. Pode sair da página sem interromper a importação.

cURL

1. Crie um ficheiro de dados para os parâmetros de entrada da importação. Os valores dos parâmetros de entrada dependem de estar a importar do Cloud Storage ou do BigQuery.

   Use o objeto BigQuerySource para apontar para o seu conjunto de dados do BigQuery.

   • dataset-id: o ID do conjunto de dados do BigQuery.
   • table-id: o ID da tabela do BigQuery que contém os seus dados.
   • data-schema: para a propriedade dataSchema, use o valor suggestions (predefinição), allowlist ou denylist. Use o esquema de preenchimento automático do Vertex AI Search para comércio.

   {
     "inputConfig":{
       "bigQuerySource": {
         "datasetId":"dataset-id",
         "tableId":"table-id",
         "dataSchema":"data-schema"
       }
     }
   }

2. Importe as suas informações de preenchimento automático para a Vertex AI Search for commerce fazendo um pedido ao método REST CompletionData:import, indicando o nome do ficheiro de dados (apresentado como input.json no exemplo abaixo).POST

   curl -X POST \
   -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
   -H "Content-Type: application/json; charset=utf-8" -d @./input.json
   "https://retail.googleapis.com/v2alpha/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/completionData:import"

   Pode verificar o estado de forma programática através da API. Deve receber um objeto de resposta com um aspeto semelhante ao seguinte:

   {
     "name": "projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456",
     "done": false
   }

   O campo name é o ID do objeto de operação. Para pedir o estado deste objeto, substitua o campo name pelo valor devolvido pelo método de importação. Quando a importação estiver concluída, o campo done é devolvido como true:

   curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
   "https://retail.googleapis.com/v2alpha/projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456"

   Quando a operação estiver concluída, o objeto devolvido tem um valor de donetrue e inclui um objeto de estado semelhante ao seguinte exemplo:

   {
     "name": "projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456",
     "metadata": {
       "@type": "type.googleapis.com/google.cloud.retail.v2alpha.ImportMetadata",
       "createTime": "2020-01-01T03:33:33.000001Z",
       "updateTime": "2020-01-01T03:34:33.000001Z",
       "successCount": "2",
       "failureCount": "1"
     },
     "done": true
     "response": {
       "@type": "type.googleapis.com/google.cloud.retail.v2alpha.ImportCompletionDataResponse",
     }
   }

Formato de dados do preenchimento automático

O ficheiro JSON deve ter um aspeto semelhante aos exemplos seguintes. As quebras de linha destinam-se a facilitar a leitura. Deve fornecer uma sugestão completa numa única linha. Cada sugestão deve estar na sua própria linha.

Campos mínimos obrigatórios para sugestões:

{
  "suggestion": "ABC",
  "globalScore": "0.5"
}

Ou:

{
  "suggestion": "ABC",
  "frequency": "100"
}

Duração da importação de dados de preenchimento automático

Normalmente, a conclusão de uma importação do BigQuery demora alguns minutos a uma hora.

Quando a importação do conjunto de dados estiver concluída, o campo done no objeto de operação é marcado como verdadeiro. Depois disso, os dados podem demorar mais 1 a 2 dias a serem indexados e usados na publicação em produção.

Mantenha o conjunto de dados do preenchimento automático atualizado

Se planeia usar o seu próprio conjunto de dados carregado, é uma prática recomendada manter o conjunto de dados carregado atualizado regularmente.

Atualização em lote

Pode usar o método de importação para atualizar o preenchimento automático em lote. Faz isto da mesma forma que faz a importação inicial. Siga os passos em Importar dados de preenchimento automático. Esta ação substitui todo o conjunto de dados importado.

Monitorize o estado da importação

Manter o seu próprio conjunto de dados atualizado é importante para receber resultados de sugestões de alta qualidade quando o usa. Deve monitorizar as taxas de erro de importação e tomar medidas, se necessário.

Esquema de preenchimento automático do Vertex AI Search for commerce

Quando importar o conjunto de dados de preenchimento automático do BigQuery, use o esquema do Vertex AI Search for commerce abaixo para criar tabelas do BigQuery com o formato correto e carregá-las com os seus dados de preenchimento automático.

Esquema para sugestões

Este conjunto de dados é usado para fornecer as suas próprias expressões de sugestão de preenchimento automático com as suas próprias classificações.

Esquema JSON de sugestões de preenchimento automático do Vertex AI Search for commerce

JSON

[
  {
    "description": "The suggestion text",
    "mode": "NULLABLE",
    "name": "suggestion",
    "type": "STRING"
  },
  {
    "description": "Global score of this suggestion. Control how this suggestion would be scored / ranked. Only one of this and frequency should be set.",
    "mode": "NULLABLE",
    "name": "globalScore",
    "type": "FLOAT"
  },
  {
    "description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.",
    "mode": "NULLABLE",
    "name": "frequency",
    "type": "INTEGER"
  },
  {
    "description": "BCP-47 language code of this suggestion.",
    "mode": "NULLABLE",
    "name": "languageCode",
    "type": "STRING"
  },
  {
    "description": "If two suggestions have the same groupID, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.",
    "mode": "NULLABLE",
    "name": "groupID",
    "type": "STRING"
  },
  {
    "description": "The score of this suggestion within its group",
    "mode": "NULLABLE",
    "name": "groupScore",
    "type": "FLOAT"
  },
  {
    "description": "Device type for this suggestion.",
    "mode": "NULLABLE",
    "name": "deviceType",
    "type": "STRING"
  },
  {
    "description": "Alternative matching phrases for this suggestion.",
    "mode": "REPEATED",
    "name": "alternativePhrases",
    "type": "STRING"
  },
  {
    "fields": [
      {
        "description": "The name of the custom attribute.",
        "mode": "NULLABLE",
        "name": "key",
        "type": "STRING"
      },
      {
        "fields": [
          {
            "description": "The textual values of this custom attribute.",
            "mode": "REPEATED",
            "name": "text",
            "type": "STRING"
          },
          {
            "description": "The numerical values of this custom attribute.",
            "mode": "REPEATED",
            "name": "numbers",
            "type": "FLOAT"
          }
        ],
        "mode": "NULLABLE",
        "name": "value",
        "type": "RECORD"
      }
    ],
    "description": "A custom attribute that is not explicitly modeled, which can be retrieved together with the suggestion at serving time.",
    "mode": "REPEATED",
    "name": "customAttributes",
    "type": "RECORD"
  }
]

Esquema para a lista de negações

Este conjunto de dados é usado como uma lista de exclusão para impedir que sejam sugeridas expressões.

Esquema JSON da lista de exclusão do preenchimento automático do Vertex AI Search for commerce

JSON

[
  {
    "description": "The phrase to block from autocomplete suggestions.",
    "mode": "REQUIRED",
    "name": "phrase",
    "type": "STRING"
  },
  {
    "description": "The operator to apply for this phrase. Choose whether to block the exact phrase, or block any suggestions containing this phrase. Supported value \"EXACT_MATCH\", \"CONTAINS\"",
    "mode": "REQUIRED",
    "name": "operator",
    "type": "STRING"
  }
]

Esquema para a lista de autorizações

Este conjunto de dados é usado para ignorar os processos posteriores (como a correção ortográfica e a filtragem de zero resultados) para todas as expressões nesta lista de autorizações.

Esquema JSON da lista de autorizações do preenchimento automático do Vertex AI Search for commerce

JSON

[
  {
    "description": "The phrase to be exempted from autocomplete post processing, e.g. spell correction, filtering",
    "mode": "REQUIRED",
    "name": "phrase",
    "type": "STRING"
  },
  {
    "description": "The operator to apply for this phrase. Whether to match the exact phrase, or any suggestions contain this phrase. Supported values are \"EXACT_MATCH\", \"CONTAINS\".",
    "mode": "REQUIRED",
    "name": "operator",
    "type": "STRING"
  }
]