refactor: move debugging assistant to examples

Author: maciejmajek

docs/debugging_assistant.md

@@ -22,7 +22,7 @@ The ROS 2 Debugging Assistant is an interactive tool that helps developers inspe
 
 ```sh
 source setup_shell.sh
-streamlit run src/rai_core/rai/tools/debugging_assistant.py
+streamlit run examples/debugging_assistant.py
 ```
 
 ## Usage Examples

examples/debugging_assistant.py

@@ -0,0 +1,50 @@
+# Copyright (C) 2024 Robotec.AI
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import streamlit as st
+from rai import get_llm_model
+from rai.agents.conversational_agent import create_conversational_agent
+from rai.frontend.streamlit import run_streamlit_app
+from rai.tools.ros2 import ROS2CLIToolkit
+
+
+@st.cache_resource
+def initialize_agent():
+    llm = get_llm_model(model_type="complex_model", streaming=True)
+    agent = create_conversational_agent(
+        llm,
+        ROS2CLIToolkit().get_tools(),
+        system_prompt="""You are a ROS 2 expert helping a user with their ROS 2 questions. You have access to various tools that allow you to query the ROS 2 system.
+                Be proactive and use the tools to answer questions. Retrieve as much information from the ROS 2 system as possible.
+                """,
+    )
+    return agent
+
+
+st.set_page_config(
+    page_title="ROS 2 Debugging Assistant",
+    page_icon=":robot:",
+)
+
+
+def main():
+    run_streamlit_app(
+        initialize_agent(),
+        page_title="ROS 2 Debugging Assistant",
+        initial_message="Hi! I am a ROS 2 assistant. How can I help you?",
+    )
+
+
+if __name__ == "__main__":
+    main()

src/rai_core/rai/tools/debugging_assistant.py

@@ -12,6 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from .cli import (
+    ROS2CLIToolkit,
+    ros2_action,
+    ros2_interface,
+    ros2_node,
+    ros2_param,
+    ros2_service,
+    ros2_topic,
+)
 from .generic import (
     CallROS2ServiceTool,
     CancelROS2ActionTool,
@@ -67,9 +76,16 @@
     "NavigateToPoseTool",
     "PublishROS2MessageTool",
     "ROS2ActionToolkit",
+    "ROS2CLIToolkit",
     "ROS2ServicesToolkit",
     "ROS2Toolkit",
     "ROS2TopicsToolkit",
     "ReceiveROS2MessageTool",
     "StartROS2ActionTool",
+    "ros2_action",
+    "ros2_interface",
+    "ros2_node",
+    "ros2_param",
+    "ros2_service",
+    "ros2_topic",
 ]

src/rai_core/rai/tools/ros2/__init__.py

@@ -16,7 +16,7 @@
 from threading import Timer
 from typing import List, Literal, Optional
 
-from langchain_core.tools import tool
+from langchain_core.tools import BaseTool, BaseToolkit, tool
 
 FORBIDDEN_CHARACTERS = ["&", ";", "|", "&&", "||", "(", ")", "<", ">", ">>", "<<"]
 
@@ -52,6 +52,18 @@ def run_command(cmd: List[str], timeout: int = 5):
     return str(output)
 
 
+class ROS2CLIToolkit(BaseToolkit):
+    def get_tools(self) -> List[BaseTool]:
+        return [
+            ros2_action,
+            ros2_service,
+            ros2_node,
+            ros2_param,
+            ros2_interface,
+            ros2_topic,
+        ]
+
+
 @tool
 def ros2_action(
     command: Literal["info", "list", "type", "send_goal"],