Dabarqus Python Chatbot UI

DabarqusPythonChatbotUI is a user-friendly interface for interacting with the Dabarqus retrieval-augmented generation (RAG) system. It provides a chat-like interface where users can select memory banks and engage in conversations powered by Dabarqus's semantic search capabilities.

Features

• Interactive chat interface
• Memory bank selection
• Integration with Dabarqus API for semantic search
• Powered by Gradio for easy web deployment

Prerequisites

• Python 3.8+
• Dabarqus server running and accessible

Installation

Dabarqus Service

Important: This chatbot requires Dabarqus to be installed and running on your machine. Before using this chatbot, please ensure that you have:

• Downloaded and installed Dabarqus
• Started the Dabarqus service on your machine

The chatbot communicates with the Dabarqus service via its API, so having Dabarqus running is essential for the chatbot to function correctly. Once Dabarqus is set up and running, you can proceed with using this chatbot. For more information on how to start and manage the Dabarqus service, please refer to the Dabarqus documentation.

Chatbot installation

1. Clone the repository:
   git clone https://github.com/electricpipelines/DabarqusPythonChatbotUI.git
cd DabarqusChatbotUI
   The application will start and provide a local URL (usually http://127.0.0.1:7860). Open this URL in your web browser to access the chat interface.

2. Create a virtual environment (optional but recommended):
   python -m venv venv
source venv/bin/activate # On Windows, use 'venv\Scripts\activate'

3. Install the required dependencies:
   pip install -r requirements.txt

Running the Application

1. Ensure your Dabarqus server is running and accessible. (for more information, look here)

2. Start the Gradio application:
   python app.py

3. The application will start and provide a local URL (usually http://127.0.0.1:7860).

4. Open this URL in your web browser to access the chat interface.

Using the Chat Interface

1. Select a memory bank from the dropdown menu.
2. Type your message in the text box.
3. Click "Send" or press Enter to submit your query.
4. View the AI's response in the chat window.

File Structure

• app.py: Main application file containing the Gradio interface
• retriever.py: Contains functions for interacting with the Dabarqus API
• templates/: Directory containing prompt templates
• sample_prompt.md: Sample prompt file for the chatbot

License

TODO