Diamante-whitepaper RAG-based Chatbot

Welcome to the Diamante-Whiteboard RAG-based Chatbot project! This repository is created for the submission of our project in the Diamante Hackathon. Our goal is to develop a chatbot that simplifies the process of understanding and navigating the Diamante-Whiteboard PDF document using Retrieval-Augmented Generation (RAG) technology.

Table of Contents

• Introduction
• Features
• Installation
• Usage
• Contributing
• License
• Contact

Introduction

The Diamante-Whiteboard RAG-based Chatbot leverages the power of RAG to provide users with accurate and contextually relevant responses based on the content of the Diamante-Whiteboard PDF. This chatbot aims to enhance user experience by making it easier to access and understand the information within the PDF.

Features

• Intelligent Q&A: Ask questions related to the Diamante-Whiteboard PDF and get answers.
• Context Awareness: The chatbot understands the context of your queries to provide relevant information.
• User-friendly Interface: Easy to use and interact with, making information retrieval simple and efficient.

Installation

To run the chatbot locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/sumenchalla/diamante-hackathon.git
   cd diamante-whiteboard-chatbot

2. Set up 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

4. Download the Diamante-Whiteboard PDF and place it in the project directory.

5. Run the chatbot:

   python app.py

6. Run the front end:

Usage

Once the chatbot is running, you can interact with it via the provided interface. Simply type your questions related to the Diamante-whitepaper PDF, and the chatbot will retrieve and generate answers based on the document's content.

Contributing

We welcome contributions from the community! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Make your changes.
4. Commit your changes:

   git commit -m "Add your commit message"

5. Push to the branch:

   git push origin feature/your-feature-name

6. Open a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact

If you have any questions or need further assistance, feel free to contact us:

• Project Maintainers: Challa Sumen , Devendra Royal
• GitHub: yourusername
• GitHub: yourusername

We hope you find this project useful and look forward to your contributions!

---

Happy Coding! 🚀