/pdf-chat

a AI bot will chat based on pdfs you give to them

Primary LanguagePython

PDF-Chat

Sure! Here's a refined description of the project:

The PDF-Chat project aims to develop a chatbot using OpenAI's GPT (Generative Pre-trained Transformer) language model and a vector database. The goal is to create a chatbot that can interact with users and provide responses based on natural language understanding and generation.

The chatbot's functionality will be specifically tailored to handle conversations related to PDF documents. Users will be able to ask questions, seek information, or request assistance regarding PDF-related topics. The chatbot will utilize the capabilities of GPT to comprehend user inputs and generate informative and contextually appropriate responses.

Prerequisites

To run the PDF-Chat project, you need to have the following prerequisites:

  • Python (version 3.8 or higher) installed on your machine.
  • The necessary Python packages and dependencies installed. You can find the required packages in the requirements.txt file of the project repository.

How to Run with Python3 and make

To run the PDF-Chat project using Python and make, follow these steps:

   git clone <repository_url> pdf-chat
   cd pdf-chat
   make install
   make run

How to Run via Docker

To run the PDF-Chat project using Docker, follow these steps:

docker build -t pdf_chat .
docker run -p 8599:8599 pdf_chat

For developers, I recommend
docker run -it -p 8599:8599 pdf_chat
playaround and test your code!

That's it! You can now use the PDF-Chat chatbot to have conversations related to PDF documents.

Please note that you will need to replace <repository_url> with the actual URL of this/forked repo

I hope this helps! Raise issues to clarify your doubts and notify bugs.

How to Contribute

We welcome contributions from the community! To get started, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your fork of the repository to your local machine.
  3. Create a new branch for your changes: git checkout -b your-feature-branch.
  4. Make your changes and commit them to your branch.
  5. Push your changes to your fork on GitHub.
  6. Open a pull request from your fork's branch to the main repository.

Please make sure to follow the Code of Conduct when contributing to this project.