Skip to content

Latest commit

 

History

History
92 lines (64 loc) · 3.43 KB

Readme.md

File metadata and controls

92 lines (64 loc) · 3.43 KB
Raw

Logo

DocuChat

Your interactive document companion.

View Demo . Report Bug . Request Feature

Contributors Forks

About The Project

Screen Shot

Step into the future of document interaction with DocuChat , an innovative solution brought to you by the collaborative efforts of NexTexh_Nexus team! Our vision is to redefine how you engage with your documents, making studying, researching, and exploring a more interactive and conversational experience than ever before.

Built With

  • Streamlit: is utilized to build the front-end of the application
  • Clarifai: is employed for handling LLMs (Language Model Models) and embedding models
  • LangChain: is employed to facilitate the creation of intricate chains and workflows

Features

  • Interactive PDF Conversations: Upload PDFs, ask questions, and get instant answers. Your documents become interactive companions.
  • Source Transparency: See the evidence behind each answer. DocuChat reveals the documents used to generate responses, adding credibility to your interactions.

Installation & Setup

  1. Clone the Repository: 
    git clone https://github.com/AB00k/NexTech_Nexus_DocuChat
  2. Install Dependencies: Make sure you have pip installed. Then, use the following command to install the necessary dependencies from the requirements.txt file: 
    pip install -r requirements.txt
  3. Navigate to the Project Directory: 
    cd .streamlit/secrets.toml
  4. Setup Secret Variables:
  • Fill in the necessary secret variables
  1. Run the Application: run app.py file using Streamlit.

Usage

Activate the DocuChat Assistant:

  • Login Put admin as Username and password, select your gender and press login
  • Upload your Document
  • Wait for the processing and you are good to go.

Creating A Pull Request

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/Feature)
  3. Commit your Changes (git commit -m 'Add some Feature')
  4. Push to the Branch (git push origin feature/Feature)
  5. Open a Pull Request

Contribution

We welcome contributions! Please follow the typical Git workflow:

  1. Fork the repository.
  2. Create a new branch for your feature or fix.
  3. Submit a pull request and we'll review as soon as possible.

License

This project is licensed under the MIT License. See LICENSE for more details (if provided in the repo).

Acknowledgements

  • Big shoutout to the entire Nextech-Nexus team for their hard work and dedication.
  • Special thanks to the open-source community for providing valuable tools and resources.