MrHalk commited on
Commit
b275738
Β·
verified Β·
1 Parent(s): d16f66c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +66 -10
README.md CHANGED
@@ -1,13 +1,69 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
- title: Pdf Chat Bot
3
- emoji: πŸ‘
4
- colorFrom: blue
5
- colorTo: blue
6
- sdk: streamlit
7
- sdk_version: 1.42.0
8
- app_file: app.py
9
- pinned: false
10
- short_description: This project is a Streamlit-based application.
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Pdf Chat Bot
3
+ emoji: πŸ‘
4
+ colorFrom: blue
5
+ colorTo: blue
6
+ sdk: streamlit
7
+ sdk_version: 1.42.0
8
+ app_file: app.py
9
+ pinned: false
10
+ short_description: This project is a Streamlit-based application.
11
+ thumbnail: >-
12
+ https://cdn-uploads.huggingface.co/production/uploads/662ba6f848b0b3742e6f9261/sYYSsREDiHjnWpDR4jBFS.png
13
+ ---
14
+ # PDF-Chat-Bot
15
+ Upload the PDF Files and ask questions
16
+
17
+ ## To see Preview
18
+ https://pdf-chat-bot-arman.streamlit.app/
19
+
20
+ # Also hosted on Huggingface
21
+ https://huggingface.co/spaces/MrHalk/pdf-chat-bot
22
+
23
+ # Chat with PDF using Gemini πŸ’
24
+
25
+ This project is a **Streamlit-based application** that allows users to interactively chat with PDF documents using Google's Gemini AI. It enables users to upload PDF files, process them, and ask questions based on the content of the files.
26
+
27
  ---
28
+
29
+ ## Features
30
+ - πŸ“„ Upload and process multiple PDF files.
31
+ - πŸ’¬ Ask questions based on the content of the PDFs.
32
+ - ⚑ Fast and detailed answers using **Google Gemini AI**.
33
+ - 🧠 Leverages **FAISS** for efficient similarity search and text embeddings.
34
+ - πŸ”₯ Supports chunked text processing for large PDFs.
35
+
 
36
  ---
37
 
38
+ ## Tech Stack
39
+ - **Python** 🐍
40
+ - **Streamlit** for UI
41
+ - **PyPDF2** for PDF reading
42
+ - **LangChain** for text processing and AI integration
43
+ - **FAISS** for vector similarity search
44
+ - **Google Gemini AI** (Generative AI model)
45
+ - **dotenv** for managing environment variables
46
+
47
+ ---
48
+
49
+ ## Prerequisites
50
+ 1. Python 3.9 or later
51
+ 2. A valid [Google API Key](https://developers.generativeai.google/).
52
+ 3. The following Python libraries installed:
53
+ - `streamlit`
54
+ - `PyPDF2`
55
+ - `langchain`
56
+ - `langchain_google_genai`
57
+ - `google-generativeai`
58
+ - `faiss-cpu`
59
+ - `python-dotenv`
60
+
61
+ ---
62
+
63
+ ## Known Issues
64
+ 1. Pickle Deserialization Warning: Ensure FAISS index files are from trusted sources. If encountering a ValueError, delete the faiss_index folder and reprocess the PDFs.
65
+ 2. Large PDFs: Processing very large PDFs may take additional time.
66
+
67
+ ![PDF Chat Bot](https://github.com/Arman1263/pdf-chat-bot/blob/b085a67deffffa3e052493ff5aa4afcd94e7ea58/7.png)
68
+
69
+ ## So called ArmanπŸ˜‡