Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,19 +1,78 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
sdk: docker
|
| 7 |
app_port: 8501
|
| 8 |
-
tags:
|
| 9 |
-
- streamlit
|
| 10 |
pinned: false
|
| 11 |
-
short_description: Streamlit template space
|
| 12 |
---
|
| 13 |
|
| 14 |
-
#
|
| 15 |
|
| 16 |
-
|
| 17 |
|
| 18 |
-
|
| 19 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: Document Parser GPT
|
| 3 |
+
emoji: 📄
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: indigo
|
| 6 |
sdk: docker
|
| 7 |
app_port: 8501
|
|
|
|
|
|
|
| 8 |
pinned: false
|
|
|
|
| 9 |
---
|
| 10 |
|
| 11 |
+
# 📄 Document Parser GPT (Streamlit + LLMs)
|
| 12 |
|
| 13 |
+
Upload documents (PDF, DOCX, TXT, etc.) and chat with them using a GPT-4 powered assistant.
|
| 14 |
|
| 15 |
+
Built with:
|
| 16 |
+
|
| 17 |
+
- 🔷 [Streamlit](https://streamlit.io/)
|
| 18 |
+
- 🧠 OpenAI GPT models
|
| 19 |
+
- 📚 LlamaIndex (optional, for RAG)
|
| 20 |
+
- 🗂 File parsing: PDF, DOCX, TXT, HTML
|
| 21 |
+
|
| 22 |
+
---
|
| 23 |
+
|
| 24 |
+
## 🚀 Features
|
| 25 |
+
|
| 26 |
+
✅ Upload multiple document types
|
| 27 |
+
✅ Ask natural language questions
|
| 28 |
+
✅ Adjustable temperature setting
|
| 29 |
+
✅ Download conversation history (TXT or JSON)
|
| 30 |
+
✅ Clean UI built with Streamlit
|
| 31 |
+
✅ Runs in Docker (Hugging Face Space compatible)
|
| 32 |
+
|
| 33 |
+
---
|
| 34 |
+
|
| 35 |
+
## 🔧 How to Configure
|
| 36 |
+
|
| 37 |
+
1. **API Key**
|
| 38 |
+
Paste your OpenAI API key in the sidebar inside the app.
|
| 39 |
+
|
| 40 |
+
2. **Model Temperature**
|
| 41 |
+
Adjust how creative or focused GPT’s responses are.
|
| 42 |
+
|
| 43 |
+
3. **File Types Supported**
|
| 44 |
+
PDF, DOCX, TXT, RTF, HTML.
|
| 45 |
+
|
| 46 |
+
---
|
| 47 |
+
|
| 48 |
+
## 💡 Example Use Cases
|
| 49 |
+
|
| 50 |
+
- Summarizing legal documents
|
| 51 |
+
- Extracting info from academic papers
|
| 52 |
+
- Chatting with contracts or business reports
|
| 53 |
+
- Building a Q&A assistant over personal notes
|
| 54 |
+
|
| 55 |
+
---
|
| 56 |
+
|
| 57 |
+
## 🐳 Docker Instructions (Handled by HF Space)
|
| 58 |
+
|
| 59 |
+
This app uses a `Dockerfile` to install dependencies and run Streamlit. No manual setup needed on your end.
|
| 60 |
+
|
| 61 |
+
Make sure you have:
|
| 62 |
+
|
| 63 |
+
- `Dockerfile` at the root
|
| 64 |
+
- `requirements.txt` listing Python dependencies
|
| 65 |
+
- `src/streamlit_app.py` as your main app script
|
| 66 |
+
|
| 67 |
+
---
|
| 68 |
+
|
| 69 |
+
## 🛡️ Notes
|
| 70 |
+
|
| 71 |
+
- No OpenAI key is stored or logged — it’s used only at runtime in your session.
|
| 72 |
+
- This app does **not** send uploaded files anywhere; all processing is local in the container.
|
| 73 |
+
|
| 74 |
+
---
|
| 75 |
+
|
| 76 |
+
## 🙋♂️ Support
|
| 77 |
+
|
| 78 |
+
Having issues? Open a Discussion or File an Issue on the repository.
|