# О проекте

AI-помощник для вузов – первый интеллектуальный ассистент на основе GigaChat, предназначенный для ответа на вопросы всех участников высшей школы: 
- абитуриентов
- студентов
- преподавателей 
- администрации  

## Зачем этот гайд?

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

Здесь собрана вся информация о текущих задачах проекта, в которых Вы можете принять участие. На данный момент существует 2 основных направления задач:

- Разметка
  - Подготовка источников данных
  - Определение релевантных данных
  - Оценка качества парсинга данных
  - Оценка качества работы AI-помощника
- Разработка
  - Разработка парсеров для сайтов
  - Реализация ботов на основе API  

Все задачи разметки выполняются на платформе TagMe, а задачи разработки – в приватном репозитории нашей организации на платформе GitHub.

## Обратная связь
В ходе подключения вуза к проекту после завершения каждого из этапов требуется уведомить об этом команду проекта через поддержку в Telegram-боте: {tg}`giga_education_support_bot`. После подтверждения со стороны поддержки можно переходить к следующему этапу. В этом же Telegram-боте можно задавать вопросы, связанные с возникшими трудностями в ходе выполнения задач разметки и разработки.

## Краткий RoadMap по подключению вуза

| № этапа        | Описание этапа | Исполнитель     | Платформа                          |
|-----------------|--------|-------------------------|---------------------------------|
| 1  |  Связаться для получения уникального токена вуза с технической поддержкой проекта | Представитель вуза | Telegram-бот поддержки |
| 2 | Сформировать команду вуза для задач разметки и/или разработки | Представитель вуза | – |
| 3 | Ознакомиться с данной документацией   | Представитель вуза, команда вуза | – |
| 4 | Зарегистрироваться на платформе TagMe | Команда разметки | TagMe |
| 5 | Предоставить список e-mail адресов, на которые зарегистрированы аккаунты разметчиков в TagMe |  Представитель вуза  | Telegram-бот поддержки |
| 6 | Предоставить список никнеймов разработчиков на платформе GitHub  |  Представитель вуза  | Telegram-бот поддержки |
| 7 | Подготовить список релевантных источников для вуза | Команда разметки | TagMe |
| 8 | Определить, какие страницы источников будут использоваться AI-помощником | Команда разметки | TagMe |
| 9 | Написать парсеры для сбора контента веб-страниц | Команда разработки | GitHub репозиторий |
| 10 | Произвести оценку качества парсинга контента | Команда разметки | TagMe |
| 11 | Подготовить тестовый сет для оценки качества работы AI-помощника | Команда разметки | TagMe |
| 12 | Произвести оценку качества работы AI-помощника для вуза | Команда разметки | TagMe |
| 13 | Использовать AI-помощника для вуза в основном боте | – | AI-помощник для вузов |
| 14 | Реализовывать собственные проекты на основе API (опционально) | Команда разработки | – |

<!-- 1. Представителю вуза связаться для получения уникального токена вуза с технической поддержкой проекта в Telegram: {tg}`giga_education_support_bot` или {tg}`bushmelove` / {tg}`appetrovich1`
2. Сформировать команду вуза для задач разметки и/или разработки
3. Команде вуза ознакомиться с данной документацией
4. Команде разметки зарегистрироваться на платформе TagMe 
5. Предоставить через техническую поддержку данные о командах вуза:
   - Список e-mail адресов, на которые зарегистрированы аккаунты разметчиков в TagMe
   - Список никнеймов разработчиков на платформе github  
6. Сформировать список релевантных источников для вуза и загрузить его на платформу TagMe
7. Определить, какие страницы источников будут использоваться AI-помощником
8. Написать парсеры для сбора контента с релевантных страниц сайта
9. Оценить качество парсинга контента страниц и документов
10. Подготовить тестовый сет для оценки качества работы AI-помощника
11. Протестировать качество работы AI-помощника на тестовом сете вуза
12. Использовать AI-помощника в:
   - основном боте (при достижении целевого показателя точности)
   - боте, который Вы можете реализовать с использованием нашего API -->

## Поддержка проекта
Поскольку ресурсы сайтов являются динамическими структурами, для корректной работы AI-помощника на длительном промежутке времени требуется периодическое повторение указанных выше шагов. Однако данный этап всё же не является таким трудозатратным, как первичное подключение вуза к проекту.