VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Predições

O que são as predições de aprendizado de máquina da Venddor, como são calculadas e atualizadas, e como ler as de cada produto, cliente ou pedido.

A plataforma calcula, em segundo plano e de tempos em tempos, dezenas de previsões sobre a sua loja: quantos dias o estoque de um produto dura, qual cliente está prestes a parar de comprar, se um boleto vai ser pago, qual transportadora entrega mais rápido. Cada previsão é guardada com uma confiança e uma validade. As rotas desta seção apenas leem essas previsões já calculadas; elas não disparam cálculo nenhum.

Use-as para mostrar um selo ao lado de um produto numa tela ("estoque acaba em 13 dias"), alimentar um painel de BI ou decidir uma reposição. A tela do administrador usa as mesmas rotas.

Pontos-chave
  • Cada previsão é de uma característica (feature), como a1_stock_runway, e de uma entidade (um produto, cliente, pedido...) identificada por um UUID.
  • As rotas de leitura exigem o cabeçalho X-Tenant-ID, mesmo quando você chama pelo subdomínio da loja. Sem ele a resposta é 400 missing tenant.
  • Se a entidade ainda não tem previsão vigente, você recebe status: calculating, não um erro nem um valor antigo.
  • Sempre passe ids na listagem. Sem ela, a rota devolve a previsão mais recente de todas as entidades da loja, sem limite.
  • O conteúdo de fields muda de característica para característica; leia cada uma pelo exemplo e pela saúde do cálculo.

Como funciona

  1. A plataforma calcula

    Um processo em segundo plano recalcula cada característica e grava uma linha por entidade, com data de cálculo (computed_at) e validade (valid_until).

  2. Você confere a saúde

    Saúde das predições mostra, por característica, se o último cálculo funcionou e quando rodou.

  3. Você lê

    Ler predições devolve selos compactos para vários ids de uma vez, ou o registro completo de uma entidade.

Conceitos-chave

Característica (feature)

O tipo de previsão. O id tem a forma <código>_<nome>, como a1_stock_runway (a letra agrupa a área: A estoque e catálogo, B vendas, C clientes, D preço, E marketing, F sellers, G risco, H logística, I atendimento, J plataforma, K financeiro, P personalização). Na URL você pode usar a1_stock_runway ou stock_runway: as duas valem.

Confiança, validade e suposições

confidence vai de 0 a 1 e pode faltar. valid_until é a data a partir da qual a previsão não é mais devolvida. assumptions é um objeto livre que descreve as premissas do cálculo; as chaves variam por característica e não são um contrato estável.

Dados de demonstração

Em lojas de teste, as previsões podem ter sido geradas a partir de dados sintéticos. O campo assumptions costuma indicar isso. Não use previsões de uma loja de teste para decisões reais.

Catálogo de características

CaracterísticaO que prevê
a1_stock_runwayCobertura de estoque em dias (por quantos dias o estoque dura)
a2_reorderSugestão de reposição de estoque
a3_stockout_riskRisco de ruptura (estoque chegar a zero)
a4_dead_stockDiagnóstico de estoque parado
a5_demand_forecastPrevisão de demanda em unidades por semana
a6_cross_sellProdutos com maior chance de compra conjunta
a7_listing_qualityNota preditiva de qualidade do cadastro do produto
a8_cannibalizationSKUs do mesmo seller que competem entre si
b1_revenuePrevisão de receita e de número de pedidos da loja
b2_paymentProbabilidade de pagamento de um pedido pendente (boleto/Pix)
b3_etaPrevisão de prazo de um pedido, do envio à entrega
b4_sales_anomalyAnomalias de vendas (quedas e picos fora do esperado)
b5_return_riskRisco de devolução de um produto
c1_churnRisco de o cliente parar de comprar
c2_next_orderData prevista da próxima compra do cliente
c3_clvValor de vida (LTV) previsto do cliente
c4_recoPróximos melhores produtos para o cliente
c5_cart_recoveryMelhor estratégia de recuperação de carrinho
c6_personaPersona (segmento natural) do cliente
c7_email_churnRisco de descadastro ou rejeição de newsletter
d1_priceElasticidade de preço e preço ótimo do produto
d2_margin_riskMargem efetiva em risco
d3_b2b_tiersTabela de preços B2B por volume sugerida
e1_promo_upliftRetorno e receita incremental estimados de uma promoção
e2_send_timeMelhor dia e hora para enviar mensagens
e3_next_offerPróxima melhor oferta para o cliente
e4_coupon_fatigueDependência de cupom (fadiga) do cliente
e5_liveAudiência e receita esperadas de uma transmissão ao vivo
f1_seller_healthSaúde de um seller do marketplace
f2_fulfillment_delayRisco de atraso de envio de um pedido
f3_concentrationConcentração de vendas (GMV) em poucos sellers ou produtos
g1_creditScore próprio de crédito do cliente
g2_vendor_debtPlano de recuperação de débito de um seller
g3_fraudScore próprio de fraude de pedidos
g4_chargebackProbabilidade de chargeback (contestação)
h1_carrier_etaPrazo real de entrega por transportadora
h2_slot_saturationSaturação prevista dos horários de entrega
h3_sla_driftTendência do prazo real de entrega ao longo do tempo
h4_carrier_choiceTransportadora ótima sugerida para um pedido
i1_topicsTópicos emergentes e sentimento das avaliações
i2_quality_alertAlerta de qualidade de um produto
i3_ticket_priorityPriorização preditiva de mensagens e chamados
j1_tenant_churnRisco de churn de uma loja da plataforma (visão da plataforma)
j2_upsellMomento de upsell de uma loja da plataforma (visão da plataforma)
k1_cashflowProjeção diária de caixa da loja (90 dias)
p1_user_affinityPerfil de afinidade de cada usuário

A previsão de transmissão ao vivo é lida na URL como e5_live (ou live); e5_live_forecast não é reconhecido e devolve 404.

j1_tenant_churn e j2_upsell são visões da plataforma sobre as lojas: ficam guardadas fora do banco da sua loja e só fazem sentido para a equipe da plataforma. Lê-las por esta rota responde 500.

Endpoints

MétodoCaminhoPara que serveAuth
GET/api/v1/admin/predictions/healthSaúde dos cálculosadmin
GET/api/v1/admin/predictions/{feature}Listar predições de várias entidadesadmin
GET/api/v1/admin/predictions/{feature}/{entityID}Ler a predição de uma entidadeadmin

Erros comuns

  • Esquecer o X-Tenant-ID. Dá 400 missing tenant nas duas rotas de leitura (a de saúde não exige).
  • Listar sem ids. Devolve a loja inteira, sem ordem garantida. Em lojas grandes são milhares de linhas.
  • Tratar calculating como falha. Significa só que ainda não há previsão vigente.
  • Usar um nome de característica inexistente. Dá 404 unknown prediction feature.
  • Esperar uma lista pelo ids em características de várias linhas por entidade. Algumas (como a6_cross_sell e d3_b2b_tiers) guardam várias linhas por entidade; sem all=1 você recebe só uma.

Próximos passos

Saúde
Veja se os cálculos estão rodando.
Ler predições
Busque selos e registros completos.
Anterior
Gerar banners
Próxima
Saúde das predições
Nesta página
  • Como funciona
  • Conceitos-chave
  • Característica (feature)
  • Confiança, validade e suposições
  • Dados de demonstração
  • Catálogo de características
  • Endpoints
  • Erros comuns
  • Próximos passos