Example question (#16)

* feat(postback.py): add example questions with quick replies

Adds example questions for different categories (law, housing, club,
activity, course, admin procedure) using quick replies.  Also adds a
hint in the welcome message to reset the bot if it becomes unresponsive.

The addition of example questions with quick replies enhances user
experience by providing guidance on the types of questions the bot can
answer. The hint in the welcome message provides a solution for users
experiencing issues with the bot's responsiveness.

* fix(common.py): increase loading animation duration to 60 seconds

The default loading animation duration is increased to prevent premature
termination of the animation, especially during longer operations.

* feat: add example question to clubs

* Add law example question

* fix(dify.py): reduce max_retries to 1 to prevent long delays

The number of retries was reduced to prevent the bot from taking too long to respond when the Dify server is down.

* Add course example question

Author: yenslife

linebot/app/api/dify.py

@@ -26,11 +26,11 @@ class DifyConfig:
 
     api_key: str
     base_url: str = "https://dify-ncku-chatbot.yenslife.top/v1"
-    max_retries: int = 3
+    max_retries: int = 1
     retry_delay: float = 1.0
 
 
-def retry_on_error(max_retries: int = 3, delay: float = 1.0):
+def retry_on_error(max_retries: int = 1, delay: float = 1.0):
     """Decorator for implementing retry logic."""
 
     def decorator(func):

linebot/app/services/handlers/common.py

@@ -37,7 +37,7 @@ def create_quick_reply() -> QuickReply:
     )
 
 
-def show_loading_animation(user_id, duration=5):
+def show_loading_animation(user_id, duration=60):
     """顯示 LINE Bot loading 動畫"""
     try:
         url = "https://api.line.me/v2/bot/chat/loading/start"

linebot/app/services/handlers/postback.py

@@ -17,7 +17,8 @@
 無論是校園資訊、活動查詢、選課資訊還是校內生活大小事，我都可以為你服務！
 你可以試試點選下方泡泡來問我
 或者直接傳訊息給我吧！我會盡快幫你找到答案喔～😉
-有問題也隨時告訴我，讓你的校園生活更便利！"""
+有問題也隨時告訴我，讓你的校園生活更便利！
+(小提示：如果你發現我變笨了，可以試著點選「清除對話紀錄」來重置我，這樣我就能重新學習了！)"""
 
 TERMS_MESSAGE = """📜 服務條款
     NCKU Chatbot 的回覆基於現有資料與自然語言處理技術，可能存在誤差或未能即時更新的情況。使用者應自行判斷回覆內容的準確性，並以學校官方公告與相關單位提供的資訊為準。本服務不對因使用 NCKU Chatbot 所產生的任何後果負責。
@@ -34,6 +35,15 @@ def create_quickreply():
     )
 
 
+def create_example_question_quickreply(questions: list[str]):
+    return QuickReply(
+        items=[
+            QuickReplyButton(action=MessageAction(label=question, text=f"{question}"))
+            for question in questions
+        ]
+    )
+
+
 def handle_postback_event(event):
     data = event.postback.data
     user_id = event.source.user_id
@@ -142,5 +152,83 @@ def handle_postback_event(event):
                 ),
             ),
         ]
+    ### Example Questions using quick reply
+    elif data == "example_question_law":
+        logger.info(f"User {user_id} requested example question for law.")
+        return [
+            TextSendMessage(
+                text="以下是一些關於成大法規的問題範例，您可以點選其中一個來詢問我：",
+                quick_reply=create_example_question_quickreply(
+                    [
+                        "如果我遇到性騷擾案件應該找誰處理？",
+                        "宿舍違規審議小組是什麼",
+                        "查詢圖書館室內空間使用規定",
+                    ]
+                ),
+            )
+        ]
+    elif data == "example_question_housing":
+        logger.info(f"User {user_id} requested example question for housing.")
+        return [
+            TextSendMessage(
+                text="以下是一些關於宿舍的問題範例，您可以點選其中一個來詢問我：",
+                quick_reply=create_example_question_quickreply(
+                    ["光二宿舍熱水時間", "住宿服務組在哪裡？", "宿舍收費標準？"]
+                ),
+            )
+        ]
+    elif data == "example_question_club":
+        logger.info(f"User {user_id} requested example question for club.")
+        return [
+            TextSendMessage(
+                text="以下是一些關於社團的問題範例，您可以點選其中一個來詢問我：",
+                quick_reply=create_example_question_quickreply(
+                    [
+                        "有沒有推薦的戶外社團？",
+                        "學校有熱舞社嗎？",
+                        "成大服務性質的社團有哪些？",
+                    ]
+                ),
+            )
+        ]
+    elif data == "example_question_activity":
+        logger.info(f"User {user_id} requested example question for activity.")
+        return [
+            TextSendMessage(
+                text="以下是一些關於學校活動的問題範例，您可以點選其中一個來詢問我：",
+                quick_reply=create_example_question_quickreply(
+                    [
+                        "成大的活動如何報名?",
+                        "我可以取消報名嗎？",
+                        "下星期成大的活動有哪些?",
+                        "有什麼通識講座可以參加?",
+                    ]
+                ),
+            )
+        ]
+    elif data == "example_question_course":
+        logger.info(f"User {user_id} requested example question for course.")
+        return [
+            TextSendMessage(
+                text="以下是一些關於課程的問題範例，您可以點選其中一個來詢問我：",
+                quick_reply=create_example_question_quickreply(
+                    [
+                        "有又甜又涼的通識嗎？",
+                        "有推薦的國文課嗎？",
+                        "成大有開設AI相關的課程嗎？",
+                    ]
+                ),
+            )
+        ]
+    elif data == "example_question_admin_procedure":
+        logger.info(f"User {user_id} requested example question for admin procedure.")
+        return [
+            TextSendMessage(
+                text="以下是一些關於常見行政手續的問題範例，您可以點選其中一個來詢問我：",
+                quick_reply=create_example_question_quickreply(
+                    ["機車證申請方式?", "學費申請流程?", "新生資料表填寫?"]
+                ),
+            )
+        ]
     else:
         logger.warning(f"Unknown postback data: {data} from user {user_id}")