feat: support feedback message (#781)

Author: iziang

aperag/api/components/schemas/chat.yaml

@@ -55,15 +55,8 @@ chatMessage:
       type: array
       items:
         type: string
-    upvote:
-      type: number
-    downvote:
-      type: number
-    revised_answer:
-      type: string
-    feed_back_status:
-      type: string
-      enum: [PENDING, RUNNING, COMPLETE, FAILED]
+    feedback:
+      $ref: './feedback.yaml#/feedback'
 
 chatDetails:
   type: object

aperag/api/components/schemas/feedback.yaml

@@ -1,9 +1,18 @@
 feedback:
   type: object
   properties:
-    upvote:
-      type: integer
-    downvote:
-      type: integer
-    revised_answer:
+    type:
       type: string
+      enum:
+        - good
+        - bad
+    tag:
+      type: string
+      enum:
+        - Harmful
+        - Unsafe
+        - Fake
+        - Unhelpful
+        - Other
+    message:
+      type: string

aperag/chat/message.py

@@ -21,7 +21,7 @@
 from aperag.views.utils import fail
 
 
-async def feedback_message(user, chat_id, message_id, upvote, downvote, revised_answer=None):
+async def feedback_message(user, chat_id, message_id, feedback_type=None, feedback_tag=None, feedback_message=None):
     history = RedisChatMessageHistory(chat_id, redis_client=get_async_redis_client())
     msg = None
     for message in await history.messages:
@@ -33,17 +33,26 @@ async def feedback_message(user, chat_id, message_id, upvote, downvote, revised_
         msg = item
     if msg is None:
         return fail(HTTPStatus.NOT_FOUND, "Message not found")
+
+    # If feedback_type is None, delete the feedback record
+    if feedback_type is None:
+        try:
+            feedback = await MessageFeedback.objects.aget(
+                user=user, chat_id=chat_id, message_id=message_id)
+            await feedback.adelete()
+            return None
+        except MessageFeedback.DoesNotExist:
+            return None
+
+    # Otherwise create or update the feedback record
     data = {
         "question": msg["query"],
         "original_answer": msg.get("response", ""),
+        "type": feedback_type,
+        "tag": feedback_tag,
+        "message": feedback_message,
     }
-    if upvote is not None:
-        data["upvote"] = upvote
-    if downvote is not None:
-        data["downvote"] = downvote
 
-    if revised_answer is not None:
-        data["revised_answer"] = revised_answer
     data["status"] = MessageFeedback.Status.PENDING
     collection_id = msg.get("collection_id", None)
     feedback, _ = await MessageFeedback.objects.aupdate_or_create(

aperag/db/models.py

@@ -270,12 +270,24 @@ class Status(models.TextChoices):
         COMPLETE = "COMPLETE"
         FAILED = "FAILED"
 
+    class Type(models.TextChoices):
+        GOOD = "good"
+        BAD = "bad"
+
+    class Tag(models.TextChoices):
+        HARMFUL = "Harmful"
+        UNSAFE = "Unsafe"
+        FAKE = "Fake"
+        UNHELPFUL = "Unhelpful"
+        OTHER = "Other"
+
     user = models.CharField(max_length=256)
     collection_id = models.CharField(max_length=24, null=True, blank=True)
     chat_id = models.CharField(max_length=24)
     message_id = models.CharField(max_length=256)
-    upvote = models.IntegerField(default=0)
-    downvote = models.IntegerField(default=0)
+    type = models.CharField(max_length=16, choices=Type.choices, null=True)
+    tag = models.CharField(max_length=16, choices=Tag.choices, null=True)
+    message = models.TextField(null=True, blank=True)
     relate_ids = models.TextField(null=True)
     question = models.TextField(null=True, blank=True)
     status = models.CharField(max_length=16, choices=Status.choices, null=True)

aperag/migrations/0004_remove_messagefeedback_downvote_and_more.py

@@ -0,0 +1,48 @@
+# Generated by Django 5.0.14 on 2025-04-29 15:23
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("aperag", "0003_modelserviceprovider_dialect"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="messagefeedback",
+            name="downvote",
+        ),
+        migrations.RemoveField(
+            model_name="messagefeedback",
+            name="upvote",
+        ),
+        migrations.AddField(
+            model_name="messagefeedback",
+            name="message",
+            field=models.TextField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="messagefeedback",
+            name="tag",
+            field=models.CharField(
+                choices=[
+                    ("Harmful", "Harmful"),
+                    ("Unsafe", "Unsafe"),
+                    ("Fake", "Fake"),
+                    ("Unhelpful", "Unhelpful"),
+                    ("Other", "Other"),
+                ],
+                max_length=16,
+                null=True,
+            ),
+        ),
+        migrations.AddField(
+            model_name="messagefeedback",
+            name="type",
+            field=models.CharField(
+                choices=[("good", "Good"), ("bad", "Bad")], max_length=16, null=True
+            ),
+        ),
+    ]

aperag/views/feishu.py

@@ -82,7 +82,7 @@ def get_user_access_token(request, code, redirect_uri):
     return success({"token": token})
 
 
-def build_card_content(chat_id, message_id, message, upvote=False, downvote=False):
+def build_card_content(chat_id, message_id, message, feedback_type=None):
     return {
         "config": {
             "wide_screen_mode": True
@@ -101,9 +101,9 @@ def build_card_content(chat_id, message_id, message, upvote=False, downvote=Fals
                             "tag": "plain_text",
                             "content": "赞"
                         },
-                        "type": "primary" if upvote else "default",
+                        "type": "primary" if feedback_type == "good" else "default",
                         "value": {
-                            "upvote": True,
+                            "type": "good",
                             "message_id": f"{message_id}",
                             "chat_id": f"{chat_id}",
                         }
@@ -114,9 +114,9 @@ def build_card_content(chat_id, message_id, message, upvote=False, downvote=Fals
                             "tag": "plain_text",
                             "content": "踩"
                         },
-                        "type": "primary" if downvote else "default",
+                        "type": "primary" if feedback_type == "bad" else "default",
                         "value": {
-                            "downvote": True,
+                            "type": "bad",
                             "message_id": f"{message_id}",
                             "chat_id": f"{chat_id}",
                         }
@@ -128,10 +128,10 @@ def build_card_content(chat_id, message_id, message, upvote=False, downvote=Fals
     }
 
 
-def build_card_data(chat_id, message_id, message, upvote=False, downvote=False):
+def build_card_data(chat_id, message_id, message, feedback_type=None):
     return {
         "msg_type": "interactive",
-        "content": json.dumps(build_card_content(chat_id, message_id, message, upvote, downvote)),
+        "content": json.dumps(build_card_content(chat_id, message_id, message, feedback_type)),
     }
 
 
@@ -173,9 +173,8 @@ async def feishu_response_card_update(user, bot_id, data):
     value = action["value"]
     chat_id = value["chat_id"]
     msg_id = value["message_id"]
-    upvote = value.get("upvote", None)
-    downvote = value.get("downvote", None)
-    await aperag.chat.message.feedback_message(user, chat_id, msg_id, upvote, downvote, "")
+    feedback_type = value.get("type", None)
+    await aperag.chat.message.feedback_message(user, chat_id, msg_id, feedback_type, None, None)
 
     bot = await query_bot(user, bot_id)
     bot_config = json.loads(bot.config)
@@ -192,7 +191,7 @@ async def feishu_response_card_update(user, bot_id, data):
     }
     client = FeishuClient(ctx)
     token = data["token"]
-    card = build_card_content(chat_id, msg_id, msg_cache[msg_id], upvote, downvote)
+    card = build_card_content(chat_id, msg_id, msg_cache[msg_id], feedback_type)
     card["open_ids"] = [data["open_id"]]
     data = {
         "token": token,

aperag/views/main.py

@@ -844,13 +844,7 @@ async def feedback_message(request, bot_id: str, chat_id: str, message_id: str,
     chat = await query_chat(user, bot_id, chat_id)
     if chat is None:
         return fail(HTTPStatus.NOT_FOUND, "Chat not found")
-    feedback = await aperag.chat.message.feedback_message(chat.user, chat_id, message_id, msg_in.upvote,
-                                                            msg_in.downvote,
-                                                            msg_in.revised_answer)
-
-    # embedding the revised answer
-    if msg_in.revised_answer is not None:
-        message_feedback.delay(feedback_id=feedback.id)
+    feedback = await aperag.chat.message.feedback_message(chat.user, chat_id, message_id, msg_in.type, msg_in.tag, msg_in.message)
     return success({})
 
 

aperag/views/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.merged.yaml
-#   timestamp: 2025-04-28T12:29:12+00:00
+#   timestamp: 2025-04-29T15:27:05+00:00
 
 from __future__ import annotations
 
@@ -97,6 +97,12 @@ class Reference(BaseModel):
     metadata: Optional[dict[str, Any]] = None
 
 
+class Feedback(BaseModel):
+    type: Optional[Literal['good', 'bad']] = None
+    tag: Optional[Literal['Harmful', 'Unsafe', 'Fake', 'Unhelpful', 'Other']] = None
+    message: Optional[str] = None
+
+
 class ChatMessage(BaseModel):
     id: Optional[str] = None
     type: Optional[Literal['welcome', 'message', 'start', 'stop', 'error']] = None
@@ -105,12 +111,7 @@ class ChatMessage(BaseModel):
     data: Optional[str] = None
     references: Optional[list[Reference]] = None
     urls: Optional[list[str]] = None
-    upvote: Optional[float] = None
-    downvote: Optional[float] = None
-    revised_answer: Optional[str] = None
-    feed_back_status: Optional[Literal['PENDING', 'RUNNING', 'COMPLETE', 'FAILED']] = (
-        None
-    )
+    feedback: Optional[Feedback] = None
 
 
 class ChatDetails(BaseModel):
@@ -131,12 +132,6 @@ class ChatUpdate(BaseModel):
     title: Optional[str] = None
 
 
-class Feedback(BaseModel):
-    upvote: Optional[int] = None
-    downvote: Optional[int] = None
-    revised_answer: Optional[str] = None
-
-
 class Local(BaseModel):
     path: Optional[str] = None
 

aperag/views/utils.py

@@ -72,10 +72,11 @@ async def query_chat_messages(user: str, chat_id: str) -> list[view_models.ChatM
             msg.urls = item.get("urls", [])
         feedback = feedback_map.get(item.get("id", ""), None)
         if role == "ai" and feedback:
-            msg.upvote = feedback.upvote
-            msg.downvote = feedback.downvote
-            msg.revised_answer = feedback.revised_answer
-            msg.feed_back_status = feedback.status
+            msg.feedback = view_models.Feedback(
+                type=feedback.type,
+                tag=feedback.tag,
+                message=feedback.message
+            )
         messages.append(msg)
     return messages
 

aperag/views/web.py

@@ -126,7 +126,7 @@ async def feedback_message(request, bot_id: str, chat_id: str, message_id: str,
     if chat is None:
         return fail(HTTPStatus.NOT_FOUND, "Chat not found")
 
-    await aperag.chat.message.feedback_message(chat.user, chat_id, message_id, msg_in.upvote, msg_in.downvote)
+    await aperag.chat.message.feedback_message(chat.user, chat_id, message_id, msg_in.type, msg_in.tag, msg_in.message)
     return success({})