AI Query Bot

A Configurable Retrieval-Augmented Generation (RAG) Pipeline Executor for Rocket.Chat

The AI Query Bot transforms Rocket.Chat into a powerful personal assistant. Whether you're managing work schedules, handling internal knowledge, or extracting insights from large discussions, this bot can find the answers you need.

Features 🚀

• Configurable RAG Pipeline: Customize the pipeline through the app's settings, controlling aspects such as the embedding/tokenizer engine, vector database, and more.
• Support for Multiple LLMs: Choose from various open-source LLMs like Mistral, Llama, and Phi for response generation.
• Interactive and User-Friendly: Users can interact with the bot using simple slash commands, making it easy to query information and receive summaries without needing to navigate away from the chat interface.
• Customizable Responses: Format responses in markdown, allowing for rich text outputs including bullet points, numbered lists, links, and more. This ensures that the responses are not only informative but also easy to read and understand.
• Secure and Efficient: Ensures secure communication while delivering accurate and contextually relevant responses.

How to set up 💻

1. Have a Rocket.Chat server ready. If you don't have a server, see this guide.
2. Install the Rocket.Chat Apps Engline CLI.

     npm install -g @rocket.chat/apps-cli
   

   Verify if the CLI has been installed

   rc-apps -v
   # @rocket.chat/apps-cli/1.4.0 darwin-x64 node-v10.15.3
   

3. Clone the GitHub Repository

   git clone https://github.com/RocketChat/Apps.Chat.Summarize.git

4. Install app dependencies

  cd app && npm install

5. To install private Rocket.Chat Apps on your server, it must be in development mode. Enable Apps development mode by navigating to Administration > General > Apps and turn on "Enable development mode".
6. Deploy the app to the server

rc-apps deploy --url <server_url> --username <username> --password <password>

• If you are running server locally, server_url is http://localhost:3000. If you are running in another port, change the 3000 to the appropriate port.
• username is the username of your admin user.
• password is the password of your admin user.

How to use 💬

After setting up, you can start using the AI Query Bot by typing /ask followed by your query in any Rocket.Chat channel,. The bot will process your query through the configured RAG pipeline and provide a concise, contextually relevant response.

Support us ❤️

If you like this project, please leave a star ⭐️. This helps more people to know this project.