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

Conhecimento do assistente

Como o seller ensina o assistente do WhatsApp a responder dúvidas da loja e a entender o nome das marcas escrito errado.

O assistente automático do WhatsApp responde bem sobre produtos porque lê o catálogo. Para o resto (prazo de troca, formas de pagamento, horário, garantia) ele precisa de texto escrito pela loja. Esta seção documenta as duas fontes que o seller alimenta pela API:

  • Base de conhecimento (knowledge base, KB): textos curtos com título e conteúdo, como um FAQ. O assistente busca o trecho mais parecido com a pergunta do cliente e responde com base nele.
  • Dicionário de marcas (brand corrections): pares "como o cliente escreve" para "como o produto se chama". Faz o assistente entender adidaz como adidas, antes de buscar no catálogo.
Pontos-chave
  • Todas as rotas são de usuário seller (/api/v1/vendor/whatsapp/...), com o módulo whatsapp-commerce ligado e o privilégio vendor_manage_whatsapp.
  • Tudo é do seller do token: ele só lê, cria e altera os próprios registros. Um registro de outro seller responde 404.
  • Para a base de conhecimento responder por significado (e não só por palavras iguais), a loja precisa ter a chave do serviço de IA configurada. Sem ela, a busca cai para uma busca por texto simples e a rota de reconstrução responde 503.
  • A criação de um par do dicionário é um "cria ou atualiza": repetir a mesma grafia errada atualiza o par existente.
  • Apagar é exclusão lógica: o registro some das listas, mas não é destruído.

Como funciona

Como a base de conhecimento é usada

Seller escreve a entrada→Plataforma gera o vetor→Cliente pergunta→Trecho mais parecido volta

Ao criar ou alterar uma entrada com a IA configurada, a plataforma calcula um vetor (embedding): uma lista de números que representa o significado do texto. Na busca, a pergunta do cliente também vira vetor e a plataforma devolve as entradas mais próximas. has_embedding na resposta diz se a entrada já tem vetor. Entradas sem vetor ainda aparecem na busca por texto simples (source: "ilike").

Estados de uma entrada

statusSignificado
activeEm uso. É o padrão ao criar.
draftRascunho, ainda não usado.
archivedArquivada.

Ids

Ids de entrada e de par do dicionário são UUID em string.

Endpoints

Auth: Seller é um usuário do painel do seller (Authorization: Bearer $TOKEN).

MétodoRotaO que fazAuthPágina
GET/api/v1/vendor/whatsapp/kbLista as entradasSellerEntradas
POST/api/v1/vendor/whatsapp/kbCria uma entradaSellerEntradas
GET/api/v1/vendor/whatsapp/kb/{id}Lê uma entradaSellerEntradas
PATCH/api/v1/vendor/whatsapp/kb/{id}Altera uma entradaSellerEntradas
PUT/api/v1/vendor/whatsapp/kb/{id}Altera uma entrada (igual ao PATCH)SellerEntradas
DELETE/api/v1/vendor/whatsapp/kb/{id}Apaga uma entradaSellerEntradas
POST/api/v1/vendor/whatsapp/kb/searchTesta a busca por significadoSellerBusca e vetores
POST/api/v1/vendor/whatsapp/kb/regenerateReconstrói os vetoresSellerBusca e vetores
POST/api/v1/vendor/whatsapp/kb/regenerate-embeddingsReconstrói os vetores (mesmo que regenerate)SellerBusca e vetores
GET/api/v1/vendor/whatsapp/brand-correctionsLista os pares do dicionárioSellerDicionário de marcas
POST/api/v1/vendor/whatsapp/brand-correctionsCria ou atualiza um parSellerDicionário de marcas
POST/api/v1/vendor/whatsapp/brand-corrections/testTesta uma frase de clienteSellerDicionário de marcas
PATCH/api/v1/vendor/whatsapp/brand-corrections/{id}Altera um parSellerDicionário de marcas
PUT/api/v1/vendor/whatsapp/brand-corrections/{id}Altera um par (igual ao PATCH)SellerDicionário de marcas
DELETE/api/v1/vendor/whatsapp/brand-corrections/{id}Apaga um parSellerDicionário de marcas

Erros comuns

  • Escrever a entrada como um texto enorme. Prefira várias entradas curtas, uma por assunto. O trecho devolvido é a entrada inteira.
  • Esperar busca por significado sem a chave de IA. Sem ela, search só acha palavras que aparecem no texto, e regenerate responde 503.
  • Mandar tags na alteração sem querer. Em PATCH/PUT, enviar tags troca a lista inteira; para manter, não envie o campo.
  • Achar que POST /brand-corrections sempre cria. Se a grafia errada (em minúsculas) já existe para o seller, o par é atualizado e a resposta continua 201.
  • Confiar em ids no regenerate. O campo é aceito mas hoje não limita a reconstrução.
  • Usar o vendor_id do corpo. Para sellers ele é ignorado: vale sempre o do token.

Próximos passos

Entradas
Criar e manter o FAQ.
Busca e vetores
Testar o que o assistente acharia.
Dicionário de marcas
Ensinar grafias erradas.
Anterior
Fluxos nativos da Meta
Próxima
Entradas da base de conhecimento
Nesta página
  • Como funciona
  • Como a base de conhecimento é usada
  • Estados de uma entrada
  • Ids
  • Endpoints
  • Erros comuns
  • Próximos passos