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

WhatsApp: conhecimento do assistente

Base de conhecimento, dicionário de correções de marca e registro das chamadas à IA do assistente de WhatsApp.

O assistente de WhatsApp responde clientes sozinho. Para responder bem, ele precisa de duas coisas que a loja controla: uma base de conhecimento (os textos que ele pode usar) e um dicionário de correções (para entender como o cliente escreve). Esta seção cobre as duas, mais o registro das chamadas que o assistente faz a provedores de IA.

Pontos-chave
  • Exige o módulo whatsapp-commerce e o privilégio manage_settings. As correções de marca exigem também manage_whatsapp.
  • Entradas sem vendor_id valem para a loja toda; com vendor_id, só para aquele seller.
  • Só entradas ativas são encontradas pela busca; rascunho e arquivada ficam de fora.
  • Listagens aceitam limit até 200 (500 nas correções); acima disso o limite volta para 50.
  • Os registros de IA trazem conteúdo de conversas: trate como dado sensível.

Como funciona

Fluxo típico para ensinar algo novo ao assistente:

  1. Cadastre o texto

    POST /kb com title e content_text. Use status: "draft" se ainda estiver revisando.

  2. Confira a busca

    POST /kb/search com uma pergunta de cliente. O texto novo deve aparecer em hits.

  3. Ative

    PATCH /kb/{id} com status: "active". Se criou como ativa, esta etapa não existe.

  4. Ensine as grafias

    POST /brand-corrections para cada apelido ou erro comum, e teste com POST /brand-corrections/test.

Estados de uma entrada da base:

EstadoLetraSignificado
activeAAtiva: o assistente a encontra.
draftRRascunho: salva, mas fora da busca.
archivedDArquivada: guardada, fora da busca.

Conceitos-chave

Índice de busca por significado

Quando a loja tem IA configurada, cada entrada ganha um índice que permite achar o texto pelo sentido da pergunta, mesmo com palavras diferentes ("quanto tempo para trocar" acha "Política de troca"). Sem IA, a busca cai num simples trecho de texto. has_embedding mostra se a entrada tem índice, e POST /kb/regenerate-embeddings completa os que faltam.

Loja inteira ou um seller

Numa loja com vários sellers (lojistas), cada seller pode ter entradas e correções próprias. As sem vendor_id são da loja e servem a todos. Quando você filtra por seller na busca, as entradas da loja toda entram junto.

Correção de marca

É um par "grafia errada, nome certo" com um peso. A grafia é guardada em minúsculas. Se duas correções disputam a mesma grafia, vence o maior peso. A plataforma também aprende grafias sozinha (source = auto-learned).

Custos em centavos

O custo de cada chamada de IA, quando conhecido, vem em centavos de real inteiros.

Endpoints

MétodoCaminhoPara que servePágina
GET/api/v1/admin/whatsapp/kbLista as entradas da base de conhecimentoEntradas da base
POST/api/v1/admin/whatsapp/kbCria uma entrada na base de conhecimentoEntradas da base
GET/api/v1/admin/whatsapp/kb/{id}Lê uma entrada da base de conhecimentoEntradas da base
PATCH/api/v1/admin/whatsapp/kb/{id}Altera uma entrada da base de conhecimentoEntradas da base
DELETE/api/v1/admin/whatsapp/kb/{id}Apaga uma entrada da base de conhecimentoEntradas da base
POST/api/v1/admin/whatsapp/kb/searchBusca na base de conhecimentoBusca e índice da base
POST/api/v1/admin/whatsapp/kb/regenerateRefaz o índice de busca da baseBusca e índice da base
POST/api/v1/admin/whatsapp/kb/regenerate-embeddingsRefaz o índice de busca da base (alias)Busca e índice da base
GET/api/v1/admin/whatsapp/brand-correctionsLista as correções de marcaCorreções de marca
POST/api/v1/admin/whatsapp/brand-correctionsCria (ou atualiza) uma correção de marcaCorreções de marca
PATCH/api/v1/admin/whatsapp/brand-corrections/{id}Altera uma correção de marcaCorreções de marca
DELETE/api/v1/admin/whatsapp/brand-corrections/{id}Apaga uma correção de marcaCorreções de marca
POST/api/v1/admin/whatsapp/brand-corrections/testTesta a busca inteligente com uma fraseCorreções de marca
GET/api/v1/admin/whatsapp/ai-logsLista as chamadas à IA do assistente de WhatsAppRegistro de chamadas à IA

Erros comuns

  • Criar a entrada como rascunho e esperar que o assistente a use: só active entra na busca.
  • Usar PUT para alterar uma entrada: a rota é PATCH.
  • Mandar tags em PATCH para acrescentar uma etiqueta: o campo substitui a lista inteira.
  • Esperar que limit=500 valha em /kb ou /ai-logs: o teto é 200 e acima disso o limite vira 50.
  • Tentar renomear a grafia de uma correção: só canonical e weight mudam. Apague e crie de novo.
  • Rodar regenerate numa loja sem IA: a resposta é 503.
  • Passar um id que não é UUID: a plataforma responde 500 em vez de 400.

Próximos passos

Entradas da base
Cadastrar e manter os textos.
Busca e índice
Testar e refazer o índice.
Correções de marca
Dicionário de grafias.
Registro de chamadas à IA
Custo, duração e erros.
Anterior
Chaves de Flow
Próxima
Entradas da base
Nesta página
  • Como funciona
  • Conceitos-chave
  • Índice de busca por significado
  • Loja inteira ou um seller
  • Correção de marca
  • Custos em centavos
  • Endpoints
  • Erros comuns
  • Próximos passos