Техническая документация
Документы/03Руководство по эксплуатации

Руководство по эксплуатации программного обеспечения «Rowux»

Документ описывает порядок использования ПО «Rowux» пользователем и администратором. Комплекс разворачивается на инфраструктуре организации средствами Docker Compose (запуск всего комплекса — командой docker compose up -d), после чего подсистемы становятся доступны пользователям через веб-браузер.


#1. Роли

Роль Возможности
Пользователь Диалог с языковыми моделями, работа с базами знаний, запуск ИИ-сценариев и аналитических задач, просмотр результатов.
Администратор Управление пользователями и доступом, настройка моделей и подключений, управление базами знаний и сценариями, наблюдение за состоянием системы.

Разграничение доступа обеспечивается единой системой аутентификации (SSO): пользователь входит один раз и получает доступ ко всем подсистемам в соответствии со своей ролью.


#2. Начало работы пользователя

  1. Открыть портал платформы в браузере по адресу, предоставленному администратором.
  2. Пройти аутентификацию (единый вход).
  3. Выбрать нужный раздел: чат-интерфейс, базы знаний, конструктор сценариев или аналитика.

#3. Работа с чат-интерфейсом

  • Создать новый диалог, при необходимости выбрать языковую модель из доступных.
  • Ввести запрос; ответ модели отображается в реальном времени.
  • Диалоги сохраняются в истории, доступны для продолжения и организации.
  • Результаты диалога можно экспортировать в текстовые форматы.

#4. Работа с базами знаний (RAG)

  • Создание базы знаний. Создать коллекцию, загрузить документы либо подключить внешний источник (объектное S3-совместимое хранилище) с указанием параметров подключения.
  • Синхронизация. Внешний источник синхронизируется инкрементально: переиндексируются только новые и изменённые файлы, удалённые — исключаются. Синхронизацию можно запустить вручную; перед ответом на запрос актуальность проверяется автоматически.
  • Использование в диалоге. Прикрепить коллекцию к диалогу — модель отвечает с опорой на найденные фрагменты. При включённом обезличивании персональные данные из фрагментов удаляются перед передачей модели.

#5. Работа с конструктором сценариев и агентов

  • Создание сценария. Собрать обработчик или агента из готовых блоков на визуальном полотне.
  • Запуск и наблюдение. Запустить сценарий; ход выполнения отображается в реальном времени. Навигация по интерфейсу, переключение вкладок и перезагрузка страницы не прерывают выполнение — при возврате интерфейс переподключается к выполняющейся задаче. Выполнение можно остановить кнопкой остановки.
  • Публикация. Готовый сценарий публикуется как инструмент для чат-интерфейса или как внешняя интеграция (например, чат-бот в мессенджере).

#6. Работа с аналитическим агентом

  • Сформулировать задачу на естественном языке (например, «построй динамику показателя за год и найди аномалии»).
  • Агент самостоятельно планирует решение, при необходимости устанавливает библиотеки, обращается к данным (к базам данных — только на чтение), выполняет расчёты и строит визуализации.
  • Результат возвращается в виде краткого резюме и ссылок на артефакты (отчёт с воспроизводимым окружением, графики, при необходимости — опубликованный BI-дашборд).
  • Весь автогенерируемый код исполняется в изолированной одноразовой песочнице без доступа к сети и секретам.

Порядок подключения корпоративного хранилища и BI-системы заказчика к аналитическому агенту описан в docs/client-bi-integration.md.


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

#7.1. Управление пользователями и доступом

Учётные записи и роли создаются и управляются в административной консоли системы единого входа (realm rowux). Первичное создание пользователей обязательно — из коробки учётные записи отсутствуют.

#7.2. Управление моделями и подключениями

  • Поставщики и модели языковых моделей настраиваются через единый шлюз доступа к моделям и переменные окружения.
  • Подключения аналитического агента к корпоративным базам данных (роли только на чтение) и к BI-системе задаются в конфигурации соответствующего сервиса.

#7.3. Управление базами знаний и сценариями

Администратор управляет общими базами знаний, стартовыми сценариями и доступом к ним через интерфейсы соответствующих подсистем.

#7.4. Наблюдение за состоянием

Состояние сервисов контролируется штатными средствами оркестрации (docker compose ps, журналы docker compose logs) и подсистемой мониторинга (сбор метрик и информационные панели). Проверка работоспособности сервисов доступна через их служебные endpoint-ы проверки состояния.


#8. Резервное копирование и восстановление

Состояние платформы хранится в томах данных (базы данных подсистем, объектное и векторное хранилища). Резервное копирование выполняется штатными средствами резервного копирования томов Docker и/или соответствующих СУБД. Восстановление — разворачиванием томов из резервной копии перед запуском комплекса.


#9. Типовые эксплуатационные действия

Действие Способ
Запуск комплекса docker compose up -d
Остановка (данные сохраняются) docker compose down
Просмотр состояния сервисов docker compose ps
Просмотр журналов сервиса docker compose logs <сервис>
Обновление версии обновить код, затем docker compose up -d --build
Полная очистка состояния docker compose down -v