Iris: Add links to citations for lecture questions

[yassinsws]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• I chose a title conforming to the naming conventions for pull requests.

Changes affecting Programming Exercises

• High priority: I tested all changes and their related features with all corresponding user types on a test server configured with the integrated lifecycle setup (LocalVC and LocalCI).

Motivation and Context

Right now Iris answers with the lecture and the page it got it's answer from. This lacks usability. Thus I added links to make a better user experience,

Description

Iris now answers with links to the corresponding letures it got its' answers from.

Steps for Testing

Prerequisites:

• 1 Test server with Iris enabled
• 1 Course with lecture ingested in it.
• 1 Student/ Instructor

1. Log in to Artemis as the student where Iris is enabled.
2. Go to the course dashboard and ask a question like "explain me the content of lecture 1"
3. The answer of the chatbot should have citations like the screenshot below.

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Performance Review

• I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Only trivial changes in server file.

Screenshots

Summary by CodeRabbit

• New Features
  • Added lectureUnitLink to lecture unit updates and deletions, providing additional context in notifications.

[coderabbitai]

Walkthrough

The update introduces a new field, lectureUnitLink, to the PyrisLectureUnitWebhookDTO class, enhancing the data structure to include additional information about lecture units. This change impacts the methods processAttachmentForUpdate and processAttachmentForDeletion within the PyrisWebhookService, which now pass the lectureUnitLink parameter when constructing the DTO.

Changes

File	Change Summary
src/main/java/de/tum/in/www1/artemis/service/connectors/pyris/PyrisWebhookService.java	Updated processAttachmentForUpdate and processAttachmentForDeletion to handle lectureUnitLink.
src/main/java/de/tum/in/www1/artemis/service/connectors/pyris/dto/lectureingestionwebhook/...	Added new field lectureUnitLink to the PyrisLectureUnitWebhookDTO class.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[JohannesStoehr]

Code

[edkaya]

Code lgtm

[egekurt123]

LGTM

[dmytropolityka]

code lgtm

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.