ИНСТРУКЦИЯ ПО ЭКСПЛУАТАЦИИ
ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ «АССИСТЕНТ ПРО»
Документ: Руководство пользователя и администратора
Правообладатель: ИП Белоусов Дмитрий Владимирович (ИНН 665206580503)
Дата: 28 апреля 2026 г.
Документ предназначен для пользователей и администраторов программного обеспечения «Ассистент ПРО». Содержит сведения, необходимые для подготовки рабочего места, эксплуатации функций системы и действий в нештатных ситуациях.

ВВЕДЕНИЕ
Область применения
Настоящая инструкция распространяется на штатное использование программного обеспечения «Ассистент ПРО» — программного комплекса для построения интеллектуальных диалоговых ассистентов и баз знаний на основе технологий RAG и больших языковых моделей. Документ применим как к локальной (on-premise) установке, так и к развёртыванию в собственной облачной инфраструктуре заказчика.
Уровень подготовки персонала
Документ рассчитан на следующие категории пользователей:

• Конечные пользователи — владение веб-браузером, навыки переписки в мессенджерах. Специальной подготовки не требуется.
• Администраторы проекта — навыки работы с веб-интерфейсами, представление о REST API; не требуется навыков программирования.
• Операторы — владение веб-интерфейсом, основы корпоративных коммуникаций.
• Системные администраторы — опыт работы с Linux, Docker, утилитами командной строки.

Условные обозначения

1. ПОДГОТОВКА К РАБОТЕ
1.1. Предварительные требования к рабочему месту
Для выполнения операций, описанных в настоящей инструкции, необходимо:

• Современный веб-браузер: Mozilla Firefox 115+, Google Chrome / Chromium 120+, Яндекс.Браузер последних версий, Microsoft Edge 120+, Safari 17+.
• Сетевой доступ к адресу административной панели и (при необходимости) к публичному URL веб-виджета.
• Учётная запись в системе с соответствующей ролью (выдаётся системным администратором заказчика).

1.2. Запуск системы
Запуск экземпляра ПО осуществляется системным администратором сервера через консоль управления Docker:
sudo docker compose up -d
После успешного запуска все компоненты системы (FastAPI-приложение, MongoDB, Redis, Qdrant, Celery workers, опционально Ollama и клиенты ботов) становятся доступны через единый веб-интерфейс.
Проверить состояние сервисов можно командой:
sudo docker compose ps
1.3. Вход в систему (административная панель)

1. Откройте веб-браузер.
2. Введите в адресной строке URL панели управления, например: https://<host>:18080/admin/ (для локальной установки — http://localhost:18080/admin/).
3. На экран будет выведена форма авторизации.
4. Введите имя пользователя в поле «Логин».
5. Введите пароль в поле «Пароль».
6. Нажмите кнопку «Войти».

При успешной аутентификации система создаёт сессию и перенаправляет на главную страницу административной панели — раздел «Обзор».
1.4. Завершение сеанса
Для безопасного выхода из системы необходимо нажать кнопку «Выход» (значок входа/выхода в шапке интерфейса). Сессия будет завершена немедленно. Также сессия завершается автоматически при истечении таймаута (30 минут бездействия по умолчанию).

2. ОПИСАНИЕ РАБОТЫ
2.1. Главная панель управления
После входа в систему пользователь попадает в основное окно административной панели. Главная панель управления состоит из боковой навигации и рабочей области и включает следующие разделы:
2.2. Создание и настройка проекта

1. Перейдите в раздел «Проекты» (Projects).
2. Нажмите кнопку «Создать проект» (Create project).
3. В открывшейся форме укажите:

• Техническое имя проекта (латиница, без пробелов; пример: support_main).
• Отображаемое название (кириллица допустима; пример: Поддержка пользователей).
• Домен (опционально, для виджета).
• Системный промпт (инструкция для LLM, определяющая стиль и ограничения ответов).
• Параметры модели: имя LLM (например, Vikhr-YandexGPT-5-Lite-8B-it), температура (0,0–1,0), максимальное число токенов в ответе.
• Параметры RAG: количество фрагментов в контексте, размер фрагмента, веса dense/BM25.

1. Нажмите «Сохранить». Проект становится доступным в общем списке.

2.3. Наполнение базы знаний
2.3.1. Загрузка документов

1. Перейдите в раздел «База знаний» (Knowledge) и убедитесь, что выбран целевой проект (выпадающий список в шапке).
2. Нажмите «Загрузить документ» (Upload document).
3. Выберите файл на локальном диске. Поддерживаемые форматы: PDF, DOCX, DOC, TXT, XLSX, XLS, HTML, JSON, CSV, XML. Максимальный размер по умолчанию — 50 МБ.
4. Укажите наименование документа в поле «Заголовок».
5. Заполните поля «Описание» и «Категория» (опционально). При желании активируйте опцию «Автоматически сформировать описание» — система создаст описание средствами LLM.
6. Нажмите «Сохранить». Документ будет загружен, его текст извлечён, сегментирован и проиндексирован в векторном хранилище.
7. После завершения индексации документ появляется в общем списке с пометкой «Индексирован».

2.3.2. Управление парами «вопрос — ответ» (Q&A)

1. Перейдите во вкладку «Q&A» в разделе «База знаний».
2. Нажмите «Добавить пару».
3. Заполните поля:

• Вопрос — формулировка, по которой должен срабатывать каноничный ответ.
• Ответ — точный ответ, который должен быть выдан пользователю.
• Дополнительные формулировки вопроса — синонимичные варианты для повышения охвата.

1. Сохраните пару. Q&A учитывается с приоритетом, превышающим обычные результаты RAG-поиска.

2.3.3. Удаление и переиндексация
Для удаления документа нажмите значок корзины напротив записи и подтвердите действие. Связанные векторы автоматически удаляются из Qdrant.
Для полной переиндексации всей базы знаний используйте кнопку «Переиндексировать» (Reindex) в верхней панели раздела. Операция может занять от нескольких минут до часов в зависимости от объёма данных.
2.4. Индексация веб-сайта (краулер)

1. Перейдите в раздел «Краулер» (Crawler).
2. Введите начальный адрес сайта (например, https://mmvs.ru).
3. Задайте параметры обхода:

• Максимальная глубина (Depth) — количество уровней переходов от стартовой страницы (рекомендуется 3–5).
• Максимальное число страниц (Page limit) — общий лимит обработанных URL.
• Список разрешённых доменов (Allowed domains) — ограничение зоны обхода.
• Включить рендеринг JavaScript — для одностраничных приложений (SPA), требует ресурсов.

1. Нажмите «Запустить» (Start). На странице отобразится индикатор прогресса (URL обработано / в очереди / ошибки).
2. По завершении обхода контент автоматически индексируется в базе знаний выбранного проекта.

Для остановки активного обхода используйте кнопку «Остановить» (Stop). Текущее состояние сохраняется, обход можно возобновить позднее.
2.5. Подключение каналов связи
2.5.1. Telegram-бот

1. Получите токен бота у @BotFather в Telegram (команда /newbot).
2. В разделе «Боты» выберите проект и вкладку «Telegram».
3. Вставьте полученный токен в поле «Bot Token».
4. Нажмите «Сохранить», затем «Запустить». Сервис telegram-bot автоматически подключится.
5. Найдите вашего бота в Telegram, нажмите /start. Любое сообщение будет обрабатываться через RAG-конвейер выбранного проекта.

2.5.2. ВКонтакте

1. Создайте сообщество в ВКонтакте, в настройках сообщения → API → создайте ключ доступа с правами «Сообщения сообщества».
2. В разделе «Боты» выберите вкладку «ВКонтакте» и вставьте полученный токен.
3. Включите длинный опрос (Long Poll) в настройках сообщества ВКонтакте.
4. Сохраните и нажмите «Запустить».

2.5.3. Веб-виджет
Виджет встраивается на любой сайт через JavaScript-код, доступный во вкладке «Виджет» проекта. Скопируйте сниппет вида:
<script src="https://<host>/widget/loader.js"
        data-project="support_main"></script>
Разместите его перед закрывающим тегом </body> на нужных страницах сайта.
2.6. Мониторинг и статистика
2.6.1. Раздел «Обзор»
Отображает текущее состояние всех сервисов системы (MongoDB, Redis, Qdrant, Ollama), потребление CPU и RAM, число активных диалогов и задач Celery.
2.6.2. Раздел «Статистика»
Содержит:

• Количество запросов за период (день / неделя / месяц).
• Среднее время ответа.
• Долю успешных и неотвеченных запросов.
• Топ источников знаний, попавших в ответы.
• Кнопку экспорта данных в формат CSV.

2.6.3. Раздел «Журналы»
Просмотр последних N (по умолчанию 200) структурированных событий системы. Поддерживается фильтрация по уровню (DEBUG / INFO / WARNING / ERROR), модулю и временному окну.
2.7. Резервное копирование

1. Перейдите в раздел «Настройки» → «Резервные копии» (Backups).
2. Включите автоматическое расписание (например, ежедневно в 03:00) — заполните поля «Час», «Минута», «Часовой пояс».
3. При необходимости укажите параметры Яндекс.Диска (токен, целевая папка) для удалённого хранения.
4. Нажмите «Сохранить настройки».

Для создания резервной копии вручную нажмите «Создать сейчас» (Run now). По завершении в журнале появится запись с указанием размера, времени и расположения архива.
Для восстановления — нажмите «Восстановить из архива» (Restore), выберите архив и подтвердите операцию. ⚠ Восстановление полностью замещает текущие данные — перед запуском убедитесь, что это действительно требуется.

3. ВЗАИМОДЕЙСТВИЕ КОНЕЧНОГО ПОЛЬЗОВАТЕЛЯ
3.1. Чат-виджет на сайте

1. Откройте сайт, на котором установлен виджет «Ассистент ПРО».
2. Нажмите кнопку с иконкой помощника в правом нижнем углу страницы.
3. Введите вопрос в поле ввода и отправьте.
4. Ответ ассистента отображается в реальном времени, токен за токеном (стриминг). По завершении ниже ответа выводятся ссылки на источники (если доступны).
5. Поставьте оценку ответу (👍/👎) — это улучшит качество в дальнейшем.

Если ответ не устраивает или не получен, можно нажать «Связаться с оператором» — обращение будет передано в очередь раздела «Операторы».
3.2. Telegram-бот

1. Откройте Telegram и найдите бота по имени, указанному при настройке (например, @your_assistant_bot).
2. Отправьте команду /start.
3. Введите вопрос в свободной форме.
4. Получите ответ. Команды управления:

• /help — справка по доступным командам.
• /reset — сбросить контекст текущего диалога.
• /operator — переадресовать обращение оператору.

3.3. Голосовой режим (если активирован)

1. В виджете нажмите иконку микрофона.
2. Дайте разрешение браузеру на использование микрофона (всплывающий запрос).
3. Произнесите вопрос.
4. Система распознает речь, обработает запрос и при необходимости озвучит ответ.

4. РОЛЬ ОПЕРАТОРА
4.1. Очередь обращений
Оператор работает с переадресованными обращениями в разделе «Операторы». Очередь содержит:

• Идентификатор сессии и пользователя.
• Канал поступления (виджет / Telegram / ВК / MAX / почта).
• Историю последних N сообщений.
• Время поступления и приоритет.

4.2. Обработка обращения

1. Откройте обращение в очереди.
2. Ознакомьтесь с историей диалога.
3. Введите ответ в поле «Сообщение оператора» и нажмите «Отправить». Ответ доставляется пользователю в исходный канал.
4. При необходимости пометьте обращение «Решено» (Closed) или передайте другому оператору («Передать»).

4.3. Журналы
Все действия операторов фиксируются в системных журналах. Просмотр доступен администратору в разделе «Журналы».

5. АВАРИЙНЫЕ СИТУАЦИИ И УСТРАНЕНИЕ НЕИСПРАВНОСТЕЙ
5.1. Типовые ситуации и действия
5.2. Контакт с технической поддержкой
При невозможности устранить ситуацию собственными силами обратитесь в службу технической поддержки правообладателя:

• Электронная почта: rtfdeamon@mail.ru
• Адрес: 620078, Свердловская область, г. Екатеринбург, ул. Комсомольская, стр. 37, помещ. 406
• Режим работы: понедельник–пятница, 09:00–18:00 (Мск).

При обращении укажите: версию ПО, дату инцидента, описание проблемы, ожидаемое и фактическое поведение, выдержки из журналов (раздел «Журналы» → экспорт CSV) и снимки экрана при возможности.
5.3. Рекомендации по штатной эксплуатации

• Контролируйте свободное место на сервере (мониторить раздел «Обзор»).
• Регулярно проверяйте резервные копии и время последнего успешного бэкапа.
• Не реже одного раза в месяц анализируйте раздел «Неотвеченные» и пополняйте базу знаний.
• Не передавайте учётные данные администратора третьим лицам; для каждого сотрудника заводите отдельную учётную запись.
• При обновлении версии ПО — предварительно создавайте резервную копию.

Правообладатель:  ИП Белоусов Дмитрий Владимирович
Контакт службы поддержки:  rtfdeamon@mail.ru