Criar configurações de exibição

Nesta página, descrevemos como criar configurações de exibição. Uma configuração de exibição é uma entidade de exibição que associa um modelo ou um conjunto de controles usados para gerar os resultados da pesquisa ou de recomendações.

Antes de começar

As recomendações e as configurações de exibição de pesquisa têm requisitos e opções diferentes:

  • as configurações de veiculação das recomendações exigem um modelo. Se você planeja anexar um modelo atual a uma nova configuração de exibição, consiga o ID do modelo que planeja usar (obrigatório ao usar o método ServingConfig.create).

    Ao criar a configuração de disponibilização usando o console, é possível criar um novo modelo durante o processo de criação em vez de anexar um atual.

    Os modelos podem ser trocados depois, desde que sejam do mesmo tipo.

  • pesquisa podem usar controles de veiculação, mas eles não são obrigatórios. Se você planeja anexar controles atuais a uma nova configuração de veiculação, consiga os IDs dos controles que planeja usar.

    Se estiver criando a configuração de veiculação usando o console, também será possível criar novos controles durante o processo de criação.

    É possível alternar ou adicionar controles de veiculação à configuração de veiculação depois de criá-la.

Criar uma configuração de veiculação

É possível criar uma configuração de veiculação usando:

São permitidas até 100 configurações de veiculação por catálogo.

Se você tiver posições existentes ou criar novas posições, uma configuração de veiculação associada a cada uma delas será criada automaticamente. Criar uma configuração de veiculação não cria uma posição correspondente. A exclusão de uma configuração de veiculação exclui a posição correspondente, e a exclusão de uma posição também remove a configuração de veiculação correspondente.

Criar uma configuração de exibição no console

Adicione uma nova configuração de veiculação na página "Configurações de exibição" no console da Search for Retail.

Para criar uma nova configuração de veiculação, faça o seguinte:

  1. Acesse a página Configurações de veiculação no console da Pesquisa for Retail.

    Acessar a página "Configurações de exibição"

  2. Clique em Criar configuração de veiculação.

    recomendações

    1. Selecione Recomendação como o produto para o qual a configuração de veiculação será usada.

    2. Atribua um nome para a configuração de veiculação.

      O nome precisa ter 1.024 caracteres ou menos e pode conter apenas caracteres alfanuméricos, sublinhados, hífens e espaços.

    3. Opcional: se necessário, atualize o ID.

      O ID é gerado a partir do nome fornecido e precisa ser exclusivo em todo o projeto. Ele precisa ter até 50 caracteres e não pode conter espaços.

    4. Escolha ou crie um modelo para o qual você quer que essa configuração de exibição forneça recomendações.

      Saiba mais sobre como criar novos modelos.

    5. Selecione quanto a reclassificação de preços vai afetar os resultados da recomendação, se disponível para o modelo escolhido.

      A reclassificação de preços organiza, por ordem decrescente de preço, os produtos recomendados que têm probabilidade similar de serem pedidos. A relevância ainda é usada para ordenar itens. Portanto, ativar a reclassificação de preços não é o mesmo que classificar por preço.

    6. Escolha se você quer usar a diversificação baseada em regras ou em dados:

      • Com base em regras:a diversificação baseada em regras afeta se os resultados retornados de uma única solicitação de previsão são de diferentes categorias do seu catálogo de produtos.

      • Baseada em dados:a diversificação baseada em dados usa machine learning para equilibrar a diversidade e a relevância da categoria nos resultados da previsão.

      Para mais informações, consulte Diversificação.

    7. Selecione o valor para diversificar os resultados da recomendação.

    8. Se você selecionou um modelo de itens semelhantes para essa configuração de veiculação, indique se quer ativar a correspondência de categoria.

      Quando a correspondência de categoria está ativada, os únicos resultados de produto retornados são aqueles que compartilham pelo menos uma categoria com o produto de contexto. A correspondência de categoria pode ser usada em combinação com outras opções de filtragem, como preço, disponibilidade e tags de filtro.

    1. Na página Criar configuração de exibição, escolha Pesquisar como o produto para o qual a configuração de exibição será usada.
    2. Forneça um nome para sua configuração de veiculação.

      Ele precisa ter no máximo 1.024 caracteres e pode conter apenas caracteres alfanuméricos, sublinhados, hifens e espaços.
    3. Opcional: se necessário, atualize o ID.

      Ele é gerado com base no nome fornecido e precisa ser exclusivo em todo o projeto. Ele precisa ter até 50 caracteres e não pode conter espaços.
    4. Clique em Continuar.
    5. Escolha se você quer ativar os atributos dinâmicos para essa configuração de exibição.
    6. Escolha ou crie controles de veiculação para otimizar suas pesquisas.

      Para mais informações sobre controles, consulte Como criar e gerenciar controles.
  3. Clique em Criar para gerar a nova configuração.

    A nova configuração aparece na página Configurações de exibição.

    Pode levar alguns minutos para que a configuração fique disponível para uso em solicitações de pesquisa. Ela fica disponível imediatamente para recomendações.

  4. Opcional: na página "Configurações de exibição", clique no nome de uma configuração e acesse a guia Avaliar para visualizar os produtos que seriam retornados para essa configuração.

    A visualização da avaliação pode ajudar a confirmar se a configuração está funcionando conforme o esperado.

Criar uma configuração de veiculação com ServingConfig.create

É possível criar uma configuração de veiculação com o método de API ServingConfig.create. Para conferir a documentação de referência da API para esse método, consulte ServingConfig.create.

Os campos usados dependem da criação de uma configuração de exibição para recomendações ou pesquisa.

Para mais detalhes sobre os campos ServingConfig, consulte a Referência da API ServingConfigs.

recomendações

Faça uma solicitação ServingConfig.create com um ID de configuração de exibição e uma instância de ServingConfig contida no corpo da solicitação.

  • servingConfigId: obrigatório. Cria um ID para o ServingConfig. Esse valor precisa ter de 4 a 63 caracteres. Os caracteres válidos são /[a-z][0-9]-_/.
  • displayName: obrigatório. O nome legível do ServingConfig exibido no console da Search for Retail.
  • modelID: obrigatório. O ID do modelo a ser usado no momento da disponibilização.
  • priceRerankingLevel: opcional. Define quanto a reclassificação de preços afeta os resultados da recomendação. Os valores permitidos são no-price-reranking (valor padrão se não definido), low-price-raranking, medium-price-reranking e high-price-reranking.
  • diversityLevel: opcional. Define quanto diversificar os resultados das recomendações. Os valores permitidos são no-diversity (padrão), low-diversity, medium-diversity, high-diversity e auto-diversity. Se diversityLevel não for definido, a diversidade será desativada.
  • diversityType: opcional. Defina como RULE_BASED_DIVERSITY para diversificar os resultados da recomendação com base na categoria dos produtos. Defina como DATA_DRIVEN_DIVERSITY para diversificar as recomendações com base no aprendizado de metadados do produto para equilibrar relevância e diversidade de categorias. Se diversityLevel estiver definido, mas diversityType não, diversityType será definido como baseado em regras por padrão. Para mais informações, consulte Diversificação.
  • enableCategoryFilterLevel: opcional. Define se precisa adicionar outros filtros de categoria ao modelo "Itens semelhantes". Os valores permitidos são relaxed-category-match (valor padrão se não definido) e no-category-match.
  • solutionTypes: obrigatório. Defina como SOLUTION_TYPE_RECOMMENDATION para as configurações de exibição de recomendações.
curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "modelId": "MODEL_ID",
              "priceRerankingLevel": "PRICE_RERANKING_LEVEL",
              "diversityType": "DIVERSITY_TYPE",
              "diversityLevel": "DIVERSITY_LEVEL",
              "enableCategoryFilterLevel": "CATEGORY_FILTER_LEVEL",
              "solutionTypes": [ "SOLUTION_TYPE_RECOMMENDATION" ]
            }' \
    "https://retail.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/servingConfigs?servingConfigId=SERVING_CONFIG_ID"
  

search

Faça uma solicitação ServingConfig.create com um ID de configuração de exibição e uma instância de ServingConfig contida no corpo da solicitação.

  • servingConfigId: obrigatório. Cria um ID para o ServingConfig. Esse valor precisa ter de 4 a 63 caracteres. Os caracteres válidos são /[a-z][0-9]-_/.
  • displayName: obrigatório. O nome legível do ServingConfig exibido no console da Search for Retail.
  • facetControlIds: opcional. IDs de controles que têm apenas FacetSpec definido.
  • dynamicFacetSpec.mode: opcional. Modo do recurso DynamicFacet. Os valores permitidos são DISABLED (padrão se não for definido) e ENABLED.
  • boostControlIds: opcional. IDs dos controles de otimização de veiculação.
  • filterControlIds: opcional. IDs dos controles de veiculação de filtros.
  • redirectControlIds: opcional. IDs dos controles de veiculação de redirecionamento.
  • twowaySynonymsControlIds: opcional. IDs dos controles de veiculação de sinônimos bidirecionais.
  • onewaySynonymsControlIds: opcional. IDs de controles de veiculação de sinônimos unidirecionais.
  • doNotAssociateControlIds: opcional. IDs dos controles de exibição não associar.
  • replacementControlIds: opcional. IDs dos controles de veiculação substitutos.
  • ignoreControlIds: opcional. IDs de controles de veiculação que ignoram.
  • solutionTypes: obrigatório. Defina como SOLUTION_TYPE_SEARCH para pesquisar configurações de exibição.
curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": DISPLAY_NAME,
              "facetControlIds": [
                "FACET_CONTROL_ID_1",
                "FACET_CONTROL_ID_2"
              ],
              "dynamicFacetSpec": {
                "mode": "DYNAMIC_FACET_MODE"
              },
              "boostControlIds": [
                "BOOST_CONTROL_ID_1",
                "BOOST_CONTROL_ID_2"
              ],
              "filterControlIds": [
                "FILTER_CONTROL_ID_1",
                "FILTER_CONTROL_ID_2"
              ],
              "redirectControlIds": [
                "REDIRECT_CONTROL_ID_1",
                "REDIRECT_CONTROL_ID_2"
              ],
              "twowaySynonymsControlIds": [
                "TWO_WAY_SYNONYM_CONTROL_ID_1",
                "TWO_WAY_SYNONYM_CONTROL_ID_2"
              ],
              "onewaySynonymsControlIds": [
                "ONE_WAY_SYNONYM_CONTROL_ID_1",
                "ONE_WAY_SYNONYM_CONTROL_ID_2"
              ],
              "doNotAssociateControlIds": [
                "DO_NOT_ASSOCIATE_CONTROL_ID_1",
                "DO_NOT_ASSOCIATE_CONTROL_ID_2"
              ],
              "replacementControlIds": [
                "REPLACEMENT_CONTROL_ID_1",
                "REPLACEMENT_CONTROL_ID_2"
              ],
              "ignoreControlIds": [
                "IGNORE_CONTROL_ID_1",
                "IGNORE_CONTROL_ID_2"
              ],
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ]
    }' \
    "https://retail.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/servingConfigs?servingConfigId=SERVING_CONFIG_ID"
  

Próximas etapas