Документация

Всё, что нужно, чтобы внедрять

Обзор документации Simmetric Chat - от вашего первого промпта до развёртывания в продакшене.

DLP-конвейер для документов — справочник оператора

Когда DLP-сканирование включено для workspace, каждый загруженный документ проходит асинхронное pg-boss-сканирование после ingestion:

Пользовательские skill — свои инструкции по вызову `/slug`

Пользовательская skill — это шаблон prompt, который оператор или пользователь составляет один раз и вызывает из чата бесконечно как slash-команду (/translate Привет мир). Skill — только prompt-template-возможность: вызов компилирует сохранённый шаблон с …

Коннекторы — внешние каналы, подключённые к базе знаний

Коннекторы связывают каналы мессенджеров, где уже находятся ваши клиенты и коллеги — WhatsApp, Telegram, Discord, Slack — с той же базой знаний, которая питает внутренний чат. Разговоры остаются на ваших серверах: приложение запрашивает API канала с учёт…

Синтез-конвейер — объединять документы, вскрывать противоречия

Синтез-конвейер мульти-документа берёт набор страниц/документов архива и производит объединённые вики-страницы: каждая страница синтезирует источники, сигналит, где источники не согласны (contradiction detection), соблюдает бюджеты токенов/вызовов/страни…

Квоты и расходы — пределы использования и трат

Движок квоты покрывает три рода: квоту токенов и квоту хранилища (Phase 207) плюс квоту расхода (Phase 216, hold-and-settle над математикой настоящих денег). Квоты — инструмент оператора для потолков использования в многопользовательских установках; они …

Вики-движок — архива со схемой, викиссылки и синтез

Вики-движок даёт каждому архиву трёхуровневую модель инструкций: жёсткие правила, применяемые кодом, схемный prompt на архив (адвизорные редакционные руководства) и структурированные поля (persona, purpose, scope). Ментальная модель: schemaPrompt для вик…

Начало работы

Simmetric Chat — это локальная AI-чат-платформа, способная работать автономно (air-gap): она работает без подключения к внешним облачным сервисам, с локальной LLM (Ollama), локальными эмбеддингами (Xenova) и локальной векторной базой (LanceDB). При настр…

Архитектура

Simmetric Chat - это модульный TypeScript-монорепозиторий с 5 пакетами плюс десктопное приложение Tauri. Руководящий принцип - разделение границ: каждый пакет несёт отдельную ответственность и общается с другими только через хорошо определённые интерфейс…

Конфигурация

Simmetric Chat имеет два уровня конфигурации: переменные окружения, проверяемые с помощью Zod при запуске процесса, и уровень конфигурации времени выполнения, хранящийся в базе данных, который администраторы могут редактировать через интерфейс без переза…

Справочник API

REST API сервера Express (порт 3000, префикс /api) с интерактивным Swagger UI и OpenAPI-спецификацией, отдаваемой самим сервером, документированная здесь по доменам с её механизмами аутентификации, ограничениями скорости и соглашениями о ответах.

Руководство по функциям

Руководство по функциям с внутренним устройством, потоком данных и ссылками file:line. Для каждой функции: как работает, как использовать, как расширять.

Интеграция виджета

Встраиваемый виджет - это отдельный сервис (packages/widget, порт 3211), который публикует AI-чат на твоём сайте. Архитектура: Express + Preact IIFE в sandboxed iframe, прозрачный SSE-прокси к серверу, анонимные сессии, lead capture, branding для каждого…

MCP Marketplace

MCP Marketplace позволяет устанавливать, включать и ограничивать внешние MCP server из курируемого каталога. MCP server предоставляют tool, которые агент ReAct может вызывать во время чатов, расширяя возможности без кода.

Администрирование

Операционное руководство для администраторов: пользователи, роли (RBAC), workspace, audit, лицензии и административные бэкапы. Все операции требуют authMiddleware плюс конкретные разрешения - полный инвентарь endpoint'ов см. в API Reference.

Deployment

Simmetric Chat - air-gap capable и local-first. Пять целей развёртывания: Docker Compose multi-container (рекомендуется для продакшена), единый all-in-one container (air-gapped окружения), управляемый стек Coolify, dev override (hot-reload на Docker) и d…

Swagger / OpenAPI 3.0 доступны по адресу /api-docs когда сервер запущен.