README / README.md
Benaah's picture
Update README.md
2e8c459 verified
|
Raw
History Blame Contribute Delete
3.24 kB
---
title: AmaniQuery
emoji: πŸ”
colorFrom: blue
colorTo: green
pinned: true
---
<div align="center">
# πŸ” AmaniQuery
**AI-Powered Legal & Policy Research Assistant for Kenya**
[![Backend](https://img.shields.io/badge/Backend-Go-009688?style=for-the-badge&logo=fastapi)](https://huggingface.co/spaces/AmaniQuery/amaniquery-backend)
[![Voice](https://img.shields.io/badge/Voice-VibeVoice-9C27B0?style=for-the-badge&logo=microsoft)](https://huggingface.co/spaces/AmaniQuery/amaniquery-vibevoice)
[![Docs](https://img.shields.io/badge/Docs-WeKnora-FF9800?style=for-the-badge&logo=go)](https://huggingface.co/spaces/AmaniQuery/amaniquery-weknora)
</div>
---
## 🎯 What is AmaniQuery?
AmaniQuery is a **RAG-powered research platform** that makes Kenyan legal documents, parliamentary proceedings, and policy information accessible through natural language queries.
### ✨ Features
- πŸ” **Intelligent Search** - Query laws, bills, and parliamentary hansards using natural language
- πŸ€– **AI-Powered Answers** - Get synthesized responses with source citations
- 🎀 **Voice Interface** - Ask questions and get spoken responses
- πŸ“„ **Document Processing** - Upload and analyze legal documents
- πŸ“Š **Research Reports** - Generate comprehensive research summaries
- πŸ” **Secure API** - JWT authentication for enterprise use
---
## πŸ› οΈ Technology Stack
```
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ AmaniQuery β”‚
β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚ πŸ” Backend β”‚ FastAPI + LangGraph + RAG Pipeline β”‚
β”‚ 🎀 Voice β”‚ Microsoft VibeVoice TTS β”‚
β”‚ πŸ“„ Documents β”‚ WeKnora (Tencent RAG Framework) β”‚
β”‚ 🧠 LLM β”‚ Moonshot / Gemini / OpenAI β”‚
β”‚ πŸ“Š Vector Store β”‚ Qdrant / Upstash β”‚
β”‚ πŸ—„οΈ Database β”‚ PostgreSQL β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
```
---
## πŸ“– API Usage
### Query the Knowledge Base
```bash
curl -X POST https://amaniquery-backend.hf.space/api/v1/query \
-H "Content-Type: application/json" \
-d '{"query": "What does the Kenya Constitution say about land rights?"}'
```
### Text-to-Speech
```bash
curl -X POST https://amaniquery-vibevoice.hf.space/api/v1/voice/speak \
-H "Content-Type: application/json" \
-d '{"text": "Hello from AmaniQuery", "voice": "Wayne"}'
```
---
## 🀝 Contributing
We welcome contributions! Check out our [GitHub repository](https://github.com/AmaniQuery/amaniquery) to get started.
---
## πŸ“„ License
MIT License - See [LICENSE](https://github.com/AmaniQuery/amaniquery/blob/master/LICENSE) for details.
---
<div align="center">
**Made with ❀️ for Kenya**
*Empowering citizens with accessible legal information*
</div>