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

Memória e conhecimento

Como ensinar a Venddor Intelligence sobre a sua loja: memórias de negócio (regras, preferências, fatos) e a base de conhecimento (políticas, manuais, FAQ).

A VI responde melhor quando conhece a loja. Há duas formas de ensiná-la. Memórias são frases curtas e duráveis ("nunca dar mais de 15% de desconto", "o corte de expedição é às 15h"). A base de conhecimento guarda documentos inteiros (política de troca, manual do produto, FAQ), consultados por trechos quando a pergunta pede. Memórias e documentos valem para as respostas do administrador, do vendedor e do cliente final na loja, conforme as superfícies escolhidas.

Pontos-chave
  • Memória tem escopo: tenant vale para a loja inteira, user só para o administrador que a criou.
  • Há um teto de 200 memórias ativas e de 500 documentos / 50 MB na base. Passou disso, a criação responde 409.
  • Documento novo nasce processing, vira draft quando termina de ser indexado e só published entra nas respostas.
  • Memórias do tipo rule podem ter um conteúdo estruturado que a plataforma confere de forma mecânica antes de alterações automáticas.
  • Excluir uma memória é arquivar; a exclusão definitiva (LGPD) é um parâmetro explícito.

Como funciona

Ciclo de vida de um documento

processing→draft→published→archived
statusSignificado
processingRecebido; o texto está sendo dividido e indexado
draftIndexado, ainda não usado nas respostas. Pode ser testado em Publicar e buscar
publishedEntra nas respostas da VI, no atendimento e na loja
archivedFora de uso, mas guardado
failedA indexação falhou; o motivo está no campo error

Ciclo de vida de uma memória

active entra nas respostas; archived fica guardada e fora de uso. Uma regra nova com a mesma entidade, campo e alvo que uma regra antiga substitui a antiga (o campo superseded_by da antiga passa a apontar para a nova).

Conceitos-chave

Superfícies

Uma memória declara onde vale: site (cliente na loja), admin (painel do administrador) e seller (painel do vendedor). Sem informar, vale nas três.

Documentos por vendedor

Um documento com vendor_id fala só daquele vendedor (lojista) e é consultado nas conversas dele; sem vendor_id, vale para a loja inteira.

Busca semântica e busca por texto

Quando o índice de busca por significado está no ar, as buscas encontram trechos por sentido. Se não estiver (vector_online: false na listagem), a plataforma cai para uma busca por texto simples e avisa com degraded: true.

Rotas

Todas exigem Authorization: Bearer $TOKEN e um dos privilégios intelligence_use_chat ou manage_settings.

MétodoCaminho (após /api/v1/admin/intelligence)Para que servePágina
GET/memoriesListar memóriasmemories
POST/memoriesCriar uma memóriamemories
GET/memories/exportExportar em JSONmemories
PATCH/memories/{id}Alterar ou arquivarmemories
DELETE/memories/{id}Excluirmemories
GET/kb/documentsListar documentoskb-documents
POST/kb/documentsCriar documento (texto ou arquivo)kb-documents
GET/kb/documents/{id}Ler um documentokb-documents
PUT/kb/documents/{id}Alterar título e textokb-documents
DELETE/kb/documents/{id}Excluirkb-documents
POST/kb/documents/{id}/publishPublicarkb-lifecycle
POST/kb/documents/{id}/archiveArquivarkb-lifecycle
POST/kb/searchTestar a buscakb-lifecycle
POST/kb/reindexReindexarkb-lifecycle

Erros comuns

  • Publicar e esperar a resposta imediata. Um documento recém-criado ainda está em processing. Leia o documento até virar draft antes de publicar.
  • Renomear um documento enviando só o título. O documento volta para processing e fica assim (veja Documentos). Reenvie o content_md junto.
  • Subir o mesmo texto duas vezes. A plataforma compara o conteúdo e responde 409 para um duplicado.
  • Achar que "excluir memória" apaga. Sem hard=true ela só é arquivada.
  • Esperar que o export traga as memórias pessoais. O export cobre as da loja (tenant), incluindo arquivadas.
  • Enviar source_type pdf em JSON. No JSON só valem manual e faq; para PDF e DOCX envie o arquivo em multipart/form-data.

Próximos passos

Memórias
Criar, listar, alterar e exportar.
Documentos
Subir texto, PDF ou DOCX.
Publicar e buscar
Testar a busca antes de publicar.
Conversas
Onde essas informações aparecem nas respostas.
Anterior
Auditoria da VI
Próxima
Memórias de negócio
Nesta página
  • Como funciona
  • Ciclo de vida de um documento
  • Ciclo de vida de uma memória
  • Conceitos-chave
  • Superfícies
  • Documentos por vendedor
  • Busca semântica e busca por texto
  • Rotas
  • Erros comuns
  • Próximos passos