Muhammad Qasim commited on
Commit
2807cf3
Β·
1 Parent(s): dfed07a

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +87 -0
README.md ADDED
@@ -0,0 +1,87 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # PDF Chatbot with Custom Data
2
+ An interactive AI chatbot for querying and discussing the contents of PDF documents using Streamlit and AI language models.
3
+
4
+ #
5
+ ## About the Project
6
+
7
+ This project provides a user-friendly interface to interact with AI language models and extract information from PDF documents. It's particularly useful for researchers, students, and professionals who need to quickly access and query the content of PDF files without manually skimming through pages.
8
+
9
+ The chatbot integrates with OpenAI's language models, making it capable of answering a wide range of questions and engaging in natural language conversations about the content within the uploaded PDFs.
10
+
11
+ ## Getting Started
12
+
13
+ To get started with this project, follow the steps below.
14
+
15
+ ### Prerequisites
16
+
17
+ Before using the chatbot, ensure you have the following installed:
18
+
19
+ - Python 3.x
20
+ - pip (Python package manager)
21
+
22
+ ### Installation
23
+
24
+ 1. Clone the repository:
25
+
26
+ ```shell
27
+ git clone https://github.com/yesbhautik/Talk-with-PDF.git
28
+ ```
29
+ 2. Navigate to the project directory:
30
+
31
+ ```shell
32
+ cd Talk-with-PDF
33
+ ```
34
+ 3. Install the required Python packages using pip:
35
+ ```shell
36
+ pip install -r requirements.txt
37
+ ```
38
+
39
+ ## Usage
40
+
41
+ 1. Run the chatbot using the following command:
42
+ ```shell
43
+ streamlit run app.py
44
+ ```
45
+ 2. The chatbot interface will open in your default web browser.
46
+ 3. Upload one or more PDF files for processing.
47
+ 4. Start a conversation by asking questions or making inquiries about the PDF content.
48
+ 5. The chatbot will provide responses based on the content of the uploaded PDFs.
49
+
50
+ ## Features
51
+
52
+ - Upload and process multiple PDF documents.
53
+ - Query and discuss the contents of PDFs using natural language.
54
+ - Integrates with powerful language models for accurate responses.
55
+ - User-friendly web interface powered by Streamlit.
56
+
57
+ ## Contributing
58
+ Contributions are welcome! Please follow these steps to contribute to the project:
59
+
60
+ 1. Fork the repository.
61
+ 2. Create a new branch for your feature or bug fix.
62
+ 3. Make your changes and commit them.
63
+ 4. Push your changes to your fork.
64
+ 5. Create a pull request to the main repository.
65
+
66
+ ## πŸ”₯ Show some support | Donation
67
+
68
+ If you find this repository helpful, show your support by giving it a 🌟! Your support means a lot to me and helps me keep contributing to the open-source community.
69
+
70
+ Also, if you'd like to support me financially, you can do so via my donation link: [https://go.yesbhautik.co.in/8i6wdu](https://go.yesbhautik.co.in/8i6wdu)
71
+ <br><br>
72
+ <a href="https://go.yesbhautik.co.in/8i6wdu">
73
+ <img src="https://www.pngall.com/wp-content/uploads/2016/05/PayPal-Donate-Button-Free-Download-PNG.png" alt="Donate" width="100">
74
+ </a>
75
+
76
+ ## πŸ’¬ Let's Connect
77
+
78
+ Feel free to reach out to us if you have questions, ideas, or simply want to chat. We're here to help and connect with the community.
79
+
80
+ - Website: [https://yesbhautik.co.in/](https://yesbhautik.co.in/)
81
+ - Another One: [https://yesbhautikx.co.in/](https://yesbhautikx.co.in/)
82
+ - LinkedIn profile: [https://www.linkedin.com/in/yesbhautik](https://www.linkedin.com/in/yesbhautik)
83
+ - Instagram page: [https://www.instagram.com/yesbhautik](https://www.instagram.com/yesbhautik)
84
+
85
+ ## πŸ“œ License
86
+
87
+ This repository is under the MIT License. For more information, see the [LICENSE](LICENSE) file.