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

Monitoramento e solução de problemas

Nesta página, descrevemos como receber informações sobre erros que ocorreram em importações de eventos do catálogo e do usuário, além de outras operações da API Retail.

Se precisar de ajuda, consulte Configurar alertas.

Introdução

É importante fornecer informações precisas do catálogo e eventos do usuário para a API Retail. Assim, é importante conseguir os melhores resultados. Monitorar e entender a origem dos erros ajuda você a encontrar e corrigir erros no seu site.

Ver erros de integração agregados

Para ver os erros agregados gerados pelos processos de upload de dados e solicitações de previsão ou pesquisa, use a guia Monitoramento na página Monitoring e Analytics.

Nesta página, você verá todos os erros da API Retail. É possível visualizar erros relacionados ao catálogo de produtos, eventos do usuário, previsões do Recommendations AI, resultados da pesquisa de varejo e modelos. O sistema também registra erros de importações, como uma linha malformada no arquivo do Cloud Storage. O sistema registra até 100 erros por arquivo de importação. Você pode definir o período em que os erros são exibidos e filtrar com base no tipo de erro.

É possível clicar em um erro individual para ver os registros desse erro no Cloud Logging.

É possível abrir registros de erro individuais expandindo esse registro. Os registros de erros fornecem mais detalhes sobre a solicitação, incluindo payloads de solicitações e respostas e detalhes dos erros. Essas informações podem ajudar você a determinar onde a chamada de método incorreto está localizada no seu site.

Para erros de JSON inválidos, é possível ver mais informações sobre o problema expandindo o campo status.

Ver o status de uma operação de integração específica

É possível ver o status de uma operação de integração específica usando o painel de atividade de integração:

  1. Acesse a página "Dados de varejo" no Console do Google Cloud.

    Acessar a página "Dados"

  2. Clique em View Import Activity na barra de botões para abrir o painel "Import Activity".

    É possível inspecionar erros para operações específicas de integração.

  3. Clique em Ver registros na coluna "Detalhes" de qualquer operação com um erro para inspecionar os arquivos de registros no Cloud Logging.

Tipos de erro

  • MISSING_FIELD: um valor de campo obrigatório não foi definido. por exemplo, um item de catálogo não tem o título.
  • INVALID_TIMESTAMP: o carimbo de data/hora é inválido, por exemplo, estar muito distante no futuro ou formatado incorretamente.
  • FIELD_VALUE_TOO_SMALL: o valor no campo é menor que o mínimo necessário; por exemplo, um preço negativo.
  • INCORRECT_JSON_FORMAT: o JSON na solicitação está formatado incorretamente, como um colchete { ausente.
  • INVALID_LANGUAGE_CODE: o código do idioma está formatado incorretamente.
  • FIELD_VALUE_EXCEEDED: o valor no campo é maior que o máximo permitido.
  • INVALID_RESOURCE_ID: o ID do recurso é inválido; por exemplo, um catalog_id inexistente no nome do recurso.
  • FIELD_SIZE_EXCEEDED: o número de entradas no campo excede o limite máximo.
  • UNEXPECTED_FIELD: um campo que deveria estar vazio foi preenchido. Por exemplo, a transação para um evento de visualização da página de detalhes.
  • INVALID_FORMAT: o campo não está formatado corretamente, como uma string malformada.
  • RESOURCE_ALREADY_EXISTS: você tentou criar um recurso que já existe, como um item de catálogo criado anteriormente.
  • INVALID_API_KEY: a chave de API não corresponde ao projeto na sua solicitação.
  • INSUFFICIENT_PERMISSIONS: você não tem permissão para executar a solicitação. Esse erro geralmente está relacionado à falta de permissão do IAM necessária.
  • UNJOINED_WITH_CATALOG: a solicitação inclui um código de item de catálogo que não existe no catálogo. Verifique se o seu catálogo está atualizado.
  • BATCH_ERROR: a solicitação tem vários erros. Por exemplo, uma importação in-line com 10 itens que falharam na validação por motivos diferentes.
  • INACTIVE_RECOMMENDATION_MODEL: você consultou um modelo que não está ativo para exibição.
  • ABUSIVE_ENTITY: o ID do visitante ou do usuário associado à solicitação enviou um número anormal de eventos em um curto período.
  • FILTER_TOO_STRICT: o filtro de solicitação de previsão bloqueou todos os resultados da previsão. Os itens genéricos (não personalizados) conhecidos são retornados, a menos que a chamada especifique strictFiltering como falso. Nesse caso, nenhum item é retornado. Veja alguns motivos comuns que podem causar esse problema:

    • Você está especificando uma tag de filtro que não existe no seu catálogo. Pode levar até um dia para que uma atualização de tag de filtro entre em vigor.
    • Seu filtro é muito limitado.

Ver registros diretamente

Também é possível abrir seus arquivos de registros diretamente no Logging. Por exemplo, este link abre registros de todos os erros de varejo na última hora: Registros de varejo abertos

Ver métricas de carregamento de dados

Depois que o sistema de upload de dados estiver em execução, também será possível usar as guias Catálogo e Evento na página Dados do varejo para visualizar métricas de erro na ingestão de dados e garantir que tudo esteja funcionando.

Também é possível adicionar alertas para saber se algo der errado com seu sistema de upload de dados.

Resumo dos dados do catálogo

Use a guia Catálogo na página Dados para ver estatísticas de dados de alto nível para cada ramificação de catálogo. Nesta página, você verá quantos produtos foram importados, quantos estão em estoque e quando foi a última importação de cada ramificação de catálogo de produtos.

Também é possível visualizar os itens do catálogo que você enviou e filtrar com base nos campos dos produtos.

É possível importar dados para diferentes ramificações como uma forma de organizar e visualizar resultados do Recommendations AI ou da Pesquisa de varejo. Por exemplo, para se preparar para um período de festas de fim de ano, faça o upload de novos dados de catálogo para uma ramificação não padrão e verifique se os resultados de varejo são gerados corretamente antes de publicar no site.

Estatísticas de gravação de eventos do usuário.

Para cada tipo de evento do usuário, é possível ver na guia Evento quantos você gravou, quantos não foram associados a um produto (eventos não incluídos) e as diferenças entre os números e os períodos anteriores. É possível selecionar um período predefinido ou inserir um intervalo personalizado.

O gráfico de métricas exibe os eventos do usuário ingeridos ao longo do tempo, que podem ser filtrados por tipo de evento.

Métricas de qualidade de dados

Na página Dados, clique em Visualizar qualidade de dados para abrir o painel Qualidade de dados.

As métricas de qualidade de dados mostram as porcentagens de produtos e eventos do usuário que atendem aos padrões recomendados.

Embora a melhoria da qualidade de dados de acordo com essas métricas não seja obrigatória para o uso da API Retail, é altamente recomendável receber recomendações e resultados de pesquisa melhores.

Qualidade dos dados do catálogo

A guia Catálogo, na página Dados, mostra a porcentagem de produtos no catálogo que atendem às métricas de qualidade do catálogo para a Pesquisa de varejo.

Para ver uma lista de todas as métricas de qualidade de dados do catálogo, consulte Métricas de qualidade de dados de catálogo.

Qualidade dos dados do evento

A guia Evento na página Dados mostra quantos dos eventos do usuário atendem às práticas recomendadas de qualidade de dados para a Recommendations AI e a Pesquisa de varejo.

A guia Qualidade dos dados tem duas seções:

  • Métricas gerais da API Retail: a primeira seção desta guia mostra as métricas aplicáveis à Recommendations AI e à Retail Search. Seguir as sugestões dessas métricas pode melhorar as recomendações e os resultados da pesquisa.

    É possível filtrar as métricas nesta seção por período dos eventos de usuário avaliados.

  • Métricas de pesquisa: as métricas desta seção são aplicáveis apenas à Pesquisa de varejo. Seguir as sugestões dessas métricas pode melhorar os resultados da pesquisa.

    Não é possível filtrar essas métricas por período.

    A métrica Eventos de pesquisa é atualizada quase em tempo real. A métrica Eventos de pesquisa com filtros é atualizada pela primeira vez entre 4 e 24 horas após o upload dos eventos de pesquisa. As informações são atualizadas a cada quatro horas.

    Outras métricas nesta seção só serão exibidas depois que a métrica Eventos de pesquisa atingir 100%. Depois que os eventos de pesquisa forem concluídos, você verá essas métricas cerca de 24 horas depois. Eles são atualizados uma vez por dia.

    Produtos únicos visitados e Cliques médios de pesquisa por produto são métricas relacionadas. Se essas métricas tiverem porcentagens baixas, a melhoria de uma delas com a importação de mais dados do evento de pesquisa também melhorará a outra métrica.

Para ver todos os requisitos e recomendações de eventos do usuário para o Recommendations AI e a Pesquisa de varejo, consulte Requisitos e práticas recomendadas para eventos de usuário.

Eventos cancelados

Quando um evento de usuário ou uma solicitação de API se refere a um produto que não foi enviado para o varejo, ele é um evento não associado. Os eventos de usuários não associados ainda são registrados, e as solicitações separadas são processadas, mas nenhum deles pode ser usado para melhorar ainda mais o modelo para previsões futuras. Por esse motivo, verifique se a porcentagem de evento não registrado é muito baixa para eventos de usuário e solicitações de previsão.

Veja a porcentagem de evento de usuário desconectado na guia Evento da página Dados.

Erros da API

Para ver um gráfico de erros da API ao longo do tempo, exibido pelo nome do método, clique em Visualizar métricas da API na barra de botões da página Monitoring e Analytics }

Monitorar a atividade do método da API

Para visualizar o tráfego, os erros e a latência por método de API, acesse a guia Monitoramento na página Monitoring e Analytics. Você pode selecionar um período predefinido ou inserir um intervalo personalizado.

Para ver mais detalhes sobre cada gráfico:

  • Abaixo de um gráfico, clique no nome de um método para isolá-lo.
  • Passe o cursor sobre um gráfico para ver uma chamada com cada método e os valores deles nesse momento.
  • Clique e arraste sobre qualquer seção do gráfico para aumentar o zoom nesse período.

A seguir