Esta é a documentação do Recommendations AI, da Pesquisa de varejo e do novo Console do Retail.

Criar configurações de exibição

Nesta página, você verá 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 configurações de exibição da Recommendations AI e da pesquisa de varejo têm requisitos e opções diferentes:

  • As configurações de exibição do Recommendations AI exigem um modelo. Se você anexa um modelo existente a uma nova configuração de exibição, receba o ID do modelo que você planeja usar (obrigatório ao usar o método ServingConfig.create).

    Se você estiver criando 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 existente.

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

  • A Pesquisa de varejo pode usar os controles de veiculação, mas eles não são obrigatórios. Se você planeja anexar controles existentes a uma nova configuração de exibição, receba 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 exibição

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

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

Se você tiver posições ou criar novas posições, a API Retail criará automaticamente uma configuração de exibição associada a cada veiculação. Criar uma configuração de exibição não cria uma posição correspondente. A exclusão de uma configuração de exibição remove a posição correspondente e a exclusão de uma veiculação exclui a configuração de exibiçã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 Google Cloud.

Para criar uma nova configuração de exibição, siga estas etapas:

  1. Acesse a página "Configurações de exibição de varejo" no Console do Google Cloud.

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

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

    Recommendations AI

    1. Selecione Recomendação como o produto que será usado na configuração de exibição.

    2. Forneça um nome para a 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 reclassificação de preços deve afetar os resultados da recomendação.

      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 o valor para diversificar os resultados da recomendação.

      A diversificação afeta se os resultados retornados de uma única solicitação de previsão são de categorias diferentes do catálogo de produtos.

    7. Se você selecionou um modelo de itens semelhantes para essa configuração de exibição, defina se a correspondência de categoria será ativada.

      Quando a correspondência de categoria está ativada, a API Retail retorna apenas os resultados de produtos que compartilham pelo menos uma categoria com o produto de contexto. A correspondência de categoria pode ser usada 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. Forneça um nome para sua configuração de exibição.

      O nome precisa ter 1.024 caracteres ou menos 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 no seu projeto. Ele pode ter até 50 caracteres e não pode conter espaços.
    4. Clique em Continuar.
    5. Escolha se você quer ativar o atributo dinâmico para esta configuração de exibição.
    6. Escolha ou crie controles de veiculação para otimizar as 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 em um nome de 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 exibição com ServingConfig.create

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

Os campos usados dependem de se você está criando uma configuração de exibição para o Recommendations AI ou a Pesquisa de varejo.

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

Recommendations AI

Faça uma solicitação ServingConfig.create com um ID de configuração de exibição e uma instância de ServingConfig 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 do varejo.
  • modelID: obrigatório. O código do modelo a ser usado no momento da veiculação.
  • priceRerankingLevel: opcional. Define a reclassificação de preços que afeta os resultados da recomendação. Os valores permitidos são no-price-reranking (valor padrão se não estiver definido), low-price-raranking, medium-price-reranking e high-price-reranking.
  • enableCategoryFilterLevel: opcional. Define se serão adicionados ou não filtros de categoria ao modelo de "itens semelhantes" Os valores permitidos são relaxed-category-match (valor padrão se não estiver definido) e no-category-match.
  • solutionTypes: obrigatório. Defina como SOLUTION_TYPE_RECOMMENDATION para as configurações de exibição do Recommendations AI.
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",
              "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"
  

Pesquisa de varejo

Faça uma solicitação ServingConfig.create com um ID de configuração de exibição e uma instância de ServingConfig 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 do 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 for definido) e ENABLED.
  • boostControlIds: opcional. IDs de controles de exibição maiores.
  • filterControlIds: opcional. IDs dos controles de veiculação de filtros.
  • redirectControlIds: opcional. IDs dos controles de exibição de redirecionamento.
  • twowaySynonymsControlIds: opcional. IDs dos controles de veiculação de sinônimos de mão dupla.
  • onewaySynonymsControlIds: opcional. IDs dos controles de veiculação de sinônimos unidirecional.
  • doNotAssociateControlIds: opcional. IDs de controles de veiculação não associar.
  • replacementControlIds: opcional. IDs dos controles de veiculação substitutos.
  • ignoreControlIds: opcional. IDs de controles de veiculação ignorados.
  • solutionTypes: obrigatório. Defina como SOLUTION_TYPE_SEARCH para as configurações de exibição da pesquisa de varejo.
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