Modeling Exercises: Refactor Feedback Reference (#354)

[LeonWehrhahn]

Motivation and Context

This PR introduces two changes:

1. Simplified Feedback Schema: The feedback schema has been simplified by replacing the list of element_ids with a single reference field. This change avoids unnecessary conversions on the Artemis side and aligns the reference format with how manual references are handled in Artemis.

2. Enabled Detailed Element Referencing: Previously, feedback could only reference entire elements. With this update, feedback can now reference specific attributes, methods within elements and also references between elements.

Description

1. Simplified Feedback Schema

• Updated Data Models: Modified the DBModelingFeedback and ModelingFeedback models to replace the element_ids field with a reference field that accepts a single string in the format elementType:elementId (e.g., ClassAttribute:5a337bdf-da00-4bd0-a6f0-78ba5b84330e).

2. Enabled Detailed Element Referencing

• Enhanced Parsers and Transformers:

  • Updated the ApollonJSONTransformer and its parsers to extract IDs and types of attributes, methods, and relations.
  • Modified the Element and UMLParser classes to support detailed mapping between element names and their IDs/types.

• Adjusted Prompts and Utility Functions:

  • Updated the feedback generation prompt to instruct the LLM to reference specific attributes, methods, and relations using the new format.
  • Modified utility functions like convert_to_athana_feedback_model and get_exercise_model to handle the new reference field and support the enhanced referencing capabilities.

Steps for Testing

1. API Testing:

   • Make direct API calls to the /feedback_suggestions endpoint of the module.
   • Use submissions that include classes with attributes, methods, and relations.

2. Verify Feedback Generation:

   • Ensure that feedback is generated correctly without errors.
   • Check that the feedback includes the new reference field in the format elementType:elementId.

3. Check Granular Referencing:

   • Verify that feedback can reference specific attributes, methods, and relations.
     • For example, feedback might reference ClassAttribute:[attribute-id] or ClassMethod:[method-id].

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.

Screenshots

Example of how attribute and method referencing is displayed in the feedback UI on Artemis:

[github-actions]

⚠️ Unable to deploy to test servers ⚠️

The docker build needs to run through before deploying.

[DominikRemo]

Code LGTM

[maximiliansoelch]

Can you add a todo comment to remove that in the future?