Refactor Feedback Reference #354
Open
+133
−43
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
lock:athena-test1
LeonWehrhahn
temporarily deployed
to
athena-test1.ase.cit.tum.de
GitHub Actions
Inactive
…apping and uniqueness resolution
…tum/Athena into feature/modeling/reference
LeonWehrhahn
added
deploy:athena-test1
|
github-actions
bot
added
the
deployment-error
LeonWehrhahn
added
deploy:athena-test1
LeonWehrhahn
temporarily deployed
to
athena-test1.ase.cit.tum.de
GitHub Actions
Inactive
github-actions
bot
added
lock:athena-test1
LeonWehrhahn
requested review from
EneaGore,
dmytropolityka and
maximiliansoelch
github-actions
bot
removed
the
lock:athena-test1
| from .feedback import Feedback | ||
|
|
||
|
|
||
| class ModelingFeedback(Feedback): | ||
| """Feedback on a modeling exercise.""" | ||
|
|
||
| element_ids: Optional[List[str]] = Field([], description="referenced diagram element IDs", example=["id_1"]) | ||
| reference: Optional[str] = Field(None, description="reference to the diagram element", example="ClassAttribute:5a337bdf-da00-4bd0-a6f0-78ba5b84330e") |
There was a problem hiding this comment.
Is there a reason for the type none?
| """ | ||
| # Remove visibility symbols and leading/trailing spaces | ||
| name = full_name.lstrip('+-#~ ').strip() | ||
| # For attributes, split on ':' |
There was a problem hiding this comment.
Can it be the case that both are present?
| from pydantic import BaseModel, Field | ||
|
|
||
| class FeedbackModel(BaseModel): | ||
| title: str = Field(description="Very short title, i.e. feedback category or similar", example="Logic Error") | ||
| description: str = Field(description="Feedback description") | ||
| element_names: Optional[List[str]] = Field(description="Referenced diagram element names, and relations (R<number>) or empty if unreferenced") | ||
| element_name: Optional[str] = Field(description="Referenced diagram element, attribute names, and relations (use format: <ClassName>, <ClassName>.<AttributeName>, <ClassName>.<MethodName>, R<number>), or leave empty if unreferenced") |
There was a problem hiding this comment.
Since we don't have a list of feedbacks any more, do we use multiple instances of FeedbackModel somehow now?
EneaGore
reviewed
Nov 25, 2024
@EneaGore This should be related to the playground token config, if you increase the |
…tum/Athena into feature/modeling/reference
github-actions
bot
added
lock:athena-test1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
This PR introduces two changes:
Simplified Feedback Schema: The feedback schema has been simplified by replacing the list of
element_idswith a singlereferencefield. This change avoids unnecessary conversions on the Artemis side and aligns the reference format with how manual references are handled in Artemis.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
DBModelingFeedbackandModelingFeedbackmodels to replace theelement_idsfield with areferencefield that accepts a single string in the formatelementType:elementId(e.g.,ClassAttribute:5a337bdf-da00-4bd0-a6f0-78ba5b84330e).2. Enabled Detailed Element Referencing
Enhanced Parsers and Transformers:
ApollonJSONTransformerand its parsers to extract IDs and types of attributes, methods, and relations.ElementandUMLParserclasses to support detailed mapping between element names and their IDs/types.Adjusted Prompts and Utility Functions:
convert_to_athana_feedback_modelandget_exercise_modelto handle the newreferencefield and support the enhanced referencing capabilities.Steps for Testing
API Testing:
/feedback_suggestionsendpoint of the module.Verify Feedback Generation:
referencefield in the formatelementType:elementId.Check Granular Referencing:
ClassAttribute:[attribute-id]orClassMethod:[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:
