Add professional Space metadata

README.md

@@ -1,11 +1,22 @@
+---
+
+## title: DocIntel
+emoji: 📄
+colorFrom: blue
+colorTo: indigo
+sdk: docker
+app_port: 7860
+pinned: false
+license: mit
+short_description: Enterprise Document Intelligence with RAG, LangGraph & Groq
 
 # 📄 DocIntel - Enterprise Document Intelligence Platform
 
-[![Python 3.11](https://img.shields.io/badge/Python-3.11-blue.svg)](https://www.python.org/)
-[![Streamlit](https://img.shields.io/badge/Streamlit-1.35-red.svg)](https://streamlit.io/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
-[![Hugging Face](https://img.shields.io/badge/🤗-Live%20Demo-yellow)](https://huggingface.co/spaces/ShetyeRupa/DocIntel)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/ShetyeRupa/DocIntel/pulls)
+[Python 3.11](https://www.python.org/)
+[Streamlit](https://streamlit.io/)
+[License: MIT](https://opensource.org/licenses/MIT)
+[Hugging Face](https://huggingface.co/spaces/ShetyeRupa/DocIntel)
+[PRs Welcome](https://github.com/ShetyeRupa/DocIntel/pulls)
 
 **Transform unstructured documents into actionable intelligence with AI-powered retrieval, analysis, and automation.**
 
@@ -13,6 +24,8 @@
 
 ---
 
+
+
 ## 📋 Table of Contents
 
 - [Problem Statement](#-problem-statement)
@@ -33,8 +46,12 @@
 
 ---
 
+
+
 ## 🎯 Problem Statement
 
+
+
 ### The Document Intelligence Crisis
 
 Organizations today face an unprecedented challenge: the exponential growth of unstructured data combined with the high cost of manual document processing. Business documents—contracts, invoices, reports, emails, and research papers—represent the lifeblood of enterprise operations, yet they remain largely underutilized.
@@ -42,6 +59,8 @@ Organizations today face an unprecedented challenge: the exponential growth of u
 > *"Extracting key information from documents represents a large portion of business workloads and therefore offers a high potential for efficiency improvements and process automation."*
 > — Rombach & Fettke, ACM Computing Surveys 2025
 
+
+
 ### The Core Problem
 
 Despite decades of digital transformation, organizations still rely on manual processes for:
@@ -52,19 +71,26 @@ Despite decades of digital transformation, organizations still rely on manual pr
 - **Data Extraction**: Pulling key information from invoices, forms, and reports
 - **Knowledge Management**: Inability to find critical information across document silos
 
+
+
 ### The Cost of Inefficiency
 
-| Pain Point | Annual Cost Impact |
-|------------|-------------------|
-| Knowledge worker time wasted on manual research | $15,000+ per employee |
-| Missed contract risks and compliance issues | $500,000+ per incident |
-| Delayed decision-making due to slow document access | $100,000+ per project |
-| Employee turnover due to tedious manual work | $50,000+ per employee |
-| Lost institutional knowledge from employee departure | $75,000+ per employee |
+
+| Pain Point                                           | Annual Cost Impact     |
+| ---------------------------------------------------- | ---------------------- |
+| Knowledge worker time wasted on manual research      | $15,000+ per employee  |
+| Missed contract risks and compliance issues          | $500,000+ per incident |
+| Delayed decision-making due to slow document access  | $100,000+ per project  |
+| Employee turnover due to tedious manual work         | $50,000+ per employee  |
+| Lost institutional knowledge from employee departure | $75,000+ per employee  |
+
+
+
 
 ### The Fundamental Challenge
 
 Existing solutions are either:
+
 - **Too Expensive**: Enterprise SaaS solutions cost thousands per month
 - **Too Complex**: Custom AI development requires specialized expertise
 - **Insufficient**: Basic keyword search fails to capture semantic meaning
@@ -74,30 +100,47 @@ Existing solutions are either:
 
 ---
 
+
+
 ## 🔬 Relevance of the Topic
 
+
+
 ### Why Document Intelligence Matters Now
 
+
+
 #### 1. The Data Explosion
+
 Organizations generate and store unprecedented volumes of unstructured data. IDC estimates that by 2025, global data creation will reach **175 zettabytes**, with over 80% being unstructured—primarily documents.
 
 #### 2. LLM Revolution
+
 The rise of Large Language Models has created unprecedented possibilities for document understanding. However, these models have fundamental limitations:
+
 - **Knowledge Cutoff**: Cannot access information beyond training data
 - **Hallucination**: Produce fluent but potentially incorrect information
 - **No Source Attribution**: Cannot cite sources for generated content
 - **High Cost**: Commercial APIs charge per query, limiting scalability
 
+
+
 #### 3. Enterprise AI Adoption Surge
+
 Industry implementations demonstrate the transformative potential:
+
 - **60% faster document review** at major financial institutions
 - **Research teams completing literature reviews in hours instead of weeks**
 - **Risk detection 5x faster than traditional methods**
 - **85% reduction in manual data entry** across operations teams
 - **92% accuracy** in automated document analysis
 
+
+
 #### 4. Regulatory Pressures
+
 Organizations face increasing regulatory requirements:
+
 - **GDPR**: Right to explanation and data provenance
 - **SEC**: Audit trails for financial decisions
 - **FDA**: Documentation and validation requirements
@@ -107,11 +150,16 @@ Organizations face increasing regulatory requirements:
 > *"Enterprise systems must provide verifiable, attributable outputs with audit trails. Current research focuses on accuracy rather than compliance mechanisms."*
 > — Gao et al., "From Documents to Decisions," 2026
 
+
+
 #### 5. Cost Crisis
+
 Enterprise AI solutions typically cost thousands per month. **DocIntel eliminates this barrier through zero-cost architecture.**
 
 ### The Opportunity
+
 By combining Retrieval-Augmented Generation (RAG), Agentic Workflows, and Hybrid Search, DocIntel delivers document intelligence that is:
+
 - **Accurate**: Grounded in source documents with 92% accuracy
 - **Attributable**: Every answer has source citations
 - **Auditable**: Full traceability of reasoning and sources
@@ -121,38 +169,53 @@ By combining Retrieval-Augmented Generation (RAG), Agentic Workflows, and Hybrid
 
 ---
 
+
+
 ## 🔍 Research Gap
 
+
+
 ### What's Missing in Current Solutions
 
-| Research Gap | DocIntel Feature | Impact |
-|--------------|------------------|--------|
+
+| Research Gap                           | DocIntel Feature                     | Impact                      |
+| -------------------------------------- | ------------------------------------ | --------------------------- |
 | **Hallucination Without Verification** | Validation Node + Confidence Scoring | 78% hallucination reduction |
-| **Static Workflows** | Agentic Routing with LangGraph | 4 distinct intent paths |
-| **No Source Attribution** | Full citations with excerpts | 94% attribution accuracy |
-| **High Implementation Cost** | $0 architecture | 100% free to run |
-| **Single-Modality Focus** | Hybrid Search | 15% retrieval improvement |
+| **Static Workflows**                   | Agentic Routing with LangGraph       | 4 distinct intent paths     |
+| **No Source Attribution**              | Full citations with excerpts         | 94% attribution accuracy    |
+| **High Implementation Cost**           | $0 architecture                      | 100% free to run            |
+| **Single-Modality Focus**              | Hybrid Search                        | 15% retrieval improvement   |
+
 
 ---
 
+
+
 ## ✨ Key Features
 
+
+
 ### Core Capabilities
 
-| Feature | Description | Business Impact |
-|---------|-------------|-----------------|
-| 📄 **Document Ingestion** | Process PDF, DOCX, TXT with metadata | 15+ min → 30 sec upload |
-| 🧠 **Hybrid Search** | Semantic + BM25 keyword search | 89% retrieval accuracy |
-| 🤖 **Agentic Q&A** | Multi-step reasoning with intent detection | 92% answer accuracy |
-| 📊 **Summarization** | Executive summaries of complex documents | 60% faster review |
-| 📧 **Email Drafting** | Professional email generation | 85% faster drafting |
-| 🔍 **Data Extraction** | Pull dates, amounts, names, entities | Eliminates manual entry |
-| 🎯 **Confidence Scoring** | Quantified uncertainty for decisions | Informed risk assessment |
-| 📚 **Source Attribution** | Every answer cites original sources | Regulatory compliance |
-| 📊 **Analytics Dashboard** | Usage, costs, confidence trends | Operational visibility |
-| 🔄 **Human-in-the-Loop** | Low-confidence answers route to human review | Risk mitigation |
+
+| Feature                    | Description                                  | Business Impact          |
+| -------------------------- | -------------------------------------------- | ------------------------ |
+| 📄 **Document Ingestion**  | Process PDF, DOCX, TXT with metadata         | 15+ min → 30 sec upload  |
+| 🧠 **Hybrid Search**       | Semantic + BM25 keyword search               | 89% retrieval accuracy   |
+| 🤖 **Agentic Q&A**         | Multi-step reasoning with intent detection   | 92% answer accuracy      |
+| 📊 **Summarization**       | Executive summaries of complex documents     | 60% faster review        |
+| 📧 **Email Drafting**      | Professional email generation                | 85% faster drafting      |
+| 🔍 **Data Extraction**     | Pull dates, amounts, names, entities         | Eliminates manual entry  |
+| 🎯 **Confidence Scoring**  | Quantified uncertainty for decisions         | Informed risk assessment |
+| 📚 **Source Attribution**  | Every answer cites original sources          | Regulatory compliance    |
+| 📊 **Analytics Dashboard** | Usage, costs, confidence trends              | Operational visibility   |
+| 🔄 **Human-in-the-Loop**   | Low-confidence answers route to human review | Risk mitigation          |
+
+
+
 
 ### Enterprise-Ready Differentiators
+
 1. **Zero Hallucination Guarantee**: Validation node checks all responses against sources
 2. **Cost Transparency**: Real-time cost tracking per query (shows $0.00)
 3. **Human-in-the-Loop**: Low-confidence answers route to human review
@@ -164,6 +227,8 @@ By combining Retrieval-Augmented Generation (RAG), Agentic Workflows, and Hybrid
 
 ---
 
+
+
 ## 🛠️ Tech Stack
 
 ```
@@ -188,28 +253,39 @@ By combining Retrieval-Augmented Generation (RAG), Agentic Workflows, and Hybrid
 └─────────────────────────────────────────────────────────────────┘
 ```
 
+
+
 ### Why This Stack?
 
-| Component | Why Chosen | Benefits |
-|-----------|------------|----------|
-| **Groq API** | Free tier, 50x faster than GPT-4 | Production-quality, zero cost |
-| **Sentence-Transformers** | Local embeddings - $0 cost | Runs on CPU, no API calls |
-| **ChromaDB** | Local vector DB - persistent | Zero cost, fast retrieval |
-| **LangGraph** | Stateful workflows | Complex agentic patterns |
-| **Streamlit** | 5-minute deployment | No frontend expertise needed |
-| **Hugging Face** | Free CPU tier hosting | Zero deployment cost |
+
+| Component                 | Why Chosen                       | Benefits                      |
+| ------------------------- | -------------------------------- | ----------------------------- |
+| **Groq API**              | Free tier, 50x faster than GPT-4 | Production-quality, zero cost |
+| **Sentence-Transformers** | Local embeddings - $0 cost       | Runs on CPU, no API calls     |
+| **ChromaDB**              | Local vector DB - persistent     | Zero cost, fast retrieval     |
+| **LangGraph**             | Stateful workflows               | Complex agentic patterns      |
+| **Streamlit**             | 5-minute deployment              | No frontend expertise needed  |
+| **Hugging Face**          | Free CPU tier hosting            | Zero deployment cost          |
+
 
 ---
 
+
+
 ## 🚀 Quick Start
 
+
+
 ### Prerequisites
+
 - Python 3.11 or higher
 - Groq API key ([Free signup](https://console.groq.com))
 - Git (optional)
 - 10 GB free disk space
 - 8 GB RAM minimum, 16 GB recommended
 
+
+
 ### Installation
 
 ```bash
@@ -233,6 +309,8 @@ streamlit run app/ui/streamlit_app.py
 # 6. Open browser to http://localhost:8501
 ```
 
+
+
 ### First Run Experience
 
 1. **Upload a Document**: Click "Upload Document" in the sidebar
@@ -242,6 +320,8 @@ streamlit run app/ui/streamlit_app.py
 5. **Check Confidence**: Review the confidence score
 6. **Monitor Analytics**: View usage metrics in the dashboard
 
+
+
 ### Sample Interaction
 
 ```
@@ -261,8 +341,12 @@ The contract contains the following key provisions:
 
 ---
 
+
+
 ## 🏗️ Architecture
 
+
+
 ### System Architecture
 
 ```
@@ -299,6 +383,8 @@ The contract contains the following key provisions:
           └──────────────────────────────┘
 ```
 
+
+
 ### Data Flow
 
 1. **Ingestion Flow**: Document → PDF/DOCX Parsing → Text Extraction → Semantic Chunking → Embedding Generation → ChromaDB Storage
@@ -307,6 +393,8 @@ The contract contains the following key provisions:
 
 ---
 
+
+
 ## 📁 Project Structure
 
 ```
@@ -352,54 +440,77 @@ docintel/
 
 ---
 
+
+
 ## 📊 Performance Metrics
 
+
+
 ### Accuracy Benchmarks
 
-| Metric | Score | Improvement |
-|--------|-------|-------------|
-| Retrieval Precision@5 | 89% | +15% vs baseline |
-| Answer Accuracy | 92% | +14% vs baseline |
-| Hallucination Rate | <5% | -78% vs baseline |
-| Source Attribution | 94% | +34% vs baseline |
-| User Satisfaction | 4.7/5 | +24% vs baseline |
+
+| Metric                | Score | Improvement      |
+| --------------------- | ----- | ---------------- |
+| Retrieval Precision@5 | 89%   | +15% vs baseline |
+| Answer Accuracy       | 92%   | +14% vs baseline |
+| Hallucination Rate    | <5%   | -78% vs baseline |
+| Source Attribution    | 94%   | +34% vs baseline |
+| User Satisfaction     | 4.7/5 | +24% vs baseline |
+
+
+
 
 ### Performance
 
-| Metric | Value |
-|--------|-------|
-| Average Response Time | 2.8 seconds |
-| Document Processing | 0.8 sec/page |
-| System Uptime | 99.9% |
-| API Rate Limit | 30 req/min (free tier) |
+
+| Metric                | Value                  |
+| --------------------- | ---------------------- |
+| Average Response Time | 2.8 seconds            |
+| Document Processing   | 0.8 sec/page           |
+| System Uptime         | 99.9%                  |
+| API Rate Limit        | 30 req/min (free tier) |
+
 
 ---
 
+
+
 ## 💰 Cost Analysis
 
+
+
 ### Operational Cost Breakdown
 
-| Component | Monthly Cost |
-|-----------|--------------|
-| LLM (Groq Free Tier) | $0 |
-| Embeddings (Local) | $0 |
-| Vector DB (ChromaDB) | $0 |
-| Hosting (Hugging Face) | $0 |
-| Monitoring (WandB) | $0 |
-| **Total** | **$0** |
+
+| Component              | Monthly Cost |
+| ---------------------- | ------------ |
+| LLM (Groq Free Tier)   | $0           |
+| Embeddings (Local)     | $0           |
+| Vector DB (ChromaDB)   | $0           |
+| Hosting (Hugging Face) | $0           |
+| Monitoring (WandB)     | $0           |
+| **Total**              | **$0**       |
+
+
+
 
 ### Time Savings
+
 - **Document Review**: 30 minutes → 5 seconds (99.7% reduction)
 - **Data Extraction**: 15 minutes → 30 seconds (96.7% reduction)
 - **Email Drafting**: 10 minutes → 1 minute (90% reduction)
 
 ---
 
+
+
 ## 🚀 Deployment
 
+
+
 ### Option 1: Hugging Face Spaces (FREE)
 
-1. **Create a Space**: https://huggingface.co/new-space
+1. **Create a Space**: [https://huggingface.co/new-space](https://huggingface.co/new-space)
 2. **Choose** "Docker" SDK
 3. **Add secret** `GROQ_API_KEY`
 4. **Push code**:
@@ -418,6 +529,8 @@ docker-compose up --build
 # Access at http://localhost:7860
 ```
 
+
+
 ### Option 3: Render (FREE)
 
 1. Connect GitHub repository
@@ -427,43 +540,68 @@ docker-compose up --build
 
 ---
 
+
+
 ## 🎯 Use Cases
 
+
+
 ### Legal & Compliance
-| Use Case | Benefit |
-|----------|---------|
-| Contract Review | 85% faster analysis, 92% risk detection |
-| Compliance Checking | Automated regulation alignment |
-| Due Diligence | 30-min → 5-sec document analysis |
+
+
+| Use Case            | Benefit                                 |
+| ------------------- | --------------------------------------- |
+| Contract Review     | 85% faster analysis, 92% risk detection |
+| Compliance Checking | Automated regulation alignment          |
+| Due Diligence       | 30-min → 5-sec document analysis        |
+
+
+
 
 ### Research & Development
-| Use Case | Benefit |
-|----------|---------|
+
+
+| Use Case          | Benefit                            |
+| ----------------- | ---------------------------------- |
 | Literature Review | Hours → minutes for paper analysis |
-| Patent Search | Rapid prior art identification |
-| Technical Reports | Immediate executive summaries |
+| Patent Search     | Rapid prior art identification     |
+| Technical Reports | Immediate executive summaries      |
+
+
+
 
 ### Finance & Operations
-| Use Case | Benefit |
-|----------|---------|
+
+
+| Use Case           | Benefit                   |
+| ------------------ | ------------------------- |
 | Invoice Processing | Automatic data extraction |
-| Financial Reports | 5-second KPI extraction |
-| Procurement | Contract value analysis |
+| Financial Reports  | 5-second KPI extraction   |
+| Procurement        | Contract value analysis   |
+
+
+
 
 ### Healthcare
-| Use Case | Benefit |
-|----------|---------|
+
+
+| Use Case          | Benefit                    |
+| ----------------- | -------------------------- |
 | Clinical Research | Rapid literature synthesis |
-| Compliance | Automated HIPAA checks |
-| Patient Records | Structured data extraction |
+| Compliance        | Automated HIPAA checks     |
+| Patient Records   | Structured data extraction |
+
 
 ---
 
+
+
 ## 🤝 Contributing
 
 We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md).
 
 ### Ways to Contribute
+
 - Bug Reports
 - Feature Requests
 - Code Contributions
@@ -471,6 +609,8 @@ We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md).
 - Testing
 - Translations
 
+
+
 ### Development Workflow
 
 ```bash
@@ -497,15 +637,22 @@ git push origin feature/your-feature
 
 ---
 
+
+
 ## 📄 License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
 ---
 
+
+
 ## 🙏 Acknowledgments
 
+
+
 ### Open Source Projects
+
 - **[Groq](https://groq.com)** - Free, high-performance LLM inference
 - **[LangChain](https://langchain.com)** - LangGraph framework
 - **[Streamlit](https://streamlit.io)** - Accessible UI
@@ -513,20 +660,30 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 - **[ChromaDB](https://trychroma.com)** - Local vector storage
 - **[Sentence-Transformers](https://sbert.net)** - Local embeddings
 
+
+
 ### Research References
+
 - Rombach & Fettke (2025): Deep Learning Based Key Information Extraction
 - Ke et al. (2025): Large Language Models in Document Intelligence
 - Singh et al. (2026): Agentic Retrieval-Augmented Generation Survey
 
 ---
 
+
+
 ## 📧 Contact & Support
 
+
+
 ### Links
+
 - **GitHub Issues**: [Report a bug](https://github.com/ShetyeRupa/DocIntel/issues)
 - **Discussions**: [Q&A and community](https://github.com/ShetyeRupa/DocIntel/discussions)
 - **Hugging Face Space**: [Live Demo](https://huggingface.co/spaces/ShetyeRupa/DocIntel)
 
+
+
 ### FAQ
 
 **Q: Is this completely free to use?**
@@ -543,27 +700,36 @@ A: Currently optimized for English.
 
 ---
 
+
+
 ## ⭐ Show Your Support
 
 If this project helped you, please star it on GitHub!
 
-[![GitHub stars](https://img.shields.io/github/stars/ShetyeRupa/DocIntel?style=social)](https://github.com/ShetyeRupa/DocIntel)
+[GitHub stars](https://github.com/ShetyeRupa/DocIntel)
 
 ---
 
+
+
 ## 📊 Project Badges
 
-[![GitHub release](https://img.shields.io/github/release/ShetyeRupa/DocIntel.svg)](https://github.com/ShetyeRupa/DocIntel/releases)
-[![Build Status](https://img.shields.io/github/workflow/status/ShetyeRupa/DocIntel/CI)](https://github.com/ShetyeRupa/DocIntel/actions)
-[![Open Issues](https://img.shields.io/github/issues-raw/ShetyeRupa/DocIntel)](https://github.com/ShetyeRupa/DocIntel/issues)
+[GitHub release](https://github.com/ShetyeRupa/DocIntel/releases)
+[Build Status](https://github.com/ShetyeRupa/DocIntel/actions)
+[Open Issues](https://github.com/ShetyeRupa/DocIntel/issues)
 
 ---
 
+
+
 ## 📝 Changelog
 
+
+
 ### Version 1.0.0 (July 2026)
 
 **Features:**
+
 - Complete document ingestion pipeline
 - Hybrid retrieval (semantic + BM25)
 - LangGraph agentic orchestration
@@ -574,6 +740,7 @@ If this project helped you, please star it on GitHub!
 - Complete documentation
 
 **Performance:**
+
 - 92% answer accuracy
 - <5% hallucination rate
 - 2.8 second average response time
@@ -581,15 +748,23 @@ If this project helped you, please star it on GitHub!
 
 ---
 
+
+
 ## 🔮 Roadmap
 
+
+
 ### Q3 2026
+
 - Multilingual Support
 - Enhanced OCR
 - Table Extraction
 - REST API
 
+
+
 ### Q4 2026
+
 - Multi-Agent System
 - Knowledge Graph
 - Active Learning
@@ -597,9 +772,12 @@ If this project helped you, please star it on GitHub!
 
 ---
 
+
+
 ## 👨‍💻 Author
 
 **Rupali Shetye**
+
 - [GitHub](https://github.com/ShetyeRupa)
 - [LinkedIn](https://linkedin.com/in/rupali-shetye)
 
@@ -612,4 +790,4 @@ If this project helped you, please star it on GitHub!
 *Built with ❤️ by Rupali and the open-source community.*
 
 *Last Updated: July 2026*
-*DocIntel Version 1.0.0*
+*DocIntel Version 1.0.0*