Coreness — Платформа для автоматизации и AI-решений
Добро пожаловать в документацию платформы Coreness — системы для создания ботов, автоматизации бизнес-процессов и AI-решений через декларативные YAML-конфигурации.
🔧 Для продвинутых пользователей: Расширенная документация — архитектура, плагины, деплой
⚡ Оглавление документации
🚀 Практические примеры сценариев
🔧 Master Bot — Управление тенантами
📋 Руководство по созданию сценариев
- Структура сценария
- Триггеры
- Scheduled сценарии
- Действия (step)
- Переходы (transition)
- Плейсхолдеры (Placeholders)
- Асинхронные действия
🎯 Гайд по действиям системы
📡 Гайд по событиям системы
⚙️ Руководство по конфигурации тенантов
💾 Руководство по хранилищу атрибутов
🤖 Гайд по моделям AI
🔄 Changelog
🚀 Начало работы
📖 Практические примеры сценариев
Сборник практических примеров — от быстрого старта до продвинутых сценариев с оплатами, RAG хранилищем и сложной логикой. Включает пошаговое руководство для создания первого бота, примеры базовых сценариев, продвинутые примеры работы с оплатами и векторным хранилищем для RAG (Retrieval-Augmented Generation).
Когда использовать: Если вы впервые работаете с платформой, хотите быстро создать тестового бота или ищете примеры реализации конкретных задач (например, работа с оплатами, сохранение и поиск данных в векторном хранилище).
🔧 Master Bot — Управление тенантами
Системный бот для управления тенантами платформы (по аналогии с @BotFather): выбор тенантов, настройка токенов, управление Storage, синхронизация с GitHub, контроль доступа.
Когда использовать: Для централизованного управления тенантами, настройки ботов и синхронизации конфигураций после развёртывания платформы.
📖 Полный индекс документации
📋 Руководство по созданию сценариев
Что это: Полное руководство по созданию и настройке сценариев для Telegram-ботов с поддержкой плейсхолдеров, переходов и динамической логики.
Зачем нужно: Все действия ваших ботов (команды, меню, обработка сообщений) реализуются через сценарии. Здесь описан весь процесс создания: от написания триггеров до сложной логики с переходами и плейсхолдерами, с примерами на каждый случай.
Что внутри:
- Структура сценария
- Триггеры (условия запуска сценария)
- Последовательность действий (step)
- Переходы между сценариями (transition)
- Плейсхолдеры: синтаксис, модификаторы, доступные данные
- Практические примеры для разных задач
Когда использовать: При создании новых сценариев или изменении существующих. Это основной гайд для работы с логикой ботов.
🔧 Master Bot — Управление тенантами
Что это: Руководство по системному боту для управления тенантами — выбор и переключение тенантов, настройка токенов, управление Tenant Storage и User Storage, синхронизация с GitHub.
Зачем нужно: После развёртывания платформы Master Bot даёт единую точку управления всеми тенантами и бота через Telegram.
Когда использовать: Для настройки и администрирования тенантов, управления конфигурациями и Storage.
⚙️ Руководство по конфигурации тенантов
Что это: Руководство по настройке тенантов (клиентов) и их Telegram-ботов.
Зачем нужно: Когда вы добавляете нового бота в систему или настраиваете нового тенанта. Здесь описано, как настроить бота (токен, команды, группы сценариев), как организовать структуру папок для сценариев и как работает синхронизация с внешним репозиторием.
Что внутри:
- Структура конфигурации тенантов
- Типы тенантов (системные и публичные)
- Синхронизация тенантов
- Конфигурация бота (tg_bot.yaml)
- Организация сценариев в папках
- Синхронизация с внешним репозиторием
Когда использовать: При добавлении нового бота или тенанта, изменении конфигурации существующих.
💾 Руководство по хранилищу атрибутов
Что это: Руководство по работе с хранилищем атрибутов тенанта (Storage) — гибкой key-value структурой для хранения настроек, лимитов и функций.
Зачем нужно: Когда вам нужно хранить настройки тенанта (лимиты пользователей, параметры функций, тарифы и т.п.) без изменения схемы базы данных. Storage позволяет гибко добавлять новые атрибуты через конфигурационные файлы.
Что внутри:
- Структура хранилища и организация файлов
- Типы значений (строки, числа, булевы)
- Создание и синхронизация атрибутов
- Примеры использования
Когда использовать: При необходимости хранить настройки тенанта, лимиты, флаги функций и другие конфигурационные данные.
🎯 Гайд по действиям системы
Что это: Полный справочник всех доступных действий в системе.
Зачем нужно: Когда вы знаете, что хотите сделать в сценарии — отправить сообщение, удалить его, обработать данные через AI — здесь найдёте нужное действие и все его параметры. Это главный справочник по действиям типа send_message, delete_message, completion, validate и другим.
Что внутри:
- Список всех доступных действий в системе
- Подробное описание параметров (входных и выходных)
- Типы данных и опциональность полей
- Практические примеры использования в YAML-конфигурации
Когда использовать: Всегда, когда создаёте или редактируете сценарии и нужно знать, какие параметры и как передать в действие.
📡 Гайд по событиям системы
Что это: Полный справочник всех полей, которые доступны в событиях.
Зачем нужно: Когда вы используете плейсхолдеры в сценариях (например, {username} или {user_id}), эти данные берутся из событий. Здесь описаны все доступные поля: ID пользователя, ID чата, текст сообщения, вложения, данные из callback-кнопок и многое другое.
Что внутри:
- Общие поля для всех событий (user_id, chat_id, message_id, username и др.)
- Поля сообщений (event_text, attachment, is_reply, is_forward)
- Поля callback-кнопок (callback_data, callback_id)
- Структура вложений (фото, документы, видео, аудио и др.)
- Примеры использования в плейсхолдерах
Когда использовать: При работе с плейсхолдерами в сценариях, когда нужно получить данные из события.
🤖 Гайд по моделям AI
Что это: Справочник по доступным моделям AI через Polza.AI и их параметрам.
Зачем нужно: Когда вы используете действие completion в сценариях и хотите выбрать подходящую модель AI. Здесь описаны все доступные модели (OpenAI, Google, Anthropic, DeepSeek и др.), их параметры, цены и возможности.
Что внутри:
- Список всех доступных моделей по провайдерам
- Поддержка параметров (JSON, Tools, temperature, max_tokens и др.)
- Цены за миллион токенов
- Описание параметров и их назначение
Когда использовать: При настройке AI-сценариев, когда нужно выбрать модель и настроить параметры генерации.
🔄 Changelog
Последние изменения, новые функции, breaking changes и миграции.
Когда использовать: Для отслеживания обновлений платформы и проверки breaking changes при обновлении.
📚 Рекомендуемый порядок изучения
- Практические примеры — создайте первого бота и изучите примеры
- Master Bot — настройте управление тенантами (если разворачиваете платформу)
- Руководство по сценариям — изучите создание сценариев
- Гайд по действиям — изучите доступные действия
- Гайд по событиям — изучите работу с плейсхолдерами
- Настройка тенантов — настройте бота
- Хранилище атрибутов — работа с данными
- Модели AI — настройка AI (опционально)
- Changelog — последние изменения (опционально)