RAG Document Q&A System

A Django-based document Q&A system using Retrieval-Augmented Generation (RAG) to process and query large documents with AI-powered responses.

✨ Features

• Django Web Interface: Modern Bootstrap UI with admin panel
• Large Document Support: Handle documents up to 800k+ words
• Multiple Formats: PDF, DOCX, TXT, and Markdown support
• REST API: Django REST Framework for integrations
• Vector Search: FAISS/ChromaDB/Pinecone vector databases
• Conversational Mode: Context-aware multi-turn conversations
• Session Management: User session tracking and conversation history
• CLI Tools: Command-line interface for batch operations
• 🎯 Semantic Coherence Validation: Post-retrieval tracking with automatic fallback behaviors
  • Monitors semantic consistency across query→chunk→generation pipeline
  • Automatic k-boosting when coherence drops
  • Smart output hedging for uncertain answers
  • Configurable coherence thresholds and fallback strategies

🚀 Quick Start

Requirements

• Python 3.8+
• OpenAI API key

Installation

1. Clone the repository:

git clone https://github.com/djleamen/doc-reader
cd doc-reader

2. Create virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies:

pip install -r requirements.txt

4. Set up environment variables:

cp .env.example .env
# Edit .env with your OpenAI API key

5. Run setup and start server:

python main.py start

Open your browser to http://localhost:8000

📖 Usage

Web Interface

• Upload documents via the web UI
• Ask questions in natural language
• View sources and confidence scores
• Use conversational mode for follow-up questions

REST API

# Upload documents
curl -X POST "http://localhost:8000/api/upload-documents/" \
  -F "files=@document.pdf" \
  -F "index_name=default"

# Query documents
curl -X POST "http://localhost:8000/api/query/" \
  -H "Content-Type: application/json" \
  -d '{"question": "What is the main topic?", "index_name": "default"}'

Command Line

# Add documents
python main.py cli add document.pdf

# Query documents
python main.py cli query "What are the key findings?"

# Interactive mode
python main.py cli interactive --conversational

⚙️ Configuration

Key environment variables in .env:

# Required
OPENAI_API_KEY=your_api_key_here

# Optional
VECTOR_DB_TYPE=faiss              # faiss, chroma, or pinecone
CHUNK_SIZE=1000                   # Text chunk size
CHUNK_OVERLAP=200                 # Overlap between chunks
TOP_K_RESULTS=5                   # Number of results to retrieve
CHAT_MODEL=gpt-4-turbo-preview    # OpenAI model to use

# Semantic Coherence Settings
ENABLE_COHERENCE_VALIDATION=True  # Enable semantic coherence tracking
COHERENCE_HIGH_THRESHOLD=0.8      # High coherence threshold
COHERENCE_LOW_THRESHOLD=0.4       # Low coherence threshold
BOOST_K_MULTIPLIER=2.0            # K boosting multiplier

🎯 Semantic Coherence Validation

The system includes advanced semantic coherence tracking that monitors the consistency between queries, retrieved chunks, and generated answers. When coherence drops, automatic fallback behaviors are triggered:

• K-Boosting: Automatically increases retrieval count for better context
• Output Hedging: Adds uncertainty language when confidence is low
• Uncertainty Flagging: Warns users about potentially unreliable answers

🏗️ Architecture

┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│   Django App    │    │   Vector Store   │    │   OpenAI API    │
│   (Web/API)     │───▶│   (FAISS/etc.)   │───▶│   (GPT-4)       │
└─────────────────┘    └──────────────────┘    └─────────────────┘
         │                       │                       │
         ▼                       ▼                       ▼
┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│   Document      │    │   Embeddings     │    │   AI Responses  │
│   Processing    │    │   & Search       │    │   with Sources  │
└─────────────────┘    └──────────────────┘    └─────────────────┘

Components

• Django App: Web interface, API, and data management
• Document Processor: Extracts and chunks text from files
• Vector Store: Handles embeddings and similarity search
• RAG Engine: Orchestrates retrieval and generation
• CLI Tools: Command-line utilities

🐋 Docker Deployment

# Quick start with Docker
docker-compose up

# Or build manually
docker build -t rag-system .
docker run -p 8000:8000 rag-system

🧪 Testing

# Run tests
pytest

# Test with coverage
pytest --cov=src --cov=rag_app

📄 License

MIT License - see LICENSE for details.

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Add tests for new functionality
4. Submit a pull request

🆘 Troubleshooting

Import errors: Ensure all dependencies are installed with pip install -r requirements.txt

Memory issues with large docs: Reduce CHUNK_SIZE in .env or process documents individually

Port conflicts: Use python main.py start --port 8001 to use a different port

Poor answer quality: Increase TOP_K_RESULTS and CHUNK_OVERLAP for better context retrieval