Benaah commited on
Commit
647c59a
Β·
verified Β·
1 Parent(s): 72d7d59

Upload folder using huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +101 -10
README.md CHANGED
@@ -1,10 +1,101 @@
1
- ---
2
- title: README
3
- emoji: πŸ“š
4
- colorFrom: purple
5
- colorTo: gray
6
- sdk: static
7
- pinned: false
8
- ---
9
-
10
- Edit this `README.md` markdown file to author your organization card.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: AmaniQuery
3
+ emoji: πŸ”
4
+ colorFrom: blue
5
+ colorTo: green
6
+ pinned: true
7
+ ---
8
+
9
+ <div align="center">
10
+
11
+ # πŸ” AmaniQuery
12
+
13
+ **AI-Powered Legal & Policy Research Assistant for Kenya**
14
+
15
+ [![Backend](https://img.shields.io/badge/Backend-FastAPI-009688?style=for-the-badge&logo=fastapi)](https://huggingface.co/spaces/AmaniQuery/amaniquery-backend)
16
+ [![Voice](https://img.shields.io/badge/Voice-VibeVoice-9C27B0?style=for-the-badge&logo=microsoft)](https://huggingface.co/spaces/AmaniQuery/amaniquery-vibevoice)
17
+ [![Docs](https://img.shields.io/badge/Docs-WeKnora-FF9800?style=for-the-badge&logo=go)](https://huggingface.co/spaces/AmaniQuery/amaniquery-weknora)
18
+
19
+ </div>
20
+
21
+ ---
22
+
23
+ ## 🎯 What is AmaniQuery?
24
+
25
+ AmaniQuery is a **RAG-powered research platform** that makes Kenyan legal documents, parliamentary proceedings, and policy information accessible through natural language queries.
26
+
27
+ ### ✨ Features
28
+
29
+ - πŸ” **Intelligent Search** - Query laws, bills, and parliamentary hansards using natural language
30
+ - πŸ€– **AI-Powered Answers** - Get synthesized responses with source citations
31
+ - 🎀 **Voice Interface** - Ask questions and get spoken responses
32
+ - πŸ“„ **Document Processing** - Upload and analyze legal documents
33
+ - πŸ“Š **Research Reports** - Generate comprehensive research summaries
34
+ - πŸ” **Secure API** - JWT authentication for enterprise use
35
+
36
+ ---
37
+
38
+ ## πŸš€ Our Spaces
39
+
40
+ | Space | Description | Status |
41
+ |-------|-------------|--------|
42
+ | [**amaniquery-backend**](https://huggingface.co/spaces/AmaniQuery/amaniquery-backend) | Main FastAPI backend with RAG pipeline | 🟒 Active |
43
+ | [**amaniquery-vibevoice**](https://huggingface.co/spaces/AmaniQuery/amaniquery-vibevoice) | Text-to-Speech service using Microsoft VibeVoice | 🟒 Active |
44
+ | [**amaniquery-weknora**](https://huggingface.co/spaces/AmaniQuery/amaniquery-weknora) | Document processing & knowledge base management | 🟒 Active |
45
+
46
+ ---
47
+
48
+ ## πŸ› οΈ Technology Stack
49
+
50
+ ```
51
+ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
52
+ β”‚ AmaniQuery β”‚
53
+ β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
54
+ β”‚ πŸ” Backend β”‚ FastAPI + LangGraph + RAG Pipeline β”‚
55
+ β”‚ 🎀 Voice β”‚ Microsoft VibeVoice TTS β”‚
56
+ β”‚ πŸ“„ Documents β”‚ WeKnora (Tencent RAG Framework) β”‚
57
+ β”‚ 🧠 LLM β”‚ Moonshot / Gemini / OpenAI β”‚
58
+ β”‚ πŸ“Š Vector Store β”‚ Qdrant / Upstash β”‚
59
+ β”‚ πŸ—„οΈ Database β”‚ PostgreSQL β”‚
60
+ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
61
+ ```
62
+
63
+ ---
64
+
65
+ ## πŸ“– API Usage
66
+
67
+ ### Query the Knowledge Base
68
+ ```bash
69
+ curl -X POST https://amaniquery-backend.hf.space/api/v1/query \
70
+ -H "Content-Type: application/json" \
71
+ -d '{"query": "What does the Kenya Constitution say about land rights?"}'
72
+ ```
73
+
74
+ ### Text-to-Speech
75
+ ```bash
76
+ curl -X POST https://amaniquery-vibevoice.hf.space/api/v1/voice/speak \
77
+ -H "Content-Type: application/json" \
78
+ -d '{"text": "Hello from AmaniQuery", "voice": "Wayne"}'
79
+ ```
80
+
81
+ ---
82
+
83
+ ## 🀝 Contributing
84
+
85
+ We welcome contributions! Check out our [GitHub repository](https://github.com/AmaniQuery/amaniquery) to get started.
86
+
87
+ ---
88
+
89
+ ## πŸ“„ License
90
+
91
+ MIT License - See [LICENSE](https://github.com/AmaniQuery/amaniquery/blob/master/LICENSE) for details.
92
+
93
+ ---
94
+
95
+ <div align="center">
96
+
97
+ **Made with ❀️ for Kenya**
98
+
99
+ *Empowering citizens with accessible legal information*
100
+
101
+ </div>