add option to clear history in cli

reginald/cli.py

@@ -103,6 +103,11 @@ def run_all(
         str, typer.Option(envvar="LLAMA_INDEX_DEVICE", help=HELP_TEXT["device"])
     ] = DEFAULT_ARGS["device"],
 ) -> None:
+    """
+    Run all the components of the Reginald slack bot.
+    Establishes the connection to the Slack API, sets up the bot,
+    and creates a Reginald model to query from.
+    """
     set_up_logging_config(level=20)
     main(
         cli="run_all",
@@ -136,7 +141,7 @@ def bot(
     ] = EMOJI_DEFAULT,
 ) -> None:
     """
-    Main function to run the Slack bot which sets up the bot
+    Run the Slack bot which sets up the bot
     (which uses an API for responding to messages) and
     then establishes a WebSocket connection to the
     Socket Mode servers and listens for events.
@@ -214,8 +219,8 @@ def app(
     ] = DEFAULT_ARGS["device"],
 ) -> None:
     """
-    Main function to run the app which sets up the response model
-    and then creates a FastAPI app to serve the model.
+    Sets up the response model and then creates a
+    FastAPI app to serve the model.
 
     The app listens on port 8000 and has two endpoints:
     - /direct_message: for obtaining responses from direct messages
@@ -263,6 +268,9 @@ def create_index(
         int, typer.Option(envvar="LLAMA_INDEX_NUM_OUTPUT")
     ] = DEFAULT_ARGS["num_output"],
 ) -> None:
+    """
+    Create an index for the Reginald model.
+    """
     set_up_logging_config(level=20)
     main(
         cli="create_index",
@@ -346,6 +354,9 @@ def chat(
         str, typer.Option(envvar="LLAMA_INDEX_DEVICE", help=HELP_TEXT["device"])
     ] = DEFAULT_ARGS["device"],
 ) -> None:
+    """
+    Run the chat interaction with the Reginald model.
+    """
     set_up_logging_config(level=40)
     main(
         cli="chat",

reginald/models/models/base.py

@@ -28,6 +28,7 @@ def __init__(self, emoji: Optional[str], *args: Any, **kwargs: Any):
             Emoji to use for the bot's response
         """
         self.emoji = emoji
+        self.mode = "NA"
 
     def direct_message(self, message: str, user_id: str) -> MessageResponse:
         raise NotImplementedError

reginald/run.py

@@ -21,7 +21,7 @@
 LISTENING_MSG: Final[str] = "Listening for requests..."
 
 
-async def run_bot(api_url: str | None, emoji: str):
+async def run_bot(api_url: str | None, emoji: str) -> None:
     if api_url is None:
         logging.error(
             "API URL is not set. Please set the REGINALD_API_URL "
@@ -44,7 +44,7 @@ async def run_reginald_app(**kwargs) -> None:
     uvicorn.run(app, host="0.0.0.0", port=8000)
 
 
-async def run_full_pipeline(**kwargs):
+async def run_full_pipeline(**kwargs) -> None:
     # set up response model
     response_model = setup_llm(**kwargs)
     bot = setup_slack_bot(response_model)
@@ -56,20 +56,32 @@ async def run_full_pipeline(**kwargs):
 def run_chat_interact(streaming: bool = False, **kwargs) -> ResponseModel:
     # set up response model
     response_model = setup_llm(**kwargs)
+    user_id = "command_line_chat"
+
     while True:
         message = input(">>> ")
         if message in ["exit", "exit()", "quit()", "bye Reginald"]:
             return response_model
+        if message in ["clear_history", "\clear_history"]:
+            if (
+                response_model.mode == "chat"
+                and response_model.chat_engine.get(user_id) is not None
+            ):
+                response_model.chat_engine[user_id].reset()
+                print("\nReginald: History cleared.")
+            else:
+                print("\nReginald: No history to clear.")
+            continue
 
         if streaming:
-            response = response_model.stream_message(message=message, user_id="chat")
+            response = response_model.stream_message(message=message, user_id=user_id)
             print("")
         else:
-            response = response_model.direct_message(message=message, user_id="chat")
+            response = response_model.direct_message(message=message, user_id=user_id)
             print(f"\nReginald: {response.message}")
 
 
-async def connect_client(client: SocketModeClient):
+async def connect_client(client: SocketModeClient) -> None:
     await client.connect()
     # listen for events
     logging.info(LISTENING_MSG)

tests/test_chat_interact.py

@@ -53,3 +53,19 @@ def test_chat_interact_bye():
     with mock.patch.object(builtins, "input", lambda _: "bye Reginald"):
         interaction = run_chat_interact(model="hello")
     assert isinstance(interaction, Hello)
+
+
+def test_chat_interact_clear_history():
+    result = runner.invoke(cli, ["chat"], input="clear_history\n")
+    term_stdout_lines: list[str] = result.stdout.split("\n")
+    assert term_stdout_lines[0] == ">>> "
+    assert term_stdout_lines[1] == "Reginald: No history to clear."
+    assert term_stdout_lines[2] == ">>> "
+
+
+def test_chat_interact_slash_clear_history():
+    result = runner.invoke(cli, ["chat"], input="\clear_history\n")
+    term_stdout_lines: list[str] = result.stdout.split("\n")
+    assert term_stdout_lines[0] == ">>> "
+    assert term_stdout_lines[1] == "Reginald: No history to clear."
+    assert term_stdout_lines[2] == ">>> "