Documentação

Tudo o que você precisa para entregar

Explore a documentação do Simmetric Chat - do seu primeiro prompt às implantações em produção.

Pipeline de síntese — reunir os documentos, descobrir as contradições

A pipeline de síntese multi-documento toma um conjunto de páginas/documentos de um arquivo e produz páginas wiki reunidas: cada página sintetiza as fontes, sinaliza onde as fontes não estão de acordo (contradiction detection), respeita as quotas de token…

Pipeline DLP para documentos — referência operativa

Quando a varredura DLP está habilitada para um workspace, cada documento carregado atravessa uma varredura assíncrona pg-boss após a ingestão:

Conectors — canais externos ligados à base de conhecimento

Os conectors ligam os canais de mensageria onde os seus clientes e colegas já estão — WhatsApp, Telegram, Discord, Slack — à mesma base de conhecimento que alimenta o chat interno. As conversas permanecem nos vossos servidores: a aplicação consulta as AP…

Motor de wiki — arquivos com esquema, wikilinks e síntese

O motor de wiki dá a cada arquivo um modelo de instrução de três níveis: regras duras aplicadas pelo código, um prompt de esquema por arquivo (linhas-guia editoriais advisory) e campos estruturados (persona, purpose, scope). Modelo mental: schemaPrompt e…

Skills personalizadas — instruções à medida invocáveis com `/slug`

Uma skill personalizada é uma template de prompt que um operador ou um utilizador compõe uma vez e invoca sem limite a partir do chat como comando slash (/translate Olá mundo). As skills são só capacidade de prompt-template: a invocação compila a templat…

Quotas e custos — os limites de uso e de despesa

O motor de quota cobre três géneros: a quota de tokens e a quota de armazenamento (Phase 207) mais a quota de custo (Phase 216, hold-and-settle sobre a matemática do dinheiro real). As quotas são a ferramenta do operador para os limites de uso em instala…

Guia de início

Simmetric Chat é uma plataforma de chat de IA local-first e capaz de funcionar offline (air-gap): funciona sem conexão a serviços cloud externos, com LLM local (Ollama), embeddings locais (Xenova) e vector DB local (LanceDB). Pode, no entanto, usar prove…

Arquitetura

Simmetric Chat é um monorepo TypeScript modular com 5 packages mais um app desktop Tauri. O princípio norteador é a separação de fronteiras: cada package tem responsabilidades distintas e se comunica com os outros apenas por interfaces bem definidas (HTT…

Configuração

Simmetric Chat tem dois níveis de configuração: variáveis de ambiente validadas com Zod na inicialização do processo, e uma camada de configuração runtime armazenada no banco de dados que administradores podem editar pela interface sem reiniciar nenhum s…

Referência da API

API REST do servidor Express (porta 3000, prefixo /api), com interface Swagger interativa e spec OpenAPI servida pelo próprio servidor, documentada aqui por domínio com seus mecanismos de autenticação, limites de velocidade e convenções de resposta.

Guia de funcionalidades

Guia das features com internals, fluxo de dados e referências file:line. Para cada feature: como funciona, como usar, como estender.

Integração do widget

O widget embutível é um serviço separado (packages/widget, porta 3211) que expõe um chat AI no seu site. Arquitetura: Express + Preact IIFE em iframe sandboxed, proxy SSE transparente para o servidor, sessões anônimas, lead capture, branding por site.

MCP Marketplace

O MCP Marketplace permite instalar, habilitar e scopear MCP server externos a partir de um catálogo curado. Os MCP server expõem tools que o agente ReAct pode invocar durante os chats, estendendo as capacidades sem código.

Administração

Guia operativo para administradores: usuários, roles (RBAC), workspace, audit, licenças e backups administrativos. Todas as operações exigem authMiddleware mais permissões específicas - ver a API Reference para o inventário completo de endpoints.

Deploy

Simmetric Chat é air-gap capable e local-first. Cinco targets de deploy: Docker Compose multi-container (recomendado para produção), container único all-in-one (ambientes air-gapped), stack gerido Coolify, override dev (hot-reload sobre Docker) e desktop…

Desenvolvimento

Guia para contribuir para o codebase: setup, estrutura monorepo, scripts, convenções, i18n.

Testing

Simmetric Chat usa Jest 30 com transformação @swc/jest (unit + integration) e Playwright (E2E), orquestrados pelo Turborepo. O jest.config.cjs raiz agrega os 5 projetos (shared, server, frontend, collector, widget).

Troubleshooting

Sintomas comuns, causa, resolução. Referências file:line e cross-link para os docs.

Documentação interativa da API

Swagger / OpenAPI 3.0 são servidos em /api-docs quando o servidor estiver em execução.