Communication: Add first Iris Tutor Suggestion Interface

src/main/java/de/tum/cit/aet/artemis/iris/domain/message/IrisMessageSender.java

@@ -7,9 +7,11 @@
  * <p>
  * LLM: A message generated by a large language model
  * <p>
+ * TUT_SUG: A message send by the tutor suggestion system
+ * <p>
  * Note: The ARTEMIS message sender variant was removed, as its original intent was
  * based on an incomplete understanding of the requirements of the Iris subsystem.
  */
 public enum IrisMessageSender {
-    USER, LLM
+    USER, LLM, TUT_SUG
 }

src/main/java/de/tum/cit/aet/artemis/iris/domain/session/IrisSession.java

@@ -41,6 +41,7 @@
     @JsonSubTypes.Type(value = IrisExerciseChatSession.class, name = "chat"), // TODO: Legacy. Should ideally be "exercise_chat"
     @JsonSubTypes.Type(value = IrisCourseChatSession.class, name = "course_chat"),
     @JsonSubTypes.Type(value = IrisLectureChatSession.class, name = "lecture_chat"),
+    @JsonSubTypes.Type(value = IrisTutorSuggestionSession.class, name = "tutor_suggestion"),
 })
 // @formatter:on
 @JsonInclude(JsonInclude.Include.NON_EMPTY)

src/main/java/de/tum/cit/aet/artemis/iris/domain/session/IrisTutorSuggestionSession.java

@@ -0,0 +1,48 @@
+package de.tum.cit.aet.artemis.iris.domain.session;
+
+import java.util.Optional;
+
+import jakarta.persistence.DiscriminatorValue;
+import jakarta.persistence.Entity;
+import jakarta.persistence.ManyToOne;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+import de.tum.cit.aet.artemis.communication.domain.Post;
+import de.tum.cit.aet.artemis.core.domain.User;
+
+/**
+ * An IrisTutorSuggestionSession represents a conversation between a user and an LLM in the context of a tutor suggestion.
+ * This is used for tutors receiving assistance from Iris for answering student questions.
+ */
+@Entity
+@DiscriminatorValue("TUTOR_SUGGESTION")
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public class IrisTutorSuggestionSession extends IrisChatSession {
+
+    @ManyToOne
+    @JsonIgnore
+    private Post post;
+
+    public IrisTutorSuggestionSession(Post post, User user) {
+        super(user);
+        this.post = post;
+    }
+
+    public IrisTutorSuggestionSession() {
+    }
+
+    public Post getPost() {
+        return post;
+    }
+
+    public void setPost(Post post) {
+        this.post = post;
+    }
+
+    @Override
+    public String toString() {
+        return "IrisTutorSuggestionSession{" + "user=" + Optional.ofNullable(getUser()).map(User::getLogin).orElse("null") + "," + "post=" + post + '}';
+    }
+}

src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisCourseSettings.java

@@ -52,6 +52,10 @@ public class IrisCourseSettings extends IrisSettings {
     @JoinColumn(name = "iris_competency_generation_settings_id")
     private IrisCompetencyGenerationSubSettings irisCompetencyGenerationSettings;
 
+    @OneToOne(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER)
+    @JoinColumn(name = "iris_tutor_suggestion_settings_id")
+    private IrisTutorSuggestionSubSettings irisTutorSuggestionSettings;
+
     public Course getCourse() {
         return course;
     }
@@ -129,4 +133,14 @@ public IrisFaqIngestionSubSettings getIrisFaqIngestionSettings() {
     public void setIrisFaqIngestionSettings(IrisFaqIngestionSubSettings irisFaqIngestionSubSettings) {
         this.irisFaqIngestionSettings = irisFaqIngestionSubSettings;
     }
+
+    @Override
+    public IrisTutorSuggestionSubSettings getIrisTutorSuggestionSettings() {
+        return irisTutorSuggestionSettings;
+    }
+
+    @Override
+    public void setIrisTutorSuggestionSettings(IrisTutorSuggestionSubSettings irisTutorSuggestionSubSettings) {
+        this.irisTutorSuggestionSettings = irisTutorSuggestionSubSettings;
+    }
 }

src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisExerciseSettings.java

@@ -111,4 +111,15 @@ public void setIrisFaqIngestionSettings(IrisFaqIngestionSubSettings irisFaqInges
         // Empty because exercises don't have exercise faq settings
 
     }
+
+    @Override
+    public IrisTutorSuggestionSubSettings getIrisTutorSuggestionSettings() {
+        // Empty because exercises don't have exercise tutor suggestion settings
+        return null;
+    }
+
+    @Override
+    public void setIrisTutorSuggestionSettings(IrisTutorSuggestionSubSettings irisTutorSuggestionSubSettings) {
+        // Empty because exercises don't have exercise tutor suggestion settings
+    }
 }

src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisGlobalSettings.java

@@ -47,6 +47,10 @@ public class IrisGlobalSettings extends IrisSettings {
     @JoinColumn(name = "iris_competency_generation_settings_id")
     private IrisCompetencyGenerationSubSettings irisCompetencyGenerationSettings;
 
+    @OneToOne(cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER)
+    @JoinColumn(name = "iris_tutor_suggestion_settings_id")
+    private IrisTutorSuggestionSubSettings irisTutorSuggestionSubSettings;
+
     @Override
     public IrisLectureIngestionSubSettings getIrisLectureIngestionSettings() {
         return irisLectureIngestionSettings;
@@ -117,4 +121,15 @@ public void setIrisFaqIngestionSettings(IrisFaqIngestionSubSettings irisFaqInges
         this.irisFaqIngestionSubSettings = irisFaqIngestionSubSettings;
 
     }
+
+    @Override
+    public IrisTutorSuggestionSubSettings getIrisTutorSuggestionSettings() {
+        return irisTutorSuggestionSubSettings;
+    }
+
+    @Override
+    public void setIrisTutorSuggestionSettings(IrisTutorSuggestionSubSettings irisTutorSuggestionSubSettings) {
+        this.irisTutorSuggestionSubSettings = irisTutorSuggestionSubSettings;
+    }
+
 }

src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSettings.java

@@ -69,4 +69,8 @@ public abstract class IrisSettings extends DomainObject {
 
     public abstract void setIrisFaqIngestionSettings(IrisFaqIngestionSubSettings irisFaqIngestionSubSettings);
 
+    public abstract IrisTutorSuggestionSubSettings getIrisTutorSuggestionSettings();
+
+    public abstract void setIrisTutorSuggestionSettings(IrisTutorSuggestionSubSettings irisTutorSuggestionSubSettings);
+
 }

src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSubSettings.java

@@ -45,6 +45,7 @@
     @JsonSubTypes.Type(value = IrisCompetencyGenerationSubSettings.class, name = "competency-generation"),
     @JsonSubTypes.Type(value = IrisLectureChatSubSettings.class, name = "lecture-chat"),
     @JsonSubTypes.Type(value = IrisFaqIngestionSubSettings.class, name = "faq-ingestion"),
+    @JsonSubTypes.Type(value = IrisTutorSuggestionSubSettings.class, name = "tutor-suggestion"),
 })
 // @formatter:on
 @JsonInclude(JsonInclude.Include.NON_EMPTY)

src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisSubSettingsType.java

@@ -2,5 +2,5 @@
 
 public enum IrisSubSettingsType {
     CHAT, // TODO: Rename to PROGRAMMING_EXERCISE_CHAT
-    TEXT_EXERCISE_CHAT, COURSE_CHAT, COMPETENCY_GENERATION, LECTURE_INGESTION, LECTURE_CHAT, FAQ_INGESTION
+    TEXT_EXERCISE_CHAT, COURSE_CHAT, COMPETENCY_GENERATION, LECTURE_INGESTION, LECTURE_CHAT, FAQ_INGESTION, TUTOR_SUGGESTION
 }

src/main/java/de/tum/cit/aet/artemis/iris/domain/settings/IrisTutorSuggestionSubSettings.java

@@ -0,0 +1,16 @@
+package de.tum.cit.aet.artemis.iris.domain.settings;
+
+import jakarta.persistence.DiscriminatorValue;
+import jakarta.persistence.Entity;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+/**
+ * An {@link IrisSubSettings} implementation for the settings for tutor suggestions.
+ */
+@Entity
+@DiscriminatorValue("TUTOR_SUGGESTION")
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public class IrisTutorSuggestionSubSettings extends IrisSubSettings {
+
+}

src/main/java/de/tum/cit/aet/artemis/iris/dto/IrisCombinedSettingsDTO.java

@@ -11,6 +11,7 @@ public record IrisCombinedSettingsDTO(
         IrisCombinedLectureIngestionSubSettingsDTO irisLectureIngestionSettings,
         IrisCombinedCompetencyGenerationSubSettingsDTO irisCompetencyGenerationSettings,
         IrisCombinedLectureChatSubSettingsDTO irisLectureChatSettings,
-        IrisCombinedFaqIngestionSubSettingsDTO irisFaqIngestionSettings
+        IrisCombinedFaqIngestionSubSettingsDTO irisFaqIngestionSettings,
+        IrisCombinedTutorSuggestionSubSettingsDTO irisTutorSuggestionSettings
 ) {}
 // @formatter:on

src/main/java/de/tum/cit/aet/artemis/iris/dto/IrisCombinedTutorSuggestionSubSettingsDTO.java

@@ -0,0 +1,18 @@
+package de.tum.cit.aet.artemis.iris.dto;
+
+import java.util.Set;
+
+import jakarta.annotation.Nullable;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+/**
+ * Data transfer object for the IrisCombinedTutorSuggestionSubSettings.
+ *
+ * @param enabled         true if settings are enabled
+ * @param allowedVariants a set of allowed variants
+ * @param selectedVariant the selected variant
+ */
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public record IrisCombinedTutorSuggestionSubSettingsDTO(boolean enabled, @Nullable Set<String> allowedVariants, @Nullable String selectedVariant) {
+}

src/main/java/de/tum/cit/aet/artemis/iris/repository/IrisTutorSuggestionSessionRepository.java

@@ -0,0 +1,44 @@
+package de.tum.cit.aet.artemis.iris.repository;
+
+import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_IRIS;
+import static org.springframework.data.jpa.repository.EntityGraph.EntityGraphType.LOAD;
+
+import java.util.Collections;
+import java.util.List;
+
+import org.springframework.context.annotation.Profile;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.repository.EntityGraph;
+import org.springframework.stereotype.Repository;
+
+import de.tum.cit.aet.artemis.core.domain.DomainObject;
+import de.tum.cit.aet.artemis.core.repository.base.ArtemisJpaRepository;
+import de.tum.cit.aet.artemis.iris.domain.session.IrisTutorSuggestionSession;
+
+@Repository
+@Profile(PROFILE_IRIS)
+public interface IrisTutorSuggestionSessionRepository extends ArtemisJpaRepository<IrisTutorSuggestionSession, Long> {
+
+    List<IrisTutorSuggestionSession> findByPostIdAndUserIdOrderByCreationDateDesc(Long postId, Long userId, Pageable pageable);
+
+    @EntityGraph(type = LOAD, attributePaths = "messages")
+    List<IrisTutorSuggestionSession> findSessionsWithMessagesByIdIn(List<Long> ids);
+
+    /**
+     * Finds the latest sessions for the given post and user with messages.
+     *
+     * @param postId   the id of the post
+     * @param userId   the id of the user
+     * @param pageable the pageable to use for the query
+     * @return the latest sessions for the given post and user with messages
+     */
+    default List<IrisTutorSuggestionSession> findLatestSessionsByPostIdAndUserIdWithMessages(Long postId, Long userId, Pageable pageable) {
+        List<Long> ids = findByPostIdAndUserIdOrderByCreationDateDesc(postId, userId, pageable).stream().map(DomainObject::getId).toList();
+
+        if (ids.isEmpty()) {
+            return Collections.emptyList();
+        }
+
+        return findSessionsWithMessagesByIdIn(ids);
+    }
+}

src/main/java/de/tum/cit/aet/artemis/iris/service/IrisSessionService.java

@@ -17,13 +17,15 @@
 import de.tum.cit.aet.artemis.iris.domain.session.IrisLectureChatSession;
 import de.tum.cit.aet.artemis.iris.domain.session.IrisSession;
 import de.tum.cit.aet.artemis.iris.domain.session.IrisTextExerciseChatSession;
+import de.tum.cit.aet.artemis.iris.domain.session.IrisTutorSuggestionSession;
 import de.tum.cit.aet.artemis.iris.service.session.IrisChatBasedFeatureInterface;
 import de.tum.cit.aet.artemis.iris.service.session.IrisCourseChatSessionService;
 import de.tum.cit.aet.artemis.iris.service.session.IrisExerciseChatSessionService;
 import de.tum.cit.aet.artemis.iris.service.session.IrisLectureChatSessionService;
 import de.tum.cit.aet.artemis.iris.service.session.IrisRateLimitedFeatureInterface;
 import de.tum.cit.aet.artemis.iris.service.session.IrisSubFeatureInterface;
 import de.tum.cit.aet.artemis.iris.service.session.IrisTextExerciseChatSessionService;
+import de.tum.cit.aet.artemis.iris.service.session.IrisTutorSuggestionSessionService;
 
 /**
  * Service for managing Iris sessions.
@@ -42,14 +44,17 @@ public class IrisSessionService {
 
     private final IrisLectureChatSessionService irisLectureChatSessionService;
 
+    private final IrisTutorSuggestionSessionService irisTutorSuggestionSessionService;
+
     public IrisSessionService(UserRepository userRepository, IrisTextExerciseChatSessionService irisTextExerciseChatSessionService,
             IrisExerciseChatSessionService irisExerciseChatSessionService, IrisCourseChatSessionService irisCourseChatSessionService,
-            IrisLectureChatSessionService irisLectureChatSessionService) {
+            IrisLectureChatSessionService irisLectureChatSessionService, IrisTutorSuggestionSessionService irisTutorSuggestionSessionService) {
         this.userRepository = userRepository;
         this.irisTextExerciseChatSessionService = irisTextExerciseChatSessionService;
         this.irisExerciseChatSessionService = irisExerciseChatSessionService;
         this.irisCourseChatSessionService = irisCourseChatSessionService;
         this.irisLectureChatSessionService = irisLectureChatSessionService;
+        this.irisTutorSuggestionSessionService = irisTutorSuggestionSessionService;
     }
 
     /**
@@ -74,8 +79,10 @@ public void checkHasAccessToIrisSession(IrisSession session, @Nullable User user
         if (user == null) {
             user = userRepository.getUserWithGroupsAndAuthorities();
         }
-        user.hasAcceptedExternalLLMUsageElseThrow();
         var wrapper = getIrisSessionSubService(session);
+        if (!(wrapper.irisSession instanceof IrisTutorSuggestionSession)) {
+            user.hasAcceptedExternalLLMUsageElseThrow();
+        }
         wrapper.irisSubFeatureInterface.checkHasAccessTo(user, wrapper.irisSession);
     }
 
@@ -146,6 +153,8 @@ private <S extends IrisSession> IrisSubFeatureWrapper<S> getIrisSessionSubServic
             case IrisExerciseChatSession chatSession -> (IrisSubFeatureWrapper<S>) new IrisSubFeatureWrapper<>(irisExerciseChatSessionService, chatSession);
             case IrisCourseChatSession courseChatSession -> (IrisSubFeatureWrapper<S>) new IrisSubFeatureWrapper<>(irisCourseChatSessionService, courseChatSession);
             case IrisLectureChatSession lectureChatSession -> (IrisSubFeatureWrapper<S>) new IrisSubFeatureWrapper<>(irisLectureChatSessionService, lectureChatSession);
+            case IrisTutorSuggestionSession tutorSuggestionSession ->
+                (IrisSubFeatureWrapper<S>) new IrisSubFeatureWrapper<>(irisTutorSuggestionSessionService, tutorSuggestionSession);
             case null, default -> throw new BadRequestException("Unknown Iris session type " + session.getClass().getSimpleName());
         };
     }

src/main/java/de/tum/cit/aet/artemis/iris/service/pyris/PyrisJobService.java

@@ -26,6 +26,7 @@
 import de.tum.cit.aet.artemis.iris.service.pyris.job.LectureIngestionWebhookJob;
 import de.tum.cit.aet.artemis.iris.service.pyris.job.PyrisJob;
 import de.tum.cit.aet.artemis.iris.service.pyris.job.TranscriptionIngestionWebhookJob;
+import de.tum.cit.aet.artemis.iris.service.pyris.job.TutorSuggestionJob;
 
 /**
  * The PyrisJobService class is responsible for managing Pyris jobs in the Artemis system.
@@ -96,6 +97,21 @@ public String addCourseChatJob(Long courseId, Long sessionId) {
         return token;
     }
 
+    /**
+     * adds a tutor suggestion job to the job map
+     *
+     * @param postId    Id of the post the suggestion is created for
+     * @param courseId  Id of the course the post belongs to
+     * @param sessionId Id of the session the suggestion is created for
+     * @return the token of the job
+     */
+    public String addTutorSuggestionJob(Long postId, Long courseId, Long sessionId) {
+        var token = generateJobIdToken();
+        var job = new TutorSuggestionJob(token, postId, courseId, sessionId, null);
+        jobMap.put(token, job);
+        return token;
+    }
+
     /**
      * Adds a new lecture ingestion webhook job to the job map with a timeout.
      *