Fiqa commited on
Commit
ac013c2
Β·
verified Β·
1 Parent(s): 9205180

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +76 -10
README.md CHANGED
@@ -1,13 +1,79 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
- title: ChatWithData
3
- emoji: πŸ“‰
4
- colorFrom: pink
5
- colorTo: blue
6
- sdk: streamlit
7
- sdk_version: 1.41.1
8
- app_file: app.py
9
- pinned: false
10
- short_description: A simplistic tool to query PDF AND PPTS
 
 
 
 
 
 
 
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
1
+ Here’s the updated `README.md` without the "How to Run Locally" part:
2
+
3
+ ---
4
+
5
+ # Chat With Documents πŸ€–πŸ“„
6
+
7
+ Welcome to the **Chat with Documents** app! πŸš€ This Streamlit app allows you to upload PDF and PPT files, extract their content, store the extracted text in a vector store, and interact with it using natural language queries! πŸ€–πŸ’¬
8
+
9
+ Built with **LangChain**, **OpenAI**, **Streamlit**, and **Astra DB**, this project leverages the power of LLMs (Large Language Models) to allow users to chat with their documents like never before. 🧠
10
+
11
+ ---
12
+
13
+ ### πŸš€ **Features**
14
+
15
+ - **PDF & PPT Extraction**: Upload PDF and PowerPoint files to extract text! πŸ“„βž‘οΈπŸ“
16
+ - **Vector Store**: Automatically stores extracted text in a **Cassandra** vector store. πŸ”πŸ“š
17
+ - **Ask Anything**: Ask questions about the document, and get answers powered by **OpenAI**! πŸ€–β“
18
+
19
+ ---
20
+
21
+ ### πŸ› οΈ **Tech Stack**
22
+ - **Streamlit**: Frontend framework to interact with the app.
23
+ - **LangChain**: For seamless document processing and querying.
24
+ - **OpenAI**: For LLM integration to provide intelligent responses.
25
+ - **Astra DB**: Database for storing and managing vectorized text data.
26
+ - **Python Libraries**: PyPDF2, python-pptx, cassio, and more.
27
+
28
+ ---
29
+
30
+ ### 🌍 **Deployment**
31
+
32
+ This project is designed to be deployed on **Hugging Face Spaces**. Just upload your code, and it will run in the cloud! 🌩️
33
+
34
+ Make sure to configure the **Secrets** in Hugging Face Spaces for storing your sensitive API keys securely! πŸ”’
35
+
36
+ ---
37
+
38
+ ### πŸ’‘ **How It Works**
39
+
40
+ - Upload a **PDF** or **PPT** file using the file uploader. πŸ“€
41
+ - The app will extract text from the file using **PyPDF2** (for PDFs) or **python-pptx** (for PPTs). πŸ“„βž‘οΈπŸ“
42
+ - The extracted text is split into manageable chunks using **LangChain's CharacterTextSplitter**. βœ‚οΈ
43
+ - The chunks are then added to **Cassandra** as vectorized data using **OpenAI embeddings**. πŸ”„
44
+ - Ask any query about the content of your document, and the app will respond using the power of **OpenAI**! πŸ€–πŸ’¬
45
+
46
+ ---
47
+
48
+ ### 🎯 **Why Use This?**
49
+
50
+ - **Make documents interactive**: Easily explore the content of your documents by asking questions.
51
+ - **Quick retrieval**: With the text stored in a vector store, you can query the content efficiently.
52
+ - **Secure API keys**: API keys are securely managed using environment variables and **Hugging Face Spaces Secrets**. πŸ”‘πŸ’Ό
53
+
54
+ ---
55
+
56
+ ### 🀝 **Contributing**
57
+
58
+ Feel free to fork this repo and submit issues or pull requests for any bugs or improvements. Contributions are welcome! πŸ™Œ
59
+
60
  ---
61
+
62
+ ### πŸ§‘β€πŸ’» **License**
63
+
64
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
65
+
66
+ ---
67
+
68
+ ### πŸ“ **Note**
69
+
70
+ Remember to add your API keys and check the environment variables! If you're using Hugging Face Spaces, ensure your keys are added to the **Secrets** section. πŸ”
71
+
72
+ ---
73
+
74
+ ### ✨ **Enjoy the App!** ✨
75
+ Now, go ahead and chat with your documents! πŸ˜„
76
+
77
  ---
78
 
79
+ This version now only focuses on the app’s features and deployment, making it more suited for hosting and sharing on Hugging Face Spaces!