feat: Adding chat messages to the DB #121

rijuma · 2024-10-30T13:01:50Z

This update adds the last user message to the course chat view.

I've also added some constants to LearningAssistantMessage model for consistency.

Warning

I've added an extra validation on the endpoint requiring the last message from the chat to be from the user.

github-actions · 2024-10-30T14:36:18Z

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
learning_assistant
api.py					201-202
models.py
serializers.py
toggles.py					51
views.py
learning_assistant/migrations
0008_alter_learningassistantmessage_role.py
Project Total

_{This report was generated by python-coverage-comment-action}

schenedx · 2024-10-30T14:55:52Z

learning_assistant/views.py

@@ -76,6 +79,15 @@ def post(self, request, course_run_id):
        unit_id = request.query_params.get('unit_id')

        message_list = request.data
+
+        # Check that the last message in the list corresponds to a user
+        new_user_message = message_list[-1]


I don't really understand the code block and the comment. Can you explain more to help someone like to understand the logic better?

What if the message_list array is empty?

I assumed the endpoint was to process a new user message. Maybe I misunderstood it but if it is, then it should include at least one user message.

Just to point out: We discussed this offline and came to the conclusion that the approach is correct.

rijuma · 2024-10-30T14:56:14Z

tests/test_views.py

+            {'role': 'assistant', 'content': 'It is 4'},
+            {'role': 'user', 'content': 'And what else?'},


I've added a check that validates the last message from the list to be from a user.

rijuma · 2024-10-30T14:57:33Z

learning_assistant/models.py

    course_id = CourseKeyField(max_length=255, db_index=True)
    user = models.ForeignKey(USER_MODEL, db_index=True, on_delete=models.CASCADE)
-    role = models.CharField(max_length=64)
+    role = models.CharField(choices=Roles, max_length=64)


I think this doesn't affect the database, so no migration needed.

Are you sure? Did you run makemigrations?

I didn't. I'm sorry for that.
Just added the migration file.

schenedx · 2024-10-30T14:57:36Z

learning_assistant/views.py

@@ -103,6 +115,22 @@ def post(self, request, course_run_id):
        )
        status_code, message = get_chat_response(prompt_template, message_list)

+        user = User.objects.get(id=request.user.id)  # Based on the previous code, user exists.


I feel the code block below should be wrapped into a new function

Moved to the API module.

alangsto · 2024-10-30T15:27:55Z

learning_assistant/views.py

@@ -35,6 +38,27 @@ class CourseChatView(APIView):
    authentication_classes = (SessionAuthentication, JwtAuthentication,)
    permission_classes = (IsAuthenticated,)

+    def __save_user_interaction(self, user_id, user_message, assistant_message):


can this be moved to the api.py file? I also think it might make more sense for it to look like save_user_message(user_id, role, message), and call it twice from within the view.

Moved to the API module and added two calls in the view.

alangsto · 2024-10-30T15:28:13Z

learning_assistant/views.py

@@ -103,6 +136,12 @@ def post(self, request, course_run_id):
        )
        status_code, message = get_chat_response(prompt_template, message_list)

+        self.__save_user_interaction(


This needs to be gated by a waffle flag, which also needs to be created.

Oh shoot. I totally forgot about it. Thanks for calling this out!

Added waffle flag and gated the functionality behind it.

rijuma · 2024-10-30T21:06:31Z

tests/test_views.py

 User = get_user_model()


-class TestClient(Client):
+class FakeClient(Client):


This class was renamed to remove the following test warning:

tests/test_views.py:22 /Users/(ueser)/edx/src/learning-assistant/tests/test_views.py:22: PytestCollectionWarning: cannot collect test class 'TestClient' because it has a __init__ constructor (from: tests/test_views.py) class TestClient(Client):

alangsto · 2024-10-31T13:06:26Z

learning_assistant/views.py

+        course_id = get_course_id(course_run_id)
+        user_id = request.user.id
+
+        if chat_history_enabled(course_id):


Should this be the course_id or a course key?

Good catch. According to the code to check the flag we check for Learning Assistant enabled state is a CourseKey based on the course run. I'll update it quickly.

schenedx

👍

schenedx · 2024-11-04T14:49:31Z

learning_assistant/models.py

    course_id = CourseKeyField(max_length=255, db_index=True)
    user = models.ForeignKey(USER_MODEL, db_index=True, on_delete=models.CASCADE)
-    role = models.CharField(max_length=64)
+    role = models.CharField(choices=Roles, max_length=64)


Are you sure? Did you run makemigrations?

alangsto · 2024-11-04T14:51:35Z

learning_assistant/api.py

@@ -189,6 +191,24 @@ def get_course_id(course_run_id):
    return course_key


+def save_chat_message(user_id, chat_role, message):


This function should also take in a course_id, and use that as a field in the message being saved

Nice catch. I wonder why this wasn't detected on the unit tests, maybe there's a constraint missing?

Just updated save_chat_message() to take the Courserun Key and save it to the model.

rijuma · 2024-11-04T19:07:48Z

Just to confirm, I've validated locally that no message is saved without enabling the feature flag and this is the result after enabling it:

+----+----------------------------+----------------------------+---------------------------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------+
| id | created                    | modified                   | course_id                       | role      | content                                                                                                                                                              | user_id |
+----+----------------------------+----------------------------+---------------------------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------+
|  1 | 2024-11-04 19:05:07.403363 | 2024-11-04 19:05:07.403363 | course-v1:edX+DemoX+Demo_Course | user      | marco                                                                                                                                                                |       3 |
|  2 | 2024-11-04 19:05:21.357636 | 2024-11-04 19:05:21.357636 | course-v1:edX+DemoX+Demo_Course | assistant | It seems like you might be looking for something specific. Could you please clarify your question or let me know how I can assist you with the Demonstration Course? |       3 |
+----+----------------------------+----------------------------+---------------------------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------+

rijuma force-pushed the rijuma/save-messages-to-db branch 4 times, most recently from 1f63bf7 to c98c8b2 Compare October 30, 2024 14:35

rijuma force-pushed the rijuma/save-messages-to-db branch 4 times, most recently from 2e8ddd7 to 4f2529d Compare October 30, 2024 14:49

rijuma marked this pull request as ready for review October 30, 2024 14:51

rijuma changed the title ~~feat: Adding chat messages to the DB (WIP)~~ feat: Adding chat messages to the DB Oct 30, 2024

schenedx reviewed Oct 30, 2024

View reviewed changes

rijuma commented Oct 30, 2024

View reviewed changes

schenedx reviewed Oct 30, 2024

View reviewed changes

alangsto reviewed Oct 30, 2024

View reviewed changes

rijuma force-pushed the rijuma/save-messages-to-db branch 5 times, most recently from 84e2983 to e1c3471 Compare October 30, 2024 21:04

rijuma commented Oct 30, 2024

View reviewed changes

rijuma force-pushed the rijuma/save-messages-to-db branch 2 times, most recently from 956d19d to e28918a Compare October 30, 2024 21:10

alangsto reviewed Oct 31, 2024

View reviewed changes

rijuma force-pushed the rijuma/save-messages-to-db branch 4 times, most recently from 9fa2e46 to 6106dc8 Compare October 31, 2024 17:27

rijuma and others added 7 commits November 4, 2024 11:20

feat: Adding chat messages to the DB

99ccaa2

chore: Moved code to save the message to its own method

c419fde

feat: Added learning_assistant.enable_chat_history waffle flag

79917a5

feat: Added save_chat_message() to API

dae5df8

chore: Fixed coverage for CourseChatView

23fd013

fix: Swapped course id for course key

352340e

chore: Fixed patching on the CourseChatView unit tests

7cdc763

rijuma force-pushed the rijuma/save-messages-to-db branch from 8bc73aa to 7cdc763 Compare November 4, 2024 14:21

schenedx approved these changes Nov 4, 2024

View reviewed changes

alangsto requested changes Nov 4, 2024

View reviewed changes

fix: Added migration after updating role in model

f0b0cf8

rijuma force-pushed the rijuma/save-messages-to-db branch 2 times, most recently from c20a920 to 2fe0ceb Compare November 4, 2024 18:29

fix: Added course run key to save_chat_message()

4fa9bf5

rijuma force-pushed the rijuma/save-messages-to-db branch from 2fe0ceb to 4fa9bf5 Compare November 4, 2024 18:33

alangsto approved these changes Nov 4, 2024

View reviewed changes

rijuma merged commit 758b657 into main Nov 4, 2024
4 checks passed

rijuma deleted the rijuma/save-messages-to-db branch November 4, 2024 19:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Adding chat messages to the DB #121

feat: Adding chat messages to the DB #121

rijuma commented Oct 30, 2024 •

edited

Loading

github-actions bot commented Oct 30, 2024 •

edited

Loading

schenedx Oct 30, 2024

schenedx Oct 30, 2024

rijuma Oct 30, 2024

rijuma Oct 30, 2024

rijuma Oct 30, 2024 •

edited

Loading

rijuma Oct 30, 2024

schenedx Nov 4, 2024

rijuma Nov 4, 2024

schenedx Oct 30, 2024

rijuma Oct 30, 2024

alangsto Oct 30, 2024

rijuma Oct 30, 2024

alangsto Oct 30, 2024

rijuma Oct 30, 2024 •

edited

Loading

rijuma Oct 30, 2024

rijuma Oct 30, 2024

alangsto Oct 31, 2024

rijuma Oct 31, 2024

rijuma Oct 31, 2024

schenedx left a comment

schenedx Nov 4, 2024

alangsto Nov 4, 2024

rijuma Nov 4, 2024

rijuma Nov 4, 2024

rijuma commented Nov 4, 2024

		{'role': 'assistant', 'content': 'It is 4'},
		{'role': 'user', 'content': 'And what else?'},

		@@ -189,6 +191,24 @@ def get_course_id(course_run_id):
		return course_key


		def save_chat_message(user_id, chat_role, message):

feat: Adding chat messages to the DB #121

feat: Adding chat messages to the DB #121

Conversation

rijuma commented Oct 30, 2024 • edited Loading

github-actions bot commented Oct 30, 2024 • edited Loading

Coverage report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rijuma Oct 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rijuma Oct 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

schenedx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rijuma commented Nov 4, 2024

rijuma commented Oct 30, 2024 •

edited

Loading

github-actions bot commented Oct 30, 2024 •

edited

Loading

rijuma Oct 30, 2024 •

edited

Loading

rijuma Oct 30, 2024 •

edited

Loading