🚩REST Endpoints

Здесь собраны все маршруты для взаимодействия с нашим API.

Календарь

POST /api/student/calendar

По этому маршруту генерируется календарь. Генерация происходит на основе YandexGPT, которая принимает предмет и цель, которую студент хочет добиться.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Description
date	string	Дата текущего дня.
subject	string	Предмет, по которому студент хочет получить расписание.
goal	string	Цель, которую хочет добиться студент.

Response

200

[
    {
        "data": "2024-04-15",
        "plan": "Изучение основ машинного обучения, чтение статей и просмотр видео по теме."
    },
    {
        "data": "2024-04-16",
        "plan": "Практика на наборе данных, решение задач машинного обучения."
    },
    {
        "data": "2024-04-17",
        "plan": "Анализ результатов практики, обсуждение с наставником или коллегами."
    },
    {
        "data": "2024-04-18",
        "plan": "Изучение новых алгоритмов машинного обучения и их применение на практике."
    },
    {
        "data": "2024-04-19",
        "plan": "Решение более сложных задач машинного обучения с использованием новых алгоритмов."
    }
]

400

Ассистент

POST /api/student/assistant

Маршрут, по которому студент может задать вопрос, касающийся вуза: местоположение, курсов, учителей, стоимости обучения и т.д. Также есть роли: "programmer" и "psychologist", которые отвечают от лица программиста и психолога вуза соответственно.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Description
role	string	Принимает один из параметров: assistant, programmer, psychologist.
question	string	Вопрос, который студент спрашивает у модели.

Response

200

{
    "role": "assistant",
    "text": "Привет! Я не знаю точно, какие экзамены ждут тебя, но могу предположить, что это будут базовые предметы, связанные с информационными технологиями.\n\nВозможно, тебе предстоит сдать экзамены по Microsoft Office Specialist, чтобы продемонстрировать свои навыки работы с популярными офисными программами. Также могут быть экзамены по основам программирования, например, Microsoft Technology Associate: Software Development Fundamentals (C#).\n\nНе забывай, что точные требования и расписание экзаменов можно узнать у своего преподавателя или на сайте колледжа."
}