Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
@@ -11,6 +11,119 @@ pinned: false
|
|
11 |
short_description: Streamlit template space
|
12 |
---
|
13 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
14 |
# Welcome to Streamlit!
|
15 |
|
16 |
Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
|
|
|
11 |
short_description: Streamlit template space
|
12 |
---
|
13 |
|
14 |
+
---
|
15 |
+
title: PDF Chat Assistant
|
16 |
+
emoji: π
|
17 |
+
colorFrom: blue
|
18 |
+
colorTo: purple
|
19 |
+
sdk: streamlit
|
20 |
+
sdk_version: 1.28.0
|
21 |
+
app_file: app.py
|
22 |
+
pinned: false
|
23 |
+
license: mit
|
24 |
+
---
|
25 |
+
|
26 |
+
# π PDF Chat Assistant
|
27 |
+
|
28 |
+
An intelligent PDF chat application that allows you to upload any PDF document and have natural conversations with its content using AI.
|
29 |
+
|
30 |
+
## π Features
|
31 |
+
|
32 |
+
- **π€ Easy PDF Upload**: Drag & drop or browse to upload PDF files
|
33 |
+
- **π€ AI-Powered Chat**: Ask questions and get intelligent answers about your document
|
34 |
+
- **πΎ Conversation Memory**: Maintains context throughout your chat session
|
35 |
+
- **π¨ Beautiful Interface**: Modern, responsive design with dark theme
|
36 |
+
- **β‘ Fast Processing**: Quick text extraction and real-time responses
|
37 |
+
- **π Privacy First**: Your documents are processed securely and not stored
|
38 |
+
|
39 |
+
## π How to Use
|
40 |
+
|
41 |
+
1. **π Enter your OpenAI API Key** in the sidebar
|
42 |
+
2. **π€ Upload a PDF file** using the file uploader
|
43 |
+
3. **β³ Wait** for text extraction (usually takes a few seconds)
|
44 |
+
4. **π¬ Start asking questions** about your document
|
45 |
+
5. **π― Get instant AI-powered answers**!
|
46 |
+
|
47 |
+
## π‘ Example Questions
|
48 |
+
|
49 |
+
- "What is this document about?"
|
50 |
+
- "Summarize the main points"
|
51 |
+
- "What are the key findings?"
|
52 |
+
- "Give me the contact information"
|
53 |
+
- "Explain the methodology used"
|
54 |
+
|
55 |
+
## π API Key Setup
|
56 |
+
|
57 |
+
To use this application, you'll need an OpenAI API key:
|
58 |
+
|
59 |
+
1. Visit [OpenAI Platform](https://platform.openai.com)
|
60 |
+
2. Sign up or log in to your account
|
61 |
+
3. Go to the **API Keys** section
|
62 |
+
4. Click **"Create new secret key"**
|
63 |
+
5. Copy the key and paste it in the sidebar
|
64 |
+
|
65 |
+
**Note**: Your API key is only used during your session and is never stored or shared.
|
66 |
+
|
67 |
+
## π οΈ Technical Details
|
68 |
+
|
69 |
+
- **Framework**: Streamlit
|
70 |
+
- **AI Model**: OpenAI GPT-3.5-turbo
|
71 |
+
- **PDF Processing**: PyPDF2
|
72 |
+
- **Hosting**: Hugging Face Spaces
|
73 |
+
|
74 |
+
## π― Use Cases
|
75 |
+
|
76 |
+
- **π Research**: Quickly understand academic papers and research documents
|
77 |
+
- **π Business**: Analyze reports, contracts, and business documents
|
78 |
+
- **π Education**: Study textbooks and educational materials
|
79 |
+
- **π Legal**: Review legal documents and contracts
|
80 |
+
- **π Reports**: Extract insights from data reports and presentations
|
81 |
+
|
82 |
+
## π Privacy & Security
|
83 |
+
|
84 |
+
- Documents are processed in real-time and not stored
|
85 |
+
- API keys are only used for the current session
|
86 |
+
- No data is collected or shared with third parties
|
87 |
+
- All processing happens securely in the cloud
|
88 |
+
|
89 |
+
## π± Responsive Design
|
90 |
+
|
91 |
+
The application works seamlessly on:
|
92 |
+
- π» Desktop computers
|
93 |
+
- π± Mobile devices
|
94 |
+
- πΊ Tablets
|
95 |
+
- π₯οΈ Large screens
|
96 |
+
|
97 |
+
## π€ Contributing
|
98 |
+
|
99 |
+
This is an open-source project. Feel free to:
|
100 |
+
- β Star the repository
|
101 |
+
- π Report bugs
|
102 |
+
- π‘ Suggest features
|
103 |
+
- π§ Submit pull requests
|
104 |
+
|
105 |
+
## π Support
|
106 |
+
|
107 |
+
If you encounter any issues:
|
108 |
+
1. Check that your API key is valid and has available credits
|
109 |
+
2. Ensure your PDF contains readable text (not just images)
|
110 |
+
3. Try with a smaller PDF file if processing fails
|
111 |
+
4. Refresh the page and try again
|
112 |
+
|
113 |
+
## π Credits
|
114 |
+
|
115 |
+
Built with β€οΈ using:
|
116 |
+
- [Streamlit](https://streamlit.io/) for the web interface
|
117 |
+
- [OpenAI](https://openai.com/) for AI capabilities
|
118 |
+
- [PyPDF2](https://pypdf2.readthedocs.io/) for PDF processing
|
119 |
+
- [Hugging Face Spaces](https://huggingface.co/spaces) for hosting
|
120 |
+
|
121 |
+
---
|
122 |
+
|
123 |
+
**π Start chatting with your PDFs today!**
|
124 |
+
|
125 |
+
Transform any PDF into an interactive conversation and unlock the power of AI-assisted document analysis.
|
126 |
+
|
127 |
# Welcome to Streamlit!
|
128 |
|
129 |
Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
|