Bhishaj9 commited on
Commit
7baa535
·
1 Parent(s): c2fff10

📄 docs: Complete professional README overhaul for Alpha launch

Browse files
Files changed (1) hide show
  1. README.md +56 -11
README.md CHANGED
@@ -9,24 +9,69 @@ pinned: false
9
  ---
10
 
11
  # Anvesha AI
 
12
 
13
- Anvesha AI is a sovereign Indian search engine powered by open-source technologies and cutting-edge Indian LLMs, designed with a focus on privacy and local relevance.
14
 
15
- ## Core Capabilities
16
 
17
- - **Sutra Intelligence Pipeline:** A highly optimized dual-model approach utilizing Sarvam AI. A **Sarvam 30B Router** decomposes user queries into multi-faceted parallel searches, while the powerful **Sarvam 105B Synthesizer** distills the aggregated results into a rich, structured "Sutra" format with inline `.gov.in` citations and dynamic follow-up logic.
18
- - **Multimodal Search:** Fully integrated Voice-in/Voice-out experience utilizing **Saaras V3** for highly accurate Indic speech-to-text recognition and **Bulbul V3** for natural, dynamic text-to-speech audio playback of synthesized search responses.
19
 
20
- ## Architecture
 
21
 
22
- - **Frontend:** Next.js (Standalone, Tailwind Typography, Sliding Source Panels)
23
- - **Backend:** FastAPI (Gunicorn + Uvicorn workers)
24
- - **Search Engine:** SearxNG (Optimized for India)
25
- - **Deployment:** Unified Monolith container deployed on Hugging Face Spaces
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
26
 
27
  ## Legal & Contribution
28
 
29
- We welcome community contributions to improve the sovereign search experience! If you're interested in refining the Sutra Pipeline or expanding multimodal capabilities, feel free to open a Pull Request.
30
 
31
- **Ownership & License Statement:**
32
  Anvesha AI is a proprietary project of Bhishaj Technologies. While the code is visible for contribution, all publishing and distribution rights belong exclusively to Gaurav. Please see the `LICENSE` file for more details.
 
9
  ---
10
 
11
  # Anvesha AI
12
+ **Sovereign Intelligence Engine for Bharat**
13
 
14
+ Anvesha AI is a sovereign Indian intelligence platform engineered to transform raw search data into strategic, citation-rich insights. It combines cutting-edge Indic LLMs with a privacy-first architecture to empower researchers, policymakers, and citizens with deep, actionable intelligence.
15
 
16
+ ## Core Technology (The Sutra Pipeline)
17
 
18
+ ### Router: Sarvam 30B
19
+ The Sarvam 30B model acts as an intelligent query optimizer, decomposing complex natural-language questions into 3-5 precise, parallel search queries. It focuses on Indian context and prioritizes government sources (.gov.in) to ensure strategic relevance.
20
 
21
+ ### Synthesizer: Sarvam 105B
22
+ The powerful Sarvam 105B model synthesizes aggregated search results into a high-density, multi-section 'Sutra' report. It extracts every metric—dates, version numbers, percentages—and structures them into detailed narratives with inline citations, dynamic follow-up questions, and explicit focus on Indian policy impacts.
23
 
24
+ ### Verification: Prioritized .gov.in Indexing
25
+ A custom-configured SearxNG instance, tuned for Indian relevance and stripped of resource-heavy engines, serves as the verification layer. It ensures that authoritative government sources are indexed first and surfaced prominently in every intelligence report.
26
+
27
+ ## Multimodal Capabilities
28
+
29
+ - **Saaras V3 (Speech-to-Text):** Enables highly accurate Hindi and English voice input, allowing users to speak their research queries naturally.
30
+ - **Bulbul V3 (Text-to-Speech):** Converts synthesized intelligence reports into natural-sounding Indian voice audio, supporting eyes-free consumption and accessibility.
31
+
32
+ ## UX Features
33
+
34
+ - **Interactive Source Panel:** A slide-out panel displaying all cited sources with domain badges, GOV.IN indicators, and clickable URLs for deep verification.
35
+ - **Dynamic Follow-ups:** Context-aware suggested questions generated by the synthesizer, enabling iterative, Perplexity-style exploration.
36
+ - **Search Cancellation:** Real-time abort capability via an intuitive Stop button, giving users full control over long-running LLM inferences.
37
+ - **Collapsible Sidebar:** A responsive navigation panel that can be hidden to maximize focus on the synthesis view.
38
+
39
+ ## Technical Architecture
40
+
41
+ Anvesha AI runs as a unified monolith container managed by Supervisord. The stack comprises:
42
+ - **Frontend:** Next.js (Standalone mode) with Tailwind Typography and responsive sliding panels.
43
+ - **Backend:** FastAPI application served by Gunicorn with Uvicorn workers, orchestrating the Sarvam API calls.
44
+ - **Search Engine:** SearxNG instance operating on port 8888, providing the verified search foundation.
45
+ All services communicate over localhost and are orchestrated to start together via a single `docker compose up` command.
46
+
47
+ ## Quick Start
48
+
49
+ To run Anvesha AI locally for development:
50
+
51
+ 1. **Prerequisites:** Docker Desktop installed and running, Git installed.
52
+ 2. **Clone the repository:**
53
+ ```bash
54
+ git clone https://github.com/Bhishaj9/Anvesha-AI.git
55
+ cd Anvesha-AI
56
+ ```
57
+ 3. **Configure Environment:**
58
+ Copy the template and add your Sarvam AI API key:
59
+ ```bash
60
+ cp backend/.env.template backend/.env
61
+ # Edit backend/.env and set SARVAM_API_KEY=your_key_here
62
+ ```
63
+ 4. **Build and Launch:**
64
+ ```bash
65
+ docker compose up --build
66
+ ```
67
+ 5. **Access the Application:**
68
+ Open your browser to http://localhost:3000
69
+
70
+ The backend will be available at http://localhost:8000 and SearxNG at http://localhost:8080.
71
 
72
  ## Legal & Contribution
73
 
74
+ We welcome community contributions to improve the sovereign search experience! If you're interested in refining the Sutra Pipeline, enhancing multimodal capabilities, or fixing bugs, feel free to open a Pull Request.
75
 
76
+ **Ownership & License Statement:**
77
  Anvesha AI is a proprietary project of Bhishaj Technologies. While the code is visible for contribution, all publishing and distribution rights belong exclusively to Gaurav. Please see the `LICENSE` file for more details.