Hugging Face's logo

Spaces:
AmaniQuery
/
README
Configuration error

App Files Community
Benaah commited on
Commit
2e8c459
·
verified ·
1 Parent(s): 647c59a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +92 -101
README.md CHANGED
@@ -1,101 +1,92 @@
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>
 
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-Go-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
+
39
+ ## 🛠️ Technology Stack
40
+
41
+ ```
42
+ ┌─────────────────────────────────────────────────────────┐
43
+ │ AmaniQuery │
44
+ ├─────────────────────────────────────────────────────────┤
45
+ │ 🔍 Backend │ FastAPI + LangGraph + RAG Pipeline │
46
+ │ 🎤 Voice │ Microsoft VibeVoice TTS │
47
+ │ 📄 Documents │ WeKnora (Tencent RAG Framework) │
48
+ │ 🧠 LLM │ Moonshot / Gemini / OpenAI │
49
+ │ 📊 Vector Store │ Qdrant / Upstash │
50
+ │ 🗄️ Database │ PostgreSQL │
51
+ └─────────────────────────────────────────────────────────┘
52
+ ```
53
+
54
+ ---
55
+
56
+ ## 📖 API Usage
57
+
58
+ ### Query the Knowledge Base
59
+ ```bash
60
+ curl -X POST https://amaniquery-backend.hf.space/api/v1/query \
61
+ -H "Content-Type: application/json" \
62
+ -d '{"query": "What does the Kenya Constitution say about land rights?"}'
63
+ ```
64
+
65
+ ### Text-to-Speech
66
+ ```bash
67
+ curl -X POST https://amaniquery-vibevoice.hf.space/api/v1/voice/speak \
68
+ -H "Content-Type: application/json" \
69
+ -d '{"text": "Hello from AmaniQuery", "voice": "Wayne"}'
70
+ ```
71
+
72
+ ---
73
+
74
+ ## 🤝 Contributing
75
+
76
+ We welcome contributions! Check out our [GitHub repository](https://github.com/AmaniQuery/amaniquery) to get started.
77
+
78
+ ---
79
+
80
+ ## 📄 License
81
+
82
+ MIT License - See [LICENSE](https://github.com/AmaniQuery/amaniquery/blob/master/LICENSE) for details.
83
+
84
+ ---
85
+
86
+ <div align="center">
87
+
88
+ **Made with ❤️ for Kenya**
89
+
90
+ *Empowering citizens with accessible legal information*
91
+
92
+ </div>