Muhammad Qasim
commited on
Commit
β’
61b3ea2
1
Parent(s):
5f0f939
Update README.md
Browse files
README.md
CHANGED
@@ -1,25 +1,27 @@
|
|
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 |
|
@@ -36,33 +38,33 @@ Before using the chatbot, ensure you have the following installed:
|
|
36 |
pip install -r requirements.txt
|
37 |
```
|
38 |
|
39 |
-
## Usage
|
40 |
|
41 |
1. Run the chatbot using the following command:
|
42 |
|
43 |
```shell
|
44 |
streamlit run app.py
|
45 |
```
|
46 |
-
3. The chatbot interface will open in your default web browser
|
47 |
-
4. Upload one or more PDF files for processing
|
48 |
-
5. Start a conversation by asking questions or making inquiries about the PDF content
|
49 |
-
6. The chatbot will provide responses based on the content of the uploaded PDFs
|
50 |
|
51 |
-
## Features
|
52 |
|
53 |
-
- Upload and process multiple PDF documents
|
54 |
-
- Query and discuss the contents of PDFs using natural language
|
55 |
-
- Integrates with powerful language models for accurate responses
|
56 |
-
- User-friendly web interface powered by Streamlit
|
57 |
|
58 |
-
## Contributing
|
59 |
Contributions are welcome! Please follow these steps to contribute to the project:
|
60 |
|
61 |
-
1. Fork the repository
|
62 |
-
2. Create a new branch for your feature or bug fix
|
63 |
-
3. Make your changes and commit them
|
64 |
-
4. Push your changes to your fork
|
65 |
-
5. Create a pull request to the main repository
|
66 |
|
67 |
## π₯ Show some support | Donation
|
68 |
|
|
|
1 |
+
# PDF Chatbot with Custom Data π
|
2 |
+
|
3 |
+
|
4 |
An interactive AI chatbot for querying and discussing the contents of PDF documents using Streamlit and AI language models.
|
5 |
|
6 |
#
|
7 |
+
## About the Project π
|
8 |
|
9 |
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.
|
10 |
|
11 |
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.
|
12 |
|
13 |
+
## Getting Started π
|
14 |
|
15 |
To get started with this project, follow the steps below.
|
16 |
|
17 |
+
### Prerequisites π οΈ
|
18 |
|
19 |
Before using the chatbot, ensure you have the following installed:
|
20 |
|
21 |
+
- Python 3.x π
|
22 |
+
- pip (Python package manager) π¦
|
23 |
|
24 |
+
### Installation βοΈ
|
25 |
|
26 |
1. Clone the repository:
|
27 |
|
|
|
38 |
pip install -r requirements.txt
|
39 |
```
|
40 |
|
41 |
+
## Usage π
|
42 |
|
43 |
1. Run the chatbot using the following command:
|
44 |
|
45 |
```shell
|
46 |
streamlit run app.py
|
47 |
```
|
48 |
+
3. The chatbot interface will open in your default web browser π
|
49 |
+
4. Upload one or more PDF files for processing π
|
50 |
+
5. Start a conversation by asking questions or making inquiries about the PDF content π¬
|
51 |
+
6. The chatbot will provide responses based on the content of the uploaded PDFs π§
|
52 |
|
53 |
+
## Features π
|
54 |
|
55 |
+
- Upload and process multiple PDF documents π
|
56 |
+
- Query and discuss the contents of PDFs using natural language π¬
|
57 |
+
- Integrates with powerful language models for accurate responses π‘
|
58 |
+
- User-friendly web interface powered by Streamlit π₯οΈ
|
59 |
|
60 |
+
## Contributing π€
|
61 |
Contributions are welcome! Please follow these steps to contribute to the project:
|
62 |
|
63 |
+
1. Fork the repositoryπ΄
|
64 |
+
2. Create a new branch for your feature or bug fix πΏ
|
65 |
+
3. Make your changes and commit them π»
|
66 |
+
4. Push your changes to your fork π
|
67 |
+
5. Create a pull request to the main repository π₯
|
68 |
|
69 |
## π₯ Show some support | Donation
|
70 |
|