Criar configurações de veiculação

Esta página descreve 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 veiculação de pesquisa têm requisitos e opções diferentes:

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

    Se você criar a configuração de exibição usando o console, poderá criar um novo modelo durante o processo de criação em vez de anexar um modelo existente.

    Você pode mudar de modelo mais tarde, desde que seja do mesmo tipo.

  • A Pesquisa pode usar controles de exibição, mas eles não são obrigatórios. Se você planeja anexar controles a uma nova configuração de veiculação, confira os IDs dos controles que pretende usar.

    Se você estiver criando a configuração de exibição usando o console, também poderá criar novos controles durante o processo de criação.

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

Criar uma configuração de veiculação

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

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

Se você tiver posições ou criar novas, uma configuração de exibição associada a cada posição será criada automaticamente. A criação de uma configuração de exibiçã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 remove a configuração de veiculação correspondente.

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

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

Para criar uma nova configuração de veiculação:

  1. Acesse a página Configurações de exibição no console da Pesquisa para varejo.

    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 em que a configuração de exibição será usada.

    2. Dê um nome à configuração de exibiçã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 que a 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 deve afetar os resultados da recomendação, se disponível para o modelo selecionado.

      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. Selecione se você quer usar a diversificação baseada em regras ou em dados:

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

      • Baseada em dados:a diversificação baseada em dados usa o aprendizado de máquina para equilibrar a diversidade e a relevância da categoria nos resultados de 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, escolha se quer ativar a correspondência de categoria.

      Quando a correspondência de categoria está ativada, os únicos resultados de produtos 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 Pesquisa como o produto em que a configuração de exibição será usada.
    2. Dê um nome à 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 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 quer ativar o atributo dinâmico 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 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 em um nome de configuração e acesse a guia Avaliar para conferir 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 exibição com o método da API ServingConfig.create. Para conferir a documentação de referência da API para esse método, consulte ServingConfig.create.

Os campos que você usa dependem se você está criando 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 veiculaçã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 ServingConfig legível por humanos exibido no console da Pesquisa para varejo.
  • modelID: obrigatório. O ID do modelo a ser usado no momento da veiculação.
  • priceRerankingLevel: opcional. Define quanto a reclassificação de preços precisa afetar 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 o 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 estiver definido, a diversidade será desativada.
  • diversityType: opcional. Defina como RULE_BASED_DIVERSITY para diversificar os resultados de recomendação com base na categoria do produto. Defina como DATA_DRIVEN_DIVERSITY para diversificar as recomendações com base no aprendizado dos metadados do produto para equilibrar a relevância e a diversidade da categoria. Se diversityLevel estiver definido, mas diversityType não estiver, diversityType vai ser definido como baseado em regras. Para mais informações, consulte Diversificação.
  • enableCategoryFilterLevel: opcional. Define se é necessário adicionar outros filtros de categoria no modelo de itens semelhantes. Os valores permitidos são relaxed-category-match (valor padrão se não definido) e no-category-match.
  • solutionTypes: obrigatório. Definido como SOLUTION_TYPE_RECOMMENDATION para configurações de veiculaçã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"

Pesquisar

Faça uma solicitação ServingConfig.create com um ID de configuração de veiculaçã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 ServingConfig legível por humanos exibido no console da Pesquisa para varejo.
  • 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 definido) e ENABLED.
  • boostControlIds: opcional. IDs dos controles de veiculação do boost.
  • 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 dos controles de veiculação de sinônimos unidirecionais.
  • doNotAssociateControlIds: opcional. IDs dos controles de veiculação de não associação.
  • replacementControlIds: opcional. IDs dos controles de exibição de substituição.
  • ignoreControlIds: opcional. IDs dos controles de veiculação ignorados.
  • solutionTypes: obrigatório. Defina como SOLUTION_TYPE_SEARCH para configurações de veiculação de pesquisa.
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