github-actions[bot] commited on
Commit
874be7e
Β·
1 Parent(s): fa8d5c5

Deploy: Use HF-specific README with metadata

Browse files
Files changed (1) hide show
  1. README.md +49 -108
README.md CHANGED
@@ -1,154 +1,95 @@
1
- # Enterprise RAG Platform
 
 
 
 
 
 
 
 
 
 
 
 
2
 
3
- <div align="center">
4
 
5
  **Turn documents into answers. Instantly.**
6
 
7
- Upload contracts, research papers, or financial reports. Ask questions in plain English. Get precise, cited answers in seconds.
8
-
9
- [![Live Demo](https://img.shields.io/badge/πŸ”΄_LIVE-Try_Demo-blue?style=for-the-badge)](https://pkgprateek-ai-rag-document.hf.space/)
10
- [![Deploy](https://github.com/pkgprateek/ai-rag-document/actions/workflows/deploy-to-hf.yml/badge.svg)](https://github.com/pkgprateek/ai-rag-document/actions/workflows/deploy-to-hf.yml)
11
- [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
12
- [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
13
-
14
- <a href="https://pkgprateek-ai-rag-document.hf.space/">
15
- <img src="assets/demo-screenshot.jpeg" alt="Enterprise RAG Demo" width="700"/>
16
- </a>
17
-
18
- </div>
19
 
20
  ---
21
 
22
- ## The Problem
23
 
24
- Knowledge workers spend **2.5 hours daily** searching for information buried in documents. Legal teams review contracts manually. Researchers dig through papers. Finance teams hunt for clauses in agreements.
 
 
25
 
26
- ## The Solution
27
 
28
- **Enterprise RAG** eliminates that friction:
29
 
30
  ```
31
- Upload documents β†’ Ask questions β†’ Get cited answers in <5 seconds
32
  ```
33
 
34
- No more Ctrl+F. No more reading 50 pages to find one clause. Just ask.
35
 
36
  ---
37
 
38
- ## Features
39
 
40
- | Feature | What You Get |
41
- |---------|--------------|
42
- | **Multi-document upload** | Process multiple files at once with batch progress |
43
- | **Streaming answers** | Watch answers generate in real-time with thinking indicator |
44
- | **Inline citations** | Every claim linked to source document + page number |
45
- | **3 AI models** | GPT-OSS 120B, Llama 3.3 70B, Gemma 3 27B |
46
- | **Session isolation** | Your documents are private to your session |
47
- | **Auto-cleanup** | Documents auto-deleted after 7 days |
48
 
49
  ---
50
 
51
- ## Architecture
52
-
53
- ```mermaid
54
- flowchart LR
55
- subgraph Input
56
- A[πŸ“„ PDF / DOCX / TXT]
57
- end
58
-
59
- subgraph Processing
60
- B[βœ‚οΈ Chunk<br/>1000 chars]
61
- C[🧠 Embed<br/>bge-small-en-v1.5]
62
- D[(πŸ’Ύ ChromaDB)]
63
- end
64
-
65
- subgraph Query
66
- E[πŸ’¬ Question]
67
- F[🎯 Top-4 Retrieval]
68
- G[πŸ€– LLM Stream]
69
- H[πŸ“ Cited Answer]
70
- end
71
-
72
- A --> B --> C --> D
73
- E --> F --> G --> H
74
- D --> F
75
- ```
76
 
77
- **Stack:** LangChain Β· ChromaDB Β· sentence-transformers Β· Groq + OpenRouter
 
 
 
 
 
 
78
 
79
  ---
80
 
81
- ## Quick Start
82
-
83
- ### Docker (Recommended)
84
 
85
  ```bash
86
  git clone https://github.com/pkgprateek/rag-document-qa-workflow.git
87
  cd rag-document-qa-workflow
88
-
89
- # Add your API keys
90
  echo "GROQ_API_KEY=your_key" > .env
91
- echo "OPENROUTER_API_KEY=your_key" >> .env
92
-
93
  docker compose up
 
94
  ```
95
 
96
- Open **http://localhost:7860**
97
-
98
- ### Local Development
99
-
100
- ```bash
101
- uv venv && source .venv/bin/activate
102
- uv pip install -r requirements.txt
103
- python app/main.py
104
- ```
105
-
106
- **Get Free API Keys:**
107
- - [Groq](https://console.groq.com/keys) β€” Required (GPT-OSS, Llama)
108
- - [OpenRouter](https://openrouter.ai/keys) β€” Optional (Gemma)
109
 
110
  ---
111
 
112
- ## Performance
113
 
114
- | Metric | Value |
115
- |--------|-------|
116
- | **Query latency** | 50-200ms (p95) |
117
- | **Document processing** | 3-4s for 100 pages |
118
- | **Citation accuracy** | 93-96% relevance |
119
- | **Streaming** | First token in <500ms |
120
 
121
  ---
122
 
123
  ## Enterprise Pilots
124
 
125
- **2-week paid pilots** for teams ready to deploy RAG on their infrastructure:
126
-
127
- | Week | Deliverables |
128
- |------|--------------|
129
- | **Week 1** | Document ingestion, chunking tuned for your domain |
130
- | **Week 2** | Deployment, team training, ROI analysis |
131
-
132
- **Includes:** Custom RAG system Β· Performance benchmarks Β· 30-day support
133
-
134
- <p align="center">
135
- <a href="https://cal.com/prateekgoel/30m-discovery-call">
136
- <img src="https://img.shields.io/badge/πŸ“…_Book_Discovery_Call-00C853?style=for-the-badge" alt="Book Call"/>
137
- </a>
138
- </p>
139
-
140
- ---
141
-
142
- ## Contact
143
-
144
- **Prateek Kumar Goel**
145
 
146
- [![HuggingFace Demo](https://img.shields.io/badge/πŸš€_Demo-HuggingFace-yellow)](https://huggingface.co/spaces/pkgprateek/ai-rag-document)
147
- [![GitHub](https://img.shields.io/badge/πŸ’»_Code-GitHub-black)](https://github.com/pkgprateek)
148
- [![HuggingFace](https://img.shields.io/badge/πŸ€—_Profile-HuggingFace-orange)](https://huggingface.co/pkgprateek)
149
 
150
  ---
151
 
152
- <p align="center">
153
- <sub>MIT License · Built with ❀️ for enterprise document intelligence</sub>
154
- </p>
 
1
+ ---
2
+ title: Enterprise RAG Platform
3
+ emoji: πŸš€
4
+ colorFrom: blue
5
+ colorTo: green
6
+ sdk: gradio
7
+ sdk_version: 5.49.1
8
+ app_file: app/main.py
9
+ pinned: false
10
+ license: mit
11
+ short_description: Document intelligence for Legal, Research, FinOps
12
+ full_width: true
13
+ ---
14
 
15
+ # Enterprise RAG Platform
16
 
17
  **Turn documents into answers. Instantly.**
18
 
19
+ Upload contracts, research papers, or financial reports β†’ Ask questions β†’ Get cited answers in seconds.
 
 
 
 
 
 
 
 
 
 
 
20
 
21
  ---
22
 
23
+ ## ✨ What's New
24
 
25
+ - **Multi-document upload** β€” Process multiple files at once
26
+ - **Streaming answers** β€” Watch responses generate in real-time
27
+ - **Thinking indicator** β€” See "πŸ” Analyzing documents..." before streaming starts
28
 
29
+ ---
30
 
31
+ ## How It Works
32
 
33
  ```
34
+ πŸ“„ Upload β†’ βœ‚οΈ Chunk β†’ 🧠 Embed β†’ πŸ’¬ Ask β†’ ✨ Cited Answer
35
  ```
36
 
37
+ **3 steps**: Upload your documents β†’ Ask questions β†’ Get answers with page citations.
38
 
39
  ---
40
 
41
+ ## Try It Now
42
 
43
+ 1. **Select a vertical** β€” Legal, Research, or FinOps samples pre-loaded
44
+ 2. **Or upload your own** β€” PDF, DOCX, TXT supported (batch upload enabled)
45
+ 3. **Ask anything** β€” Natural language questions
46
+ 4. **Get streaming answers** β€” Watch the AI think and respond in real-time
47
+
48
+ No signup required. Documents auto-deleted after 7 days.
 
 
49
 
50
  ---
51
 
52
+ ## Features
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
53
 
54
+ | Feature | Description |
55
+ |---------|-------------|
56
+ | **Multi-upload** | Upload multiple files at once |
57
+ | **Streaming** | Real-time token-by-token answers |
58
+ | **Citations** | Every answer links to source + page |
59
+ | **3 AI models** | GPT-OSS 120B, Llama 3.3, Gemma 3 |
60
+ | **Privacy** | Session isolation, 7-day auto-delete |
61
 
62
  ---
63
 
64
+ ## Run Locally
 
 
65
 
66
  ```bash
67
  git clone https://github.com/pkgprateek/rag-document-qa-workflow.git
68
  cd rag-document-qa-workflow
 
 
69
  echo "GROQ_API_KEY=your_key" > .env
 
 
70
  docker compose up
71
+ # β†’ http://localhost:7860
72
  ```
73
 
74
+ **API Keys:** [Groq](https://console.groq.com/keys) (Required) Β· [OpenRouter](https://openrouter.ai/keys) (Optional)
 
 
 
 
 
 
 
 
 
 
 
 
75
 
76
  ---
77
 
78
+ ## πŸ”’ Privacy
79
 
80
+ - Documents processed locally
81
+ - Session-isolated storage
82
+ - Auto-deleted after 7 days
83
+ - Never used for training
 
 
84
 
85
  ---
86
 
87
  ## Enterprise Pilots
88
 
89
+ **2-week paid pilots** for teams ready to deploy RAG on their infrastructure.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
90
 
91
+ πŸ“… [Book discovery call](https://cal.com/prateekgoel/30m-discovery-call)
 
 
92
 
93
  ---
94
 
95
+ **Built by [Prateek Kumar Goel](https://github.com/pkgprateek)** Β· MIT License