task-tracker: summarization service and LLM integration

Author: zhukovsd

content/projects/task-tracker.md

@@ -22,7 +22,6 @@ weight = 7
   - SQL
   - Spring Data JPA
   - Миграции
-- [Frontend](../technologies/frontend.md) - HTML/CSS, Bootstrap, Javascript, Ajax
 - [Docker и микросервисы](../technologies/microservices.md)
   - Контейнеры, образы, volumes, написание Dockerfile, Docker Compose
   - Брокер сообщений Kafka
@@ -37,6 +36,7 @@ weight = 7
 - Практика с Docker и Docker Compose, докеризация Spring Boot приложение (упаковка его в Docker образ)
 - Знакомство и практика с брокером сообщений Kafka
 - Самостоятельная разработка части схемы REST API
+- Интеграция с LLM/AI
 
 Дисклеймер. Планировщик задач - довольно простой и легковесный проект для микросервисного подхода. Но проект достаточной сложности вышел бы за рамки учебного по объёму и сложности.
 
@@ -56,11 +56,11 @@ weight = 7
 
 Оповещение пользователей по email:
 - Приветственное письмо
-- Каждый день в полночь оповещение о том, сколько задач было сделано за прошедшие сутки, и какое количество осталось невыполненными
+- Каждый день в полночь отчёт о том, какие задачи были сделаны за прошедшие сутки, какое количество осталось невыполненными
 
 ## Интерфейс приложения
 
-Веб-приложение является одностраничным, всё общение с сервером происходит с помощью JavaScript/Ajax, интерфейс обновляется через jQuery.
+Веб-приложение является одностраничным, всё общение с сервером происходит с помощью JavaScript/Ajax, интерфейс обновляется динамически.
 
 - Заголовок
     - Для неавторизованных пользователей - кнопки регистрации и авторизации
@@ -80,14 +80,13 @@ weight = 7
 - Чекбокс, чтобы пометить задачу сделанной (и обратно - пометить несделанной)
 - Кнопка "удалить"
 
-
 У формы модального окна нет кнопки "сохранить". JavaScript должен сохранять состояние задачи с помощью Ajax запросов, каждый раз когда пользователь нажимает на чекбокс, или редактирует поля ввода.
 
 ## SQL база данных
 
 В этом проекте студент самостоятельно разрабатывает структуру базы данных для хранения пользователей и задач. Отношение между пользователем и задачами - один ко многим.
 
-Как и в предыдущем проекте, в таблице `Users` ориентироваться стоит на интеграцию с Spring Security. Эта библиотека экосистемы Spring подразумевает определённые атрибуты, которыми должен обладать пользователь, и список которых и станет основой колонок для таблицы.
+Как и в предыдущем проекте, в таблице `Users` ориентироваться стоит на интеграцию с Spring Security. Эта библиотека экосистемы Spring подразумевает определённые атрибуты, которыми должен обладать пользователь, и список которых станет основой колонок для таблицы.
 
 Таблица `Tasks` должна содержать поля для описания заметки - заголовок, текст, владелец, статус, и время (timestamp), когда задача была помечена как сделанная.
 
@@ -155,17 +154,19 @@ Spring Boot приложение, реализующее REST API для раб
 
 ### Фронтенд
 
-Набор статических файлов:
-- HTML разметка структуры главной страницы (динамические данные вставляются через JavaScript/jQuery)
-- CSS
-- JavaScript
+Предлагаю ограничиться разработкой REST API. А для использования функционала проекта реализовать коллекцию REST запросов через Postman, REST Client в Intellij IDEA или аналогичный инструмент.
+
+Альтернативно, по желанию, вы можете реализовать веб-приложение на React/Vue/Angular.
+
+### Summarization сервис
+
+Составление отчета по задачам через LLM.
+
+Необходимо написать отдельный сервис, который будет интегрироваться с LLM по API и делать суммаризацию - генерировать отчет по итогам дня, сделанным и несделанным задачам.
 
-При разработке, файлы можно раздавать локальным сервером встроенным в Intellij IDEA. В контексте Docker Compose стека, образ фронтенд сервиса будет содержать веб-сервер Nginx, раздающий статику.
+Сервис принимает сообщение через кафку с данными по задачам за определенный период, полученный результат он также отправляет в кафку инициирующему сервису, реализуя паттерн RPC.
 
-- При загрузке страницы, JavaScript делает запрос на получение текущего пользователя. Ответ 401 HTTP означает, что пользователь неавторизован, 200 - авторизован. Для авторизованного пользователя мы можем запросить и отобразить список задач
-Работа с JavaScript/Ajax:
-- Формы авторизации и регистрации должны быть сверстаны с помощью тега `form`, но вместо обработчика по-умолчанию (POST запрос и перезагрузка страницы), jQuery будет переопределять обработчик, исполнять POST запрос через Ajax и реагировать на результат, в соответствии с кодом ошибки
-- Веб-страница и REST API будут доступны на разных портах - 80 и 8080. Для вызова методов REST API через Ajax может потребоваться выдача разрешения браузеру через CORS - https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
+Также данный сервис может иметь свой отдельный экземпляр базы данных для хранения обработанных запросов и результатов.
 
 ### Рассыльщик писем
 
@@ -179,13 +180,12 @@ Spring Boot приложение с двумя модулями - Spring Mail и
 
 Spring Boot приложение с двумя модулями - Spring Scheduler и Spring Kafka.
 
-Задача сервиса - раз в сутки итерировать всех пользователей, и формировать для них отчёты о задачах и изменениях в них за сутки.
+Задача сервиса - раз в сутки итерировать всех пользователей, и формировать для них отчёты о задачах и изменениях в них за сутки. Отчёт генерируется LLM через Summarization сервис
 
-- Пользователям, у которых на конец дня есть невыполненные задача, отправляется емейл вида "У вас осталось N несделанных задач". Тело письма содержит заголовки этих задач (не более какого-то разумного количества, например 5)
-- Пользователям, у которых за последние сутки 1 или более задач были отмечены как сделанные, отправляется емейл вида "За сегодня вы выполнили N задач". Тело письма содержит заголовки выполненных задач
-- Пользователям, для которых верны оба условия выше, отправляется емейл и со списком несделанных, и сделанных за последние сутки задач
-
-Spring Scheduler по Cron выражению каждую полночь вызывает метод, читающий список пользователей, анализирующий их заметки, и формирующий емейлы для отправки. Сформированные емейлы упаковываются в классы-модели и отправляются в Kafka топик.
+Планировщик является оркестратором данного процесса:
+- По расписанию находит всех пользователей, у которых есть сделанные за последние сутки задачи, и(или) остались несделанные
+- Для каждого пользователя генерируем отчёт, запросив его по Kafka RPC у Summarization сервиса
+- Сформированный отчёт, готовый к отправке, упаковываются в DTO и пересылается к сервис-рассыльщик писем через Kafka топик
 
 ## Работа с Kafka
 
@@ -194,13 +194,24 @@ Kafka в контексте Docker Compose стека запускается о
 - Задачи для отправки емейлов будут попадать в топик `EMAIL_SENDING_TASKS`
 - Бэкенд сервис и планировщик записывают сообщения в топик, рассыльщик писем - читает
 - Формат сообщений - JSON, сереализуемый и десериализуемый по модели, описанной с помощью класса Java, подобно моделям для контроллеров REST API. Сообщения в топике `EMAIL_SENDING_TASKS` должны содержать следующие поля - адрес получателя, заголовок и текст письма
+- Отдельно, необходимы топики для RPC общения планировщика с Summarization сервисом по RPC
 - Для интеграции Spring c Kafka можно использовать модуль Spring Kafka
 
-## Mailjet
+## Работа с LLM
+
+Предполагается напрямую интегрироваться с API LLM по HTTP, можно выбрать:
+- Прямое использование [OpenAI API](https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create)
+- Прокси сервисы - [пример](https://aitunnel.ru/)
+- Доступные в РФ LLM - [GigaCode](https://developers.sber.ru/docs/ru/gigachat/api/reference/rest/post-chat), [YaGPT](https://aistudio.yandex.ru/docs/ru/ai-studio/concepts/api.html)
+
+Необходимо поработать над системным промптом, предоставить желаемый формат и примеры, поработать с контекстом модели.
+Предполагается прямое использование API, не используя SDK или библиотеки для агентов. Практикуемся работать с внешним API.
+
+## Сервис для отправки писем
 
-Для отправки SMTP нужны логин, пароль, хост и порт SMTP сервера. У емейл сервисов, например Gmail, mail.ru, есть SMTP сервера, с которыми работают емейл-клиенты. Теоретически, можно воспользоваться их сервером, и отправлять письма, авторизовываясь логином и паролем своего ящика, но в реальности, для писем и рассылок обычно пользуются специальными для этого созданными сервисами, например Mailjet, Mailchimp, Mailgun (и десятками аналогичных).
+Для отправки SMTP нужны логин, пароль, хост и порт SMTP сервера. У емейл сервисов, например Gmail, mail.ru, есть SMTP сервера, с которыми работают емейл-клиенты. Теоретически, можно воспользоваться их сервером, и отправлять письма, авторизовываясь логином и паролем своего ящика, но в реальности, для писем и рассылок обычно пользуются специальными для этого созданными сервисами, например Unisender, Mailchimp, Mailgun (и десятками аналогичных).
 
-Для примера рассмотрим [Mailjet](https://www.mailjet.com/). Бесплатный лимит сервиса - 200 писем на отправку в сутки. Необходимо зарегистрироваться там, сконфигурировать sender адрес (адрес отправителя писем), получить credentials (логин и пароль) и остальные SMTP настройки.
+Предлагаю использовать [Unisender](https://www.unisender.com/). Необходимо зарегистрироваться там, сконфигурировать sender адрес (адрес отправителя писем), получить credentials (логин и пароль) и остальные настройки.
 
 Логин и пароль - секретные данные, которые не должны попасть в git репозиторий. При запуске приложения из IDE или Docker Compose стека, секреты можно подключить к приложению через переменные окружения.
 
@@ -215,9 +226,9 @@ Kafka в контексте Docker Compose стека запускается о
 
 Сервисы:
 - task-tracker-backend (порт 8080)
-- task-tracker-frontend (порт 80)
 - task-tracker-scheduler
 - task-tracker-email-sender
+- task-tracker-summarization-server
 - Postgres
 - Kafka
 
@@ -234,7 +245,7 @@ Kafka в контексте Docker Compose стека запускается о
 Приложение целиком будем деплоить через Docker.
 
 Шаги:
-- С помощью GitHub Actions (детали ниже) автоматизировать сборку докер образов для сервисов task-tracker-backend, task-tracker-frontend, task-tracker-scheduler, task-tracker-email-sender
+- С помощью GitHub Actions (детали ниже) автоматизировать сборку докер образов для сервисов проекта
 - В хостинг-провайдере по выбору арендовать облачный сервер на Linux
 - Установить Docker
 - Скопировать на удалённый сервер Docker Compose файл для запуска сервисов приложения, запустить
@@ -255,17 +266,16 @@ Kafka в контексте Docker Compose стека запускается о
 - Docker Compose - добавить Postgres, Kafka
 - Backend - работа с пользователями
 - Backend - работа с JWT, авторизация
-- Frontend - структура страницы, интерфейс и Javascript для регистрации и авторизации
 - Backend - работа с задачами
-- Frontend - листинг, добавление, редактирование, удаление задач
 - Email sender - реализация получения сообщений от Kafka и отправки емейлов
-- Backend - отправка приветственного письма при регистрации
+- Отправка приветственного письма при регистрации
+- Summarization сервис
 - Scheduler - отправка пользовательских отчетов по сделанным и оставшимся задачам
 - CI/CD, деплой
 
 ## Ресурсы для работы над ошибками
 
-- [Реализации проекта](../finished-projects/task-tracker.md.md) другими студентами и мои ревью этих реализаций
+- [Реализации проекта](../finished-projects/task-tracker.md.md) другими студентами и ревью этих реализаций
 
 ## Ревью на ваш проект