Knowledge base

add_company_memory

Write

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.

Permission

knowledge-base:write

Operation

company_memory.suggest

Parameters

kindstringrequired

FACTDECISIONPROCESS

contentstringrequired

validUntilstringoptional

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

add_document

Write

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

Permission

knowledge-base:write

Operation

knowledge.documents.add

Module

knowledge_base

Parameters

knowledgeBaseIdstringrequired

titlestringrequired

contentstringrequired

sourceUrlstringoptional

bulk_add_documents

Write

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.

Permission

knowledge-base:write

Operation

knowledge.documents.bulk

Module

knowledge_base

Parameters

knowledgeBaseIdstringrequired

documentsobject[]required

documents[].titlestringrequired

documents[].contentstringrequired

documents[].sourceUrlstringoptional

create_knowledge_base

Write

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

Permission

knowledge-base:write

Operation

knowledge.bases.create

Module

knowledge_base

Parameters

namestringrequired

descriptionstringoptional

internalOnlybooleanoptional

delete_document

Write

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

Permission

knowledge-base:write

Operation

knowledge.documents.delete

Module

knowledge_base

Parameters

documentIdstringrequired

get_document

Read

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

Permission

knowledge-base:read

Operation

knowledge.documents.get

Module

knowledge_base

Parameters

documentIdstringrequired

get_knowledge_base

Read

Uma base de conhecimento, com a quantidade de documentos.

Permission

knowledge-base:read

Operation

knowledge.bases.get

Module

knowledge_base

Parameters

knowledgeBaseIdstringrequired

get_knowledge_gap

Read

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.

Permission

knowledge-base:read

Operation

knowledge_gaps.get

Parameters

gapIdstringrequired

get_knowledge_gap_stats

Read

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

Permission

knowledge-base:read

Operation

knowledge_gaps.stats

Parameters

No parameters.

ignore_knowledge_gap

Write

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

Permission

knowledge-base:write

Operation

knowledge_gaps.ignore

Parameters

gapIdstringrequired

list_company_memory

Read

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.

Permission

knowledge-base:read

Operation

company_memory.list

Parameters

kindstringoptional

FACT, DECISION ou PROCESS.FACTDECISIONPROCESS

sourceTypestringoptional

MEETINGCONVERSATIONTASKDOCUMENTMANUAL

sourceIdstringoptional

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

qstringoptional

Texto no conteúdo.

pageintegeroptional

limitintegeroptional

list_documents

Read

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

Permission

knowledge-base:read

Operation

knowledge.documents.list

Module

knowledge_base

Parameters

knowledgeBaseIdstringrequired

list_knowledge_bases

Read

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

Permission

knowledge-base:read

Operation

knowledge.bases.list

Module

knowledge_base

Parameters

No parameters.

list_knowledge_gaps

Read

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.

Permission

knowledge-base:read

Operation

knowledge_gaps.list

Parameters

statusstringoptional

ACTIVEALLOPENSUGGESTEDRESOLVEDIGNORED

knowledgeBaseIdstringoptional

dateFromstringoptional

AAAA-MM-DD (Brasília).

dateTostringoptional

AAAA-MM-DD, inclusivo.

pageintegeroptional

limitintegeroptional

resolve_knowledge_gap

Write

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: …]".

Permission

knowledge-base:write

Operation

knowledge_gaps.resolve

Parameters

gapIdstringrequired

knowledgeBaseIdstringrequired

titlestringrequired

contentstringrequired

search_company_memory

Read

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.

Permission

knowledge-base:read

Operation

company_memory.search

Parameters

querystringrequired

limitintegeroptional

Padrão 8.

search_knowledge_base

Read

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.

Permission

knowledge-base:read

Operation

knowledge.search

Module

knowledge_base

Parameters

querystringrequired

Pergunta em linguagem natural.

limitintegeroptional

knowledgeBaseIdstringoptional

Só nesta base.

update_document

Write

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.

Permission

knowledge-base:write

Operation

knowledge.documents.update

Module

knowledge_base

Parameters

documentIdstringrequired

titlestringoptional

contentstringoptional

sourceUrlstringoptional

Nulo remove a fonte.

update_knowledge_base

Write

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.

Permission

knowledge-base:write

Operation

knowledge.bases.update

Module

knowledge_base

Parameters

knowledgeBaseIdstringrequired

namestringoptional

descriptionstringoptional

Nulo limpa.

isPublicbooleanoptional

internalOnlybooleanoptional