Base de conhecimento

add_company_memory

Escrita

Registra um fato, uma decisão ou um processo da empresa (uma frase curta e completa, até 500 caracteres). Vira sugestão em Memória da empresa: só entra na busca depois que um administrador aprova. Para a empresa toda, uso interno.

Permissão

knowledge-base:write

Operação

company_memory.suggest

Parâmetros

kindstringobrigatório

FACTDECISIONPROCESS

contentstringobrigatório

validUntilstringopcional

Até quando vale (AAAA-MM-DD), para regras temporárias.

add_document

Escrita

Adiciona um documento a uma base: o texto é dividido em trechos e indexado para a busca dos agentes. O título é único na base.

Permissão

knowledge-base:write

Operação

knowledge.documents.add

Módulo

knowledge_base

Parâmetros

knowledgeBaseIdstringobrigatório

titlestringobrigatório

contentstringobrigatório

sourceUrlstringopcional

bulk_add_documents

Escrita

Adiciona até 200 documentos de uma vez. Título que já existe na base é atualizado com o novo conteúdo; itens sem título ou sem conteúdo são pulados. Devolve quantos foram criados, atualizados e pulados.

Permissão

knowledge-base:write

Operação

knowledge.documents.bulk

Módulo

knowledge_base

Parâmetros

knowledgeBaseIdstringobrigatório

documentsobject[]obrigatório

documents[].titlestringobrigatório

documents[].contentstringobrigatório

documents[].sourceUrlstringopcional

create_knowledge_base

Escrita

Cria uma base de conhecimento vazia (respeita o limite do plano). internalOnly: base interna, que a IA não usa ao responder clientes.

Permissão

knowledge-base:write

Operação

knowledge.bases.create

Módulo

knowledge_base

Parâmetros

namestringobrigatório

descriptionstringopcional

internalOnlybooleanopcional

delete_document

Escrita

Apaga um documento e seus trechos da base (a busca deixa de achá-lo na hora). Repetir não dá erro.

Permissão

knowledge-base:write

Operação

knowledge.documents.delete

Módulo

knowledge_base

Parâmetros

documentIdstringobrigatório

get_document

Leitura

Um documento da base de conhecimento, com o texto completo.

Permissão

knowledge-base:read

Operação

knowledge.documents.get

Módulo

knowledge_base

Parâmetros

documentIdstringobrigatório

get_knowledge_base

Leitura

Uma base de conhecimento, com a quantidade de documentos.

Permissão

knowledge-base:read

Operação

knowledge.bases.get

Módulo

knowledge_base

Parâmetros

knowledgeBaseIdstringobrigatório

get_knowledge_gap

Leitura

Uma lacuna: a pergunta, as variações de como os clientes perguntaram, as conversas em que apareceu e a resposta da equipe — base para escrever o documento.

Permissão

knowledge-base:read

Operação

knowledge_gaps.get

Parâmetros

gapIdstringobrigatório

get_knowledge_gap_stats

Leitura

Resumo das lacunas: abertas, novas na semana e resolvidas no mês.

Permissão

knowledge-base:read

Operação

knowledge_gaps.stats

Parâmetros

Sem parâmetros.

ignore_knowledge_gap

Escrita

Ignora uma lacuna que não precisa de resposta (fora do assunto, brincadeira, spam).

Permissão

knowledge-base:write

Operação

knowledge_gaps.ignore

Parâmetros

gapIdstringobrigatório

list_company_memory

Leitura

Lista a memória da empresa que vale hoje (aprovada, não substituída e dentro da validade), mais recentes primeiro. Filtre por tipo, pela origem (ex.: sourceType MEETING + sourceId = id da reunião traz o que ficou decidido nela) ou por texto.

Permissão

knowledge-base:read

Operação

company_memory.list

Parâmetros

kindstringopcional

FACT, DECISION ou PROCESS.FACTDECISIONPROCESS

sourceTypestringopcional

MEETINGCONVERSATIONTASKDOCUMENTMANUAL

sourceIdstringopcional

Id da reunião, conversa, tarefa ou documento.

qstringopcional

Texto no conteúdo.

pageintegeropcional

limitintegeropcional

list_documents

Leitura

Documentos de uma base de conhecimento (título, fonte, trechos). Para o texto de um documento, use get_document.

Permissão

knowledge-base:read

Operação

knowledge.documents.list

Módulo

knowledge_base

Parâmetros

knowledgeBaseIdstringobrigatório

list_knowledge_bases

Leitura

Bases de conhecimento da empresa, com quantos documentos cada uma tem.

Permissão

knowledge-base:read

Operação

knowledge.bases.list

Módulo

knowledge_base

Parâmetros

Sem parâmetros.

list_knowledge_gaps

Leitura

Perguntas que a IA não soube responder pela base, das mais frequentes: a pergunta, quantas vezes apareceu, quando, a base onde caberia e a resposta que a equipe deu na conversa (quando houve). ACTIVE = abertas e com sugestão.

Permissão

knowledge-base:read

Operação

knowledge_gaps.list

Parâmetros

statusstringopcional

ACTIVEALLOPENSUGGESTEDRESOLVEDIGNORED

knowledgeBaseIdstringopcional

dateFromstringopcional

AAAA-MM-DD (Brasília).

dateTostringopcional

AAAA-MM-DD, inclusivo.

pageintegeropcional

limitintegeropcional

resolve_knowledge_gap

Escrita

Responde uma lacuna: vira um documento curto e focado na base escolhida (título = a pergunta, conteúdo = a resposta, só com fatos confirmados) e a IA passa a responder isso. Não deixe trechos "[preencha: …]".

Permissão

knowledge-base:write

Operação

knowledge_gaps.resolve

Parâmetros

gapIdstringobrigatório

knowledgeBaseIdstringobrigatório

titlestringobrigatório

contentstringobrigatório

search_company_memory

Leitura

Busca na memória da empresa: decisões, fatos e processos já aprovados, que saíram de reuniões, conversas, tarefas e cadastros, com a origem e a data. Busca por significado (e por palavra). Use para "o que ficou decidido sobre X", "qual é a regra de Y". Para documentos da base de conhecimento, use search_knowledge_base.

Permissão

knowledge-base:read

Operação

company_memory.search

Parâmetros

querystringobrigatório

limitintegeropcional

Padrão 8.

search_knowledge_base

Leitura

Busca por significado na base de conhecimento da empresa (a mesma busca que os agentes usam para responder clientes). Devolve os trechos mais relevantes com a pontuação.

Permissão

knowledge-base:read

Operação

knowledge.search

Módulo

knowledge_base

Parâmetros

querystringobrigatório

Pergunta em linguagem natural.

limitintegeropcional

knowledgeBaseIdstringopcional

Só nesta base.

update_document

Escrita

Altera título, conteúdo ou fonte de um documento. Conteúdo novo é reindexado; o histórico de uso é mantido. Título repetido na mesma base dá conflito.

Permissão

knowledge-base:write

Operação

knowledge.documents.update

Módulo

knowledge_base

Parâmetros

documentIdstringobrigatório

titlestringopcional

contentstringopcional

sourceUrlstringopcional

Nulo remove a fonte.

update_knowledge_base

Escrita

Altera nome, descrição, se a base é pública (aparece na central de ajuda aberta da empresa) ou interna (a IA não usa ao responder clientes; quando o agente tem base fixa, vale a base dele). Pública e interna se excluem.

Permissão

knowledge-base:write

Operação

knowledge.bases.update

Módulo

knowledge_base

Parâmetros

knowledgeBaseIdstringobrigatório

namestringopcional

descriptionstringopcional

Nulo limpa.

isPublicbooleanopcional

internalOnlybooleanopcional