Update README.md
Browse files
README.md
CHANGED
@@ -9,10 +9,14 @@ app_file: app.py
|
|
9 |
pinned: false
|
10 |
---
|
11 |
|
12 |
-
# **Vietnamese Legal Chatbot**
|
13 |
|
14 |
A Retrieval-Augmented Generation (RAG) system designed to answer legal questions in Vietnamese, providing accurate and contextually relevant responses based on Vietnamese legal documents.
|
15 |
|
|
|
|
|
|
|
|
|
16 |
## **Features**
|
17 |
|
18 |
- **Advanced RAG Architecture** - Combines vector search, BM25, and cross-encoder reranking for optimal document retrieval
|
@@ -136,11 +140,22 @@ flowchart LR
|
|
136 |
- **Context Builder** - Formats retrieved documents into a prompt context
|
137 |
- **LLM (Gemini)** - Generates natural language responses based on the retrieved context
|
138 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
139 |
## **Installation**
|
140 |
|
141 |
1. Clone the repository:
|
142 |
```bash
|
143 |
-
git clone https://
|
144 |
cd vietnamese-legal-chatbot
|
145 |
```
|
146 |
|
|
|
9 |
pinned: false
|
10 |
---
|
11 |
|
12 |
+
# **Vietnamese Legal Chatbot** 🏛️⚖️
|
13 |
|
14 |
A Retrieval-Augmented Generation (RAG) system designed to answer legal questions in Vietnamese, providing accurate and contextually relevant responses based on Vietnamese legal documents.
|
15 |
|
16 |
+
[](https://huggingface.co/spaces/fisherman611/vietnamese-legal-chatbot)
|
17 |
+
[](LICENSE)
|
18 |
+
[](https://python.org)
|
19 |
+
|
20 |
## **Features**
|
21 |
|
22 |
- **Advanced RAG Architecture** - Combines vector search, BM25, and cross-encoder reranking for optimal document retrieval
|
|
|
140 |
- **Context Builder** - Formats retrieved documents into a prompt context
|
141 |
- **LLM (Gemini)** - Generates natural language responses based on the retrieved context
|
142 |
|
143 |
+
## **Results**
|
144 |
+
|
145 |
+
| Method | MRR | Coverage | R@1 | R@10 | R@20 | MAP@20 |
|
146 |
+
|--------|-----|----------|-----|------|------|--------|
|
147 |
+
| **Hybrid + Reranking** | **0.6082** | **88.99%** | **48.2%** | **82.7%** | **88.4%** | **62.4%** |
|
148 |
+
| Hybrid (BM25 + Vector) | 0.5801 | 88.20% | 43.1% | 83.3% | 87.5% | 59.2% |
|
149 |
+
| BM25 Only | 0.5545 | 78.94% | 43.0% | 76.8% | 78.3% | 56.5% |
|
150 |
+
| Vector Only | 0.4691 | 68.09% | 36.4% | 66.6% | 67.3% | 47.1% |
|
151 |
+
|
152 |
+
*Evaluation conducted on `train_qna.csv`*
|
153 |
+
|
154 |
## **Installation**
|
155 |
|
156 |
1. Clone the repository:
|
157 |
```bash
|
158 |
+
git clone https://github.com/fisherman611/vietnamese-legal-chatbot.git
|
159 |
cd vietnamese-legal-chatbot
|
160 |
```
|
161 |
|