Руководство пользователя (веб-консоль)
Версия 0.2.0 (редакция RU), проект · Скачать DOCX
Проект: документы проходят юридическую проверку. Пометки [ЗАПОЛНИТЬ] и [ПРОВЕРИТЬ] будут заполнены и сняты до подачи заявления.
1. Введение
1.1. Назначение
Руководство описывает работу пользователей в веб-консоли программного комплекса «Айтечество» (далее — консоль): регистрацию и вход, работу с моделями в чате, подключение приложений, настройку политик обработки данных, просмотр журнала запросов, управление участниками, подключениями к моделям и оплатой. Установка и администрирование инсталляции описаны в документе «Информация, необходимая для установки и эксплуатации». Руководство входит в состав документации, содержащей информацию, необходимую для эксплуатации программного комплекса (подпункт «д» пункта 11 Правил формирования и ведения единого реестра российских программ для электронных вычислительных машин и баз данных и единого реестра программ для электронных вычислительных машин и баз данных из государств — членов Евразийского экономического союза, за исключением Российской Федерации, утверждённых постановлением Правительства Российской Федерации от 16.11.2015 № 1236 (в редакции от 13.08.2026)).
1.2. Что делает программный комплекс
Сотрудники и приложения организации обращаются к языковым моделям не напрямую, а через шлюз программного комплекса. Шлюз находит в запросе персональные и другие чувствительные данные и по политике организации заменяет их условными обозначениями (например, «Иванов Пётр» → [ФИО_1]), блокирует запрос или пропускает данные без изменений. Модель получает только замаскированный текст, а в её ответе шлюз подставляет исходные значения обратно. Содержимое запросов и ответов не сохраняется: журнал содержит только сведения о том, что и как было обработано.
1.3. Роли
| Роль | Возможности |
|---|---|
| Владелец | Все действия, в том числе оплата подписки, удаление организации, передача прав владельца, назначение администраторов |
| Администратор | Всё, кроме оплаты подписки, удаления организации и передачи прав |
| ИБ-офицер | Политики, оповещения, вебхуки, аудит и расследования; просмотр провайдеров и моделей |
| Аудитор | Только просмотр: аудит, аналитика, политики, журнал запросов организации |
| Сотрудник | Чат, свои API-ключи и свои запросы |
Набор разделов консоли зависит от роли и тарифа организации.
1.4. Требования
Для работы нужен компьютер с современным веб-браузером с включёнными JavaScript и cookie и доступом к адресу консоли организации (например, https://ai.example.ru). Для двухфакторной аутентификации нужно приложение- аутентификатор на телефоне (например, Яндекс Ключ).
2. Начало работы
2.1. Регистрация
- Откройте страницу «Регистрация» и на шаге «Аккаунт» укажите адрес электронной почты и пароль.
- На шаге «Компания» укажите название компании и страну регистрации компании.
- Отметьте согласие на обработку персональных данных и принятие пользовательского соглашения и нажмите «Создать аккаунт».
- Откройте письмо и перейдите по ссылке подтверждения (ссылка действует 48 часов). После подтверждения войдите в консоль. Новой организации предоставляется пробный период.
Если вас пригласили в существующую организацию, перейдите по ссылке из письма-приглашения (действует 7 дней) и выберите «Принять приглашение» или «Создать аккаунт и присоединиться».
2.2. Вход и восстановление пароля
Откройте страницу «Вход в консоль», введите адрес электронной почты и пароль. Если включена двухфакторная аутентификация, введите код из приложения-аутентификатора или нажмите «Использовать резервный код». После пяти неверных кодов вход с кодом блокируется на 15 минут.
Если вы забыли пароль, на странице входа перейдите к восстановлению пароля и укажите адрес электронной почты: придёт ссылка для установки нового пароля (действует 1 час).
2.3. Интерфейс консоли
Слева расположено меню разделов, сгруппированных в блоки «Работа», «Контроль и безопасность», «Организация» и (для администраторов платформы) «Платформа». В меню пользователя доступны «Настройки аккаунта», «Безопасность и 152-ФЗ» и «Выйти». Интерфейс консоли реализован на русском языке; язык интерфейса (русский или английский) выбирается переключателем языка и в настройках профиля. Если вы состоите в нескольких организациях, переключайтесь между ними через «Сменить организацию»; там же можно «Создать организацию».
3. Обзор
Раздел «Обзор» открывается после входа. Блок «С чего начать» показывает шаги подключения организации: «Создайте свой API-ключ», «Подключите модель», «Примите условия моделей платформы», «Отправьте первый запрос», «Попробуйте чат». Блок «Ваши последние 7 дней» показывает число ваших запросов, замаскированных, с предупреждениями и заблокированных. Блок «Подключите приложение» содержит адрес шлюза и пример подключения.
Администраторам, ИБ-офицерам и аудиторам доступен блок «Активность организации»: запросы, доля запросов с чувствительными данными, заблокированные запросы, токены, стоимость моделей платформы, активные пользователи, график «Запросы по дням», перечень «Что найдено» по категориям и статистика по моделям. Нажатие на категорию открывает соответствующие записи журнала запросов.
4. Чат
- Откройте раздел «Чат» и выберите модель в поле «Модель» (модели платформы отмечены словом «платформа»).
- Введите сообщение и нажмите «Отправить» (Enter — отправить, Shift+Enter — новая строка). Во время ответа его можно остановить кнопкой «Остановить» и затем «Сгенерировать заново».
- Чтобы посмотреть, что получила модель, нажмите «Что увидела модель» под сообщением: отображаются замаскированный текст и «Найденные данные». Доступность этой функции настраивает администратор.
- Чтобы приложить документ, нажмите «Прикрепить файл». Текст документа извлекается и маскируется так же, как текст сообщения, сам файл модели не передаётся. Если политика организации разрешает передавать изображения или аудио без изменений, консоль предупреждает: «Вложения невозможно замаскировать: персональные данные в них уйдут провайдеру как есть.»
Если сообщение содержит данные, которые политика не разрешает отправлять, появляется сообщение «Запрос заблокирован» с причинами блокировки и идентификатором запроса; модели ничего не отправляется.
Диалоги хранятся только в вашем браузере, а не на серверах. Меню истории позволяет «Выгрузить историю (JSON)», «Загрузить историю…», удалить диалог или «Очистить всю историю».
5. Песочница
Раздел «Песочница» показывает работу маскирования без отправки модели. Введите текст и нажмите «Замаскировать»: рядом с исходным текстом отображается «Что получила бы модель». Блок «Восстановление» подставляет исходные значения в текст с условными обозначениями. Кнопка «Проверить с моделью» отправляет замаскированный текст модели. Запросы из песочницы учитываются в месячной квоте.
6. API-ключи и подключение приложений
6.1. Создание ключа
- Откройте раздел «API-ключи» и нажмите «Создать ключ».
- Укажите «Название» (например, «CRM-интеграция»). Для систем и интеграций отметьте «Сервисный ключ» (доступно администраторам): он не привязан к сотруднику. Личный ключ действует от вашего имени.
- При необходимости укажите «Группа для политик», «Лимит запросов в минуту» (не больше лимита тарифа), «Срок действия» и «Доступные модели» (ничего не выбрано — доступны все модели организации).
- Нажмите «Создать ключ» и скопируйте секрет: он показывается один раз и хранится в программном комплексе только в виде хеша. Храните ключ в менеджере секретов или переменных окружения.
Ключ отзывается кнопкой «Отозвать»: запросы с ним сразу перестают проходить через шлюз. Отменить отзыв нельзя — для восстановления доступа создайте новый ключ.
6.2. Подключение приложения
Шлюз поддерживает OpenAI-совместимый API: в приложении достаточно указать базовый адрес шлюза с путём /v1, ключ и псевдоним модели, доступной организации (перечень — в разделе «Провайдеры и модели» или по запросу GET /v1/models). Пример запроса:
curl https://gw.example.ru/v1/chat/completions \
-H "Authorization: Bearer $AITECH_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "yandexgpt",
"messages": [{"role": "user",
"content": "Составь письмо для Иванова П. С."}]}'
Для потокового ответа добавьте в запрос "stream": true. Ошибки возвращаются с понятным сообщением, например «Неверный или отозванный API-ключ.», «Запрос заблокирован политикой защиты данных.», «Слишком много запросов, повторите позже.», «Исчерпана месячная квота запросов.».
7. Журнал запросов
Раздел «Журнал запросов» содержит записи о каждом запросе через шлюз: время, источник, модель, пользователь или ключ, решение шлюза, найденные категории данных и применённые действия. Содержимое запросов в журнале нет. Сотрудник видит свои запросы, администраторы, ИБ-офицеры и аудиторы — запросы всей организации.
Используйте фильтры «Решение», «Категория», «Источник», «Модель», «Пользователь», «API-ключ». Нажмите на запись, чтобы открыть подробности. Кнопка «Выгрузить» сохраняет отобранные записи в формате «CSV (таблица)» или «JSONL (SIEM, скрипты)». Срок хранения журнала задаётся в разделе «Настройки».
8. Расследования
Раздел «Расследования» (ИБ-офицеры и администраторы, если функция входит в тариф) позволяет выполнить «Поиск по значению»: введите значение (например, номер паспорта), и консоль покажет запросы, в которых оно встречалось. Значения в журнале хранятся только в виде необратимых ключевых хешей; их сохранение включается параметром «Отпечатки для расследований» в разделе «Настройки».
9. Политики
9.1. Действующие правила обработки
Раздел «Политики» показывает перечень политик организации и блок «Ваша защита сейчас» — итоговые действия по категориям с учётом всех применимых политик.
9.2. Создание и изменение политики
- Нажмите «Новая политика» и выберите шаблон или начните с пустой политики.
- На вкладке «Общее» укажите «Название» и в блоке «Кому применяется» — вся организация или выбранные группы, участники и API-ключи (политика по умолчанию всегда действует для всех); при необходимости задайте «Период действия».
- На вкладке «Категории» выберите действие для каждой категории данных: пропустить, предупредить, обобщить, псевдонимизировать или блокировать.
- На вкладках «Белый список», «Стоп-список», «Шаблоны» и «Словари» задайте значения, которые не нужно маскировать, запрещённые слова и собственные правила обнаружения.
- На вкладке «Настройки» задайте обработку вложений, поведение при недоступности распознавания имён и другие параметры.
- В блоке «Проверка» введите «Пример текста»: проверка запускается автоматически после каждого изменения и показывает найденные данные, что получит модель и был бы ли запрос заблокирован. Сохраните политику. Изменения применяются к новым запросам в течение нескольких секунд.
Если к запросу применяется несколько политик, по каждой категории действует самое строгое действие. На вкладке «Версии» можно сравнить версии политики и восстановить предыдущую.
10. Аудит
Раздел «Аудит» показывает, кто и что менял в организации: политики, ключи, участников, подключения, настройки, выгрузки журнала.
11. Оповещения и вебхуки
На вкладке «Правила» раздела «Оповещения» нажмите «Создать правило», выберите событие (заблокированные, замаскированные или отмеченные предупреждением запросы), категории, порог за период, получателей (сотрудники, роли, вебхуки) и интервал между повторными оповещениями.
На вкладке «Вебхуки» нажмите «Добавить вебхук», укажите адрес HTTPS, формат (JSON или CEF) и события. Кнопка «Проверить» отправляет тестовое событие. Подпись запросов вебхука проверяется по секрету, показанному при создании.
12. Участники и группы
В разделе «Участники» на вкладке «Участники» отображаются сотрудники организации и их роли; администратор меняет роль или удаляет участника. На вкладке «Приглашения» нажмите «Пригласить», укажите адрес электронной почты и роль. Пригласить администратора может только владелец. Число участников ограничено местами тарифа.
На вкладке «Группы» создайте группы сотрудников: политики можно применять к группам. Владелец может передать права владельца другому участнику («Передать права владельца…»).
13. Провайдеры и модели
13.1. Модели платформы
Если тариф включает модели платформы, владелец или администратор знакомится с условиями их использования, отмечает согласие и нажимает «Включить платформенные модели». Использование оплачивается с баланса организации по ценам за миллион токенов. Отключить модели платформы можно кнопкой «Отключить».
13.2. Собственный провайдер
- Нажмите «Подключить провайдера» и выберите провайдера: YandexGPT, GigaChat или OpenAI-совместимый API (модель, развёрнутая в вашей инфраструктуре).
- Укажите «Название», при необходимости «Адрес API (base URL)», и учётные данные: для YandexGPT — API-ключ и идентификатор каталога, для GigaChat — ключ авторизации и область доступа, для OpenAI-совместимого API — адрес эндпоинта, ключ и дополнительные заголовки (до 10).
- Для OpenAI-совместимого API подтвердите, что эндпоинт находится под контролем вашей организации или принадлежит провайдеру, законно обрабатывающему данные («Подтверждение для региона РФ»).
- Нажмите «Подключить», затем «Проверить». Учётные данные хранятся в зашифрованном виде и не показываются повторно.
Адреса иностранных сервисов искусственного интеллекта подключить нельзя: консоль отклоняет такой адрес.
13.3. Маршруты моделей
Нажмите «Добавить маршрут» и укажите псевдоним (имя модели, которое приложения передают в поле model), подключение и модель провайдера. Маршрут организации с тем же псевдонимом, что у модели платформы, заменяет её для организации.
14. Оплата
Раздел «Оплата» доступен владельцу и администраторам. Здесь выбираются «Тарифы», пополняется «Баланс» (кнопка «Пополнить»), настраиваются «Способы оплаты» и просматривается «История» («Платежи», «Счета»). Оплата выполняется банковской картой, через СБП, SberPay или по счёту для юридического лица (счёт в PDF скачивается из истории). Для автопродления отметьте «Сохранить карту для автопродления». Владелец может «Отменить подписку» или «Возобновить подписку». При неоплаченной или истёкшей подписке консоль показывает предупреждение, а шлюз перестаёт принимать запросы.
15. Настройки
| Вкладка | Что настраивается |
|---|---|
| Организация | «Профиль и реквизиты» (кнопка «Заполнить по ИНН» заполняет реквизиты автоматически); «Параметры шлюза» (изменяют владелец и администраторы): «Хранение журнала запросов, дней», «Отпечатки для расследований», «Веб-чат и песочница», «Что увидела модель» в чате, «Модель по умолчанию в чате», «Язык заглушек», «Псевдонимы в эмбеддингах», «Разрешённые IP-адреса»; «Удаление организации» (только владелец) |
| Безопасность | «Двухфакторная аутентификация» (включение по QR-коду, резервные коды), «Активные сеансы» (завершение сеансов на других устройствах) |
| Аккаунт | «Профиль» (имя, язык консоли и писем), «Пароль» (после смены пароля другие сеансы завершаются), «Мои данные (152-ФЗ)» — выгрузка персональных данных (до 10 рабочих дней) и удаление аккаунта (до 30 дней) |
Уменьшение срока хранения журнала вступает в силу через 7 дней; владелец и ИБ-офицеры получают уведомление. После смены языка заглушек или режима псевдонимов в эмбеддингах векторные представления изменятся — переиндексируйте векторные базы.
В поле «Разрешённые IP-адреса» укажите по одному IP-адресу или подсети (CIDR, например 203.0.113.0/24) в строке, всего не более 100. Если перечень задан, шлюз принимает запросы только с этих адресов — и с API-ключами, и из консоли (чат, песочница, проверка политик); пустое поле — любые адреса. Прежде чем сохранить перечень, убедитесь, что в него входит и ваш собственный адрес. Параметры шлюза применяются к запросам в течение нескольких секунд. При удалении организации подписка отменяется, API-ключи и сохранённые карты отзываются, через 30 дней данные удаляются; платёжные документы хранятся 5 лет.
16. Типичные сообщения
| Сообщение | Что делать |
|---|---|
| «Запрос заблокирован политикой защиты данных.» | Уберите из запроса данные, указанные в причинах блокировки, или обратитесь к ИБ-офицеру для изменения политики |
| «Неверный или отозванный API-ключ.» | Проверьте ключ; при необходимости создайте новый |
| «Модель недоступна для этого ключа или тарифа.» | Выберите модель из перечня доступных или измените ключ |
| «Слишком много запросов, повторите позже.» | Уменьшите частоту запросов или увеличьте лимит ключа |
| «Исчерпана месячная квота запросов.» | Дождитесь нового периода или смените тариф |
| «Недостаточно средств на балансе для платформенных моделей.» | Пополните баланс в разделе «Оплата» |
| «Подписка организации неактивна.» | Оплатите подписку в разделе «Оплата» |
| «Запросы с этого IP-адреса запрещены.» | Ваш адрес не входит в «Разрешённые IP-адреса» организации; обратитесь к владельцу или администратору |
| «Сервис распознавания имён недоступен, повторите позже.» | Повторите запрос; при повторении обратитесь в техническую поддержку |
| «Не удалось извлечь текст из вложенного документа.» | Проверьте, что документ не зашифрован и содержит текст, а не скан |