Все документы
Документация ПО

Руководство пользователя Nikta AEGA

Ниже — текст для чтения. Полное оформление, таблицы и иллюстрации сохранены в оригинальном файле.

РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ ПО «Nikta AEGA»

1. Назначение программного обеспечения

Программное обеспечение Nikta AEGA предназначено для анализа представления информации о брендах, организациях, товарах и услугах в ответах современных систем искусственного интеллекта.

Программное обеспечение предоставляет пользователю веб-интерфейс для формирования и запуска сканирования. В процессе сканирования программное обеспечение направляет сформированные запросы к подключённым моделям искусственного интеллекта посредством программных интерфейсов API и отображает полученные результаты в личном кабинете пользователя.

Программное обеспечение может использовать различные модели искусственного интеллекта, доступные через совместимые программные интерфейсы API. Перечень используемых моделей определяется настройками программного обеспечения.

Основные функции программного обеспечения:

регистрация и авторизация пользователей;

управление учётной записью пользователя;

запуск сканирования;

формирование запросов к моделям искусственного интеллекта;

параллельная отправка запросов к нескольким подключённым моделям;

получение и отображение результатов обработки запросов;

просмотр результатов проведённого сканирования.

2. Требования к рабочему месту пользователя

Для работы с программным обеспечением пользователю требуется:

персональный компьютер или иное устройство с доступом к сети Интернет;

современный веб-браузер с поддержкой JavaScript;

стабильное подключение к сети Интернет.

Специальная установка клиентского программного обеспечения на рабочее место пользователя не требуется. Работа осуществляется через веб-интерфейс программного обеспечения.

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

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

3.1. Открытие программного обеспечения

Для начала работы необходимо открыть веб-интерфейс программного обеспечения в браузере.

После открытия главной страницы пользователю доступны информационные элементы программного обеспечения и переход к процедуре регистрации или авторизации.

3.2. Регистрация пользователя

Для создания учётной записи необходимо:

Открыть страницу регистрации.

Указать адрес электронной почты.

Задать пароль.

Подтвердить создание учётной записи.

После успешной регистрации выполнить вход в систему.

Учётные данные используются для последующей авторизации пользователя и доступа к функциям личного кабинета.

3.3. Авторизация

Для входа в программное обеспечение необходимо:

Открыть страницу авторизации.

Ввести адрес электронной почты, указанный при регистрации.

Ввести пароль.

Подтвердить вход.

После успешной авторизации пользователь получает доступ к личному кабинету и функциям сканирования.

Доступ к странице сканирования предоставляется только авторизованным пользователям.

4. Личный кабинет

После авторизации пользователю доступен личный кабинет программного обеспечения.

Основным функциональным разделом личного кабинета является раздел сканирования.

В личном кабинете пользователь может перейти к запуску сканирования и ознакомиться с результатами обработки сформированных запросов.

5. Проведение сканирования

5.1. Назначение сканирования

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

В рамках одного сканирования программное обеспечение выполняет обработку запросов с использованием нескольких доступных моделей.

Запросы могут обрабатываться параллельно, что позволяет получать результаты от нескольких моделей в рамках одной операции.

5.2. Запуск сканирования

Для выполнения сканирования необходимо:

Авторизоваться в программном обеспечении.

Перейти в раздел сканирования.

Указать необходимые данные для проведения анализа.

Запустить сканирование.

Дождаться завершения обработки запросов.

После запуска программное обеспечение формирует необходимые запросы и передаёт их подключённым моделям искусственного интеллекта посредством API.

5.3. Получение результатов

После обработки запросов результаты возвращаются в программное обеспечение и отображаются пользователю в интерфейсе раздела сканирования.

Результаты формируются на основании ответов подключённых моделей искусственного интеллекта.

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

6. Работа с программными интерфейсами API

Программное обеспечение поддерживает взаимодействие с моделями искусственного интеллекта посредством программных интерфейсов API.

Подключение выполняется с использованием соответствующих параметров доступа и настроек API.

При необходимости администратор программного обеспечения может изменить состав подключённых моделей и параметры их использования в соответствии с возможностями используемых API.

Программное обеспечение не ограничивается использованием одной конкретной модели и предусматривает возможность работы с различными совместимыми API.

7. Завершение работы

Для завершения работы с программным обеспечением пользователь может выйти из учётной записи.

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

8. Безопасность

Для доступа к функциям личного кабинета используется механизм авторизации пользователя.

Доступ к разделу сканирования предоставляется только после успешной авторизации.

Пользователь должен:

не передавать свои учётные данные третьим лицам;

использовать пароль достаточной сложности;

не сохранять пароль в общедоступных местах;

завершать пользовательский сеанс после окончания работы на общем компьютере.

9. Установка и техническое развёртывание

Развёртывание программного обеспечения выполняется на серверном оборудовании или вычислительной инфраструктуре, предназначенной для его эксплуатации.

Для запуска программного обеспечения используются следующие основные программные компоненты:

Next.js;

TypeScript;

Tailwind CSS;

shadcn/ui;

Auth.js;

Prisma;

SQLite;

bcryptjs;

Zod.

Указанные программные компоненты используются в качестве программной основы и вспомогательных средств функционирования системы.

Программное обеспечение предусматривает возможность настройки параметров подключения к моделям искусственного интеллекта через API.

10. Запуск программного обеспечения

После выполнения первоначальной настройки и установки необходимых компонентов программное обеспечение запускается на сервере.

После запуска веб-интерфейс программного обеспечения становится доступен пользователям через веб-браузер.

При стандартной конфигурации веб-интерфейс доступен по адресу, заданному параметрами развёртывания программного обеспечения.

11. Основные разделы программного обеспечения

Программное обеспечение включает следующие основные разделы:

Раздел

Назначение

Главная страница

Предоставление общей информации о программном обеспечении и переход к основным функциям

Регистрация

Создание учётной записи пользователя

Авторизация

Вход зарегистрированного пользователя

Личный кабинет

Доступ к функциям пользователя

Сканирование

Формирование и выполнение запросов к подключённым моделям искусственного интеллекта и просмотр результатов

12. Завершение сеанса работы

По окончании работы рекомендуется выйти из учётной записи с помощью соответствующей функции интерфейса.

После выхода пользователь при необходимости может повторно авторизоваться с использованием своих учётных данных.

13. Устранение основных проблем

Не удаётся войти в систему

Необходимо проверить:

правильность введённого адреса электронной почты;

правильность введённого пароля;

наличие подключения к сети Интернет.

При сохранении проблемы необходимо обратиться к администратору программного обеспечения.

Не запускается сканирование

Необходимо проверить:

выполнена ли авторизация;

доступен ли сервер программного обеспечения;

настроено ли подключение к необходимому API;

доступно ли подключение к сети Интернет.

Результаты сканирования не отображаются

Необходимо дождаться завершения обработки запросов и проверить состояние подключения к серверу.

Если проблема сохраняется, необходимо обратиться к администратору программного обеспечения.

14. Ограничения использования

Результаты, получаемые в процессе сканирования, зависят от ответов подключённых моделей искусственного интеллекта.

Программное обеспечение отображает результаты обработки запросов, полученные от подключённых моделей, и не гарантирует идентичность результатов при повторном выполнении одного и того же запроса.

Состав доступных моделей и возможности их использования зависят от настроек подключённых программных интерфейсов API.

15. Сведения о программной архитектуре

Программное обеспечение реализовано как веб-приложение.

Пользователь взаимодействует с системой посредством веб-интерфейса. Серверная часть обеспечивает обработку пользовательских запросов, авторизацию, взаимодействие с базой данных и подключёнными API моделей искусственного интеллекта.

Для хранения данных используется реляционная база данных SQLite с использованием программного компонента Prisma.

Для валидации данных используются соответствующие программные механизмы проверки входных параметров.

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

16. Заключение

Программное обеспечение Nikta AEGA предоставляет пользователю веб-интерфейс для проведения анализа ответов моделей искусственного интеллекта.

Основной сценарий работы включает регистрацию пользователя, авторизацию, переход в личный кабинет, запуск сканирования, обработку запросов через подключённые API и просмотр полученных результатов.

Программное обеспечение поддерживает работу с различными моделями искусственного интеллекта и не привязано к одной конкретной модели, что позволяет использовать различные совместимые программные интерфейсы API и изменять состав используемых моделей в зависимости от конфигурации системы.

Все документы