feat: support images understaning in debugging assistant for local model

[boczekbartek]

Purpose

• Support image understanding features for local models

[!NOTE] Please don't squash commits on merge, they are loosely related

Proposed Changes

• add GetRos2Image tool to debugging_assistant
• describe details of ollama setup with OpenAI API
• describe ollama setup with local VLMs for tool calling
• fix path to debugging_assistant in docs

Issues

Testing

• ollama model shoud be created as described in updated docs
• config shoud be changed as described in updated docs
• streamlit should be run as described in updated docs
• I started manipulation demo binary in the background.

This is the conversation print that I got: ROS 2 Debugging Assistant - llama3.2-vision-tools.pdf

Please note that in my tests:

• Model hallucinates and calls too many tools, but the setup works (it called tool to get an image, then looked and interpreted the image)
• For better models and prompt engineering performance should be better, this PR is an example of rai setup

Summary by CodeRabbit

• New Features

  • Enhanced the debugging assistant with image retrieval capabilities for improved troubleshooting workflows.

• Documentation

  • Updated launch instructions for the debugging assistant.
  • Expanded vendor guides with detailed setup instructions for configuring the Ollama server, OpenAI-compatible APIs, and vision model examples.

[boczekbartek]

@coderabbitai full review

[coderabbitai[bot]]

Walkthrough

This pull request updates the documentation and the debugging assistant tool. The documentation now reflects a new path for launching the debugging assistant and includes additional instructions for configuring the Ollama server with OpenAI-compatible APIs and vision models. In the code, the initialize_graph function is enhanced by initializing the ROS 2 client library, creating a ROS2 connector, and integrating a new image retrieval tool for ROS 2, without altering the overall functionality.

Changes

File(s)	Change Summary
docs/debugging_assistant.md docs/vendors.md	docs/debugging_assistant.md: Updated the command path from src/rai/rai/tools/debugging_assistant.py to src/rai_core/rai/tools/debugging_assistant.py. docs/vendors.md: Expanded instructions for configuring the Ollama server, including detailed sections for setting up OpenAI APIs and vision model configurations.
src/rai_core/.../debugging_assistant.py	Modified the initialize_graph function by calling rclpy.init(), creating a new ROS2ARIConnector, and adding GetROS2ImageTool(connector) to the list of agent tools for ROS 2 image retrieval.

Sequence Diagram(s)

sequenceDiagram
    participant Main
    participant initGraph as initialize_graph()
    participant rclpy
    participant ROS2Connector as ROS2ARIConnector
    participant ImageTool as GetROS2ImageTool
    participant Agent

    Main->>initGraph: Call initialize_graph()
    initGraph->>rclpy: rclpy.init()
    initGraph->>ROS2Connector: Create new ROS2ARIConnector instance
    initGraph->>ImageTool: Instantiate GetROS2ImageTool(connector)
    initGraph->>Agent: Call create_conversational_agent(tools list)
    Agent-->>Main: Return agent instance

Possibly related PRs

• RobotecAI/rai#326: Introduces an interactive interface for the debugging assistant, involving modifications to debugging_assistant.py, which relates to the command path updates and enhanced functionalities in this PR.

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.