📄 Document RAG Assistant

Transform any document into an interactive AI conversation using RAG (Retrieval Augmented Generation)

🎯 Overview

Document RAG Assistant is a Streamlit web application that enables you to have intelligent conversations with your document content. Simply upload a PDF or text file, and the app will process the document to create a searchable knowledge base that you can query using natural language.

🌐 Live Demo

Try it out here: Document RAG Assistant Live Demo

✨ Features

• 📁 Multi-format Support: Process PDF and text files seamlessly
• 🤖 Multiple AI Models: Support for various Google Gemini models (2.5 Pro, Flash, 2.0 Flash, etc.)
• 💬 Interactive Chat: Natural language conversation with document content
• 🔍 Smart Search: Vector-based similarity search using FAISS
• 📊 Session Management: Chat history, export functionality, and session persistence
• 🎨 Modern UI: Clean, responsive Streamlit interface with real-time updates
• 📈 Progress Tracking: Visual feedback during document processing
• 🔄 Streaming Responses: Real-time AI response streaming with typing indicators
• 🛡️ Fallback System: Automatic HuggingFace embeddings if Google quota exceeded

🛠️ Tech Stack

• Frontend: Streamlit
• AI/ML: Google Gemini API, LangChain
• Vector Store: FAISS (Facebook AI Similarity Search)
• Embeddings: Google Generative AI Embeddings
• Document Processing: PyPDFLoader, TextLoader
• Environment: Python 3.11+, Docker support

📋 Prerequisites

• Python 3.11 or higher
• Google Gemini API Key (Get one here)
• Internet connection for API access

🚀 Quick Start

1. Clone the Repository

git clone https://github.com/ZohaibCodez/document-qa-rag-system.git
cd document-qa-rag-system

2. Install Dependencies

uv sync

3. Set Up Environment

uv venv
# Edit .env and add your Google API key

4. Run the Application

streamlit run app.py

5. Access the App

Open your browser and navigate to http://localhost:8501

🔧 Configuration

Environment Variables

Create a .env file in the root directory:

GOOGLE_API_KEY=your_google_gemini_api_key_here

Alternatively, you can enter your API key directly in the app's sidebar.

Supported Models

• gemini-2.5-pro (Most capable, recommended for complex analysis)
• gemini-2.5-flash (Balanced performance and speed)
• gemini-2.5-flash-lite (Lightweight and fast)
• gemini-2.0-flash (Fast responses, good accuracy)
• gemini-1.5-pro (Reliable baseline)
• gemini-1.5-flash (Quick processing)

Configurable Parameters

CHUNK_SIZE = 1000          # Text chunk size for processing
CHUNK_OVERLAP = 100        # Overlap between chunks for context
RETRIEVER_K = 4           # Number of similar chunks to retrieve
EMBEDDING_MODEL = "models/gemini-embedding-exp-03-07"

📱 How to Use

1. Enter API Key: Add your Google Gemini API key in the sidebar
2. Upload Document: Click "📁 Upload your document" and select a PDF or TXT file
3. Process Document: Click "🚀 Process Document" to extract and index the content
4. Start Chatting: Ask questions about the document content in natural language
5. Export Chat: Download your conversation history anytime using the sidebar

Supported File Formats

• PDF: .pdf files (text-based, not scanned images)
• Text: .txt files (plain text documents)
• Size Limit: Up to 100MB (recommended: <10MB for optimal performance)

Example Queries

• "What is the main topic of this document?"
• "Summarize the key findings in chapter 3"
• "What does the author say about machine learning?"
• "List all the recommendations mentioned"
• "Explain the methodology used in this research"

⚠️ Current Limitations

• File Types: Currently supports only PDF and TXT formats
• Language: Optimized for English documents
• Processing Time: Large documents (>50 pages) may take longer to process
• API Limits: Subject to Google Gemini API rate limits and quotas
• Scanned PDFs: Does not support OCR for image-based PDFs

🏗️ Architecture

┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│  File Upload    │───▶│  Text Splitter   │───▶│   Embeddings    │
│  (PDF/TXT)      │    │  (Chunking)      │    │  (Google AI)    │
└─────────────────┘    └──────────────────┘    └─────────────────┘
                                                        │
┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│  Streamlit UI   │◀───│   Chat Chain     │◀───│   FAISS Store   │
│   (Frontend)    │    │  (LangChain)     │    │ (Vector Search) │
└─────────────────┘    └──────────────────┘    └─────────────────┘
                               │
                       ┌──────────────────┐
                       │  Gemini Models   │
                       │ (Generation AI)  │
                       └──────────────────┘

🐳 Docker Support

Using Docker Compose (Recommended)

# Create .env file with your API key
echo "GOOGLE_API_KEY=your-api-key-here" > .env

# Start the service
docker-compose up -d

# View logs
docker-compose logs -f

Using Docker directly

# Build image
docker build -t document-qa-rag-system .

# Run container
docker run -p 8501:8501 -e GOOGLE_API_KEY=your_api_key document-qa-rag-system

📁 Project Structure

document-rag-assistant/
│
├── app.py              # Main Streamlit application
│
├── notebooks/
│   └── rag_demo.ipynb    # Beginner-level RAG notebook demo
│
├── data/                   # Sample documents (PDF/TXT)
|   └── Stack vs Heap Memory.txt
|   └── FastAPI Modern Python Web Development.pdf
│
├── Dockerfile              # Container setup
├── requirements.txt        # Python dependencies
├── .env.example            # Example API key file
├── .gitignore              # Git ignore rules
└── README.md               # Project documentation

📊 Performance Metrics

• Processing Speed: ~2-5 seconds for typical documents (10-50 pages)
• Memory Usage: Optimized vector storage with FAISS
• Accuracy: High precision with 4-chunk retrieval system
• Container Size: ~380MB (optimized Docker image)
• Response Time: Sub-second for most queries

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Development Setup

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Development with Docker

# Build development image
docker build -f Dockerfile.dev -t document-rag-dev .

# Run with live reload
docker run -p 8501:8501 -v $(pwd):/app document-rag-dev

📝 Future Roadmap

• Support for more document formats (DOCX, HTML, Markdown)
• Multi-document conversation capabilities
• OCR support for scanned PDFs
• Advanced filtering and search options
• Integration with cloud storage services (Google Drive, Dropbox)
• API endpoint for programmatic access
• Batch processing for multiple documents
• Custom embedding model options
• Multi-language document support
• Document summarization features

🐛 Known Issues

• Large PDF files (>100MB) may cause memory issues
• Some complex PDF layouts may not parse correctly
• API rate limiting may affect performance during peak usage
• Embedded images in PDFs are not processed

🔧 Troubleshooting

Common Issues

"API key not found" error:

• Ensure your Google Gemini API key is correctly set
• Check that the key has proper permissions

Document processing fails:

• Verify the document format is supported (PDF/TXT)
• Ensure the file is not corrupted or password-protected

Slow processing:

• Try using a smaller document or different model
• Check your internet connection

Out of memory:

• Reduce document size or restart the application
• For Docker: increase memory limits

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Streamlit for the amazing web framework
• LangChain for RAG implementation tools
• Google AI for Gemini API access
• FAISS for efficient vector similarity search
• PyPDFLoader for PDF processing

📞 Support

If you encounter any issues or have questions:

• Open an Issue
• Check existing issues for solutions
• Review the troubleshooting section above
• Contact: itxlevicodez@gmail.com

---

⭐ Star this repository if you found it helpful!

Built with 🖤 using Streamlit and Google Gemini AI