VietRAG — RAG Chatbot for Vietnamese Education

PRN222 Assignment — Group 4 | SE1938

---

📖 Mô tả dự án

VietRAG là hệ thống chatbot hỏi đáp tài liệu môn học sử dụng RAG (Retrieval-Augmented Generation), cho phép sinh viên đặt câu hỏi và nhận câu trả lời chính xác, có trích dẫn nguồn dựa trên tài liệu được giảng viên upload. Đồng thời, hệ thống cung cấp bộ công cụ nghiên cứu và benchmark để so sánh hiệu quả giữa các embedding model trong bối cảnh tiếng Việt.

Vấn đề giải quyết

• Sinh viên khó tìm kiếm thông tin chính xác trong slide bài giảng
• Không có công cụ đo lường định lượng chất lượng RAG cho tiếng Việt
• Thiếu so sánh khách quan giữa các embedding model cho nội dung học thuật Việt Nam

---

✨ Tính năng chính

---

🛠 Tech Stack

---

📐 Kiến trúc 3-Layer

┌─────────────────────────────────────────────────────┐
│               PresentationLayer (MVC)                │
│  Controllers │ Views (Razor) │ ViewModels │ wwwroot  │
└──────────────────────┬──────────────────────────────┘
                       │ injects IService interfaces
┌──────────────────────▼──────────────────────────────┐
│              BusinessLayer (Services)                │
│  ChatService │ DocumentService │ GeminiService       │
│  BenchmarkService │ UserService │ EmbeddingFactory   │
└──────────────────────┬──────────────────────────────┘
                       │ injects IGenericRepository<T>
┌──────────────────────▼──────────────────────────────┐
│           DataAccessLayer (EF Core + Repos)          │
│  GenericRepository<T> │ DbContext │ EF Migrations    │
└─────────────────────────────────────────────────────┘

Nguyên tắc Decoupling nghiêm ngặt (Strict Separation)

Để đảm bảo tính độc lập giữa các tầng theo chuẩn Enterprise Architecture:

• PresentationLayer hoàn toàn không tham chiếu trực tiếp tới DataAccessLayer hay các Database Entities (Domain.Models / DataAccessLayer.Models).
• Toàn bộ dữ liệu trao đổi được ánh xạ qua các đối tượng DTOs (Data Transfer Objects) định nghĩa độc lập tại BusinessLayer/DTOs/.
• Tất cả logic nghiệp vụ, xử lý lỗi và mapping đều được đóng gói hoàn toàn bên trong tầng BusinessLayer.

---

💡 Khái niệm Chunk & Index trong RAG

Để chatbot hoạt động chính xác dựa trên tài liệu học tập của bạn, hệ thống thực hiện hai bước xử lý cốt lõi:

1. Chunking (Chia nhỏ tài liệu):
   • Tài liệu thô (PDF, DOCX, PPTX) được đọc và chia nhỏ thành các phân đoạn ngắn (từ 200 - 1000 ký tự) dựa trên các chiến lược khác nhau (Fixed Size, Sentence, Recursive).
   • Việc này giúp LLM (Gemini) dễ dàng trích xuất thông tin liên quan mà không bị vượt quá giới hạn từ ngữ (Context Window) và giúp việc tìm kiếm chính xác hơn.
2. Indexing (Chỉ mục hóa):
   • Mỗi Chunk văn bản được gửi đến mô hình Embedding để chuyển đổi thành các Vector Embedding (dạng mảng số biểu thị ngữ nghĩa).
   • Hệ thống lưu các Vector này vào cơ sở dữ liệu cùng với nội dung văn bản.
   • Khi người dùng đặt câu hỏi, hệ thống sẽ chuyển câu hỏi thành Vector và dùng thuật toán Cosine Similarity để tìm ra các Chunk phù hợp nhất trong nháy mắt.

---

⚙️ Prerequisites

• .NET 9 SDK
• SQL Server 2019+ (hoặc SQL Server Express)
• Visual Studio 2022 / VS Code / Cursor
• Google Gemini API Key — miễn phí tại ai.google.dev
• HuggingFace Token — miễn phí (tùy chọn, cho HF models) tại huggingface.co/settings/tokens

---

🚀 Cài đặt và chạy

Bước 1 — Clone project

git clone https://github.com/YOUR_USERNAME/VietRAG.git
cd VietRAG/Group4_SE1938_A01

Bước 2 — Tạo database

Mở SQL Server Management Studio, chạy lệnh tạo DB:

CREATE DATABASE Prn222_assigment;

Sau đó apply migrations:

cd PresentationLayer
dotnet ef database update --project ../DataAccessLayer

Bước 3 — Cấu hình API Keys

Mở PresentationLayer/appsettings.json và điền:

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=.;Database=Prn222_assigment;User Id=sa;Password=YOUR_PASSWORD;TrustServerCertificate=True"
  },
  "GeminiSettings": {
    "ApiKey": "YOUR_GEMINI_API_KEY",
    "Model": "gemini-2.5-flash"
  },
  "HuggingFaceToken": "hf_YOUR_TOKEN"
}

Bước 4 — Chạy project

cd PresentationLayer
dotnet run

Mở trình duyệt: http://localhost:5007

Bước 5 — Tài khoản mặc định

Admin được tự động tạo khi app khởi động lần đầu.

---

📁 Cấu trúc thư mục

Group4_SE1938_A01/
├── PresentationLayer/              # Tầng hiển thị (MVC)
│   ├── Controllers/
│   │   ├── AccountController.cs   # Login, Register, User CRUD
│   │   ├── ChatController.cs      # RAG Chat sessions
│   │   ├── DocumentController.cs  # Upload, Index, Re-Index
│   │   └── BenchmarkController.cs # Benchmark Runner & Dashboard
│   ├── Views/
│   │   ├── Chat/                  # Chat UI
│   │   ├── Document/              # Document management UI
│   │   └── Benchmark/             # Dashboard & metrics
│   ├── Models/                    # ViewModels (LoginVM, RegisterVM...)
│   └── wwwroot/                   # CSS, JS, static files
│
├── BusinessLayer/                 # Tầng nghiệp vụ
│   ├── Interfaces/                # Service contracts (IUserService, IChatService...)
│   ├── Services/
│   │   ├── ChatService.cs         # RAG retrieval pipeline
│   │   ├── DocumentService.cs     # Chunking + Embedding indexing
│   │   ├── GeminiService.cs       # LLM generation
│   │   ├── BenchmarkService.cs    # RAGAS metrics computation
│   │   ├── Embedding/
│   │   │   ├── EmbeddingProviderFactory.cs
│   │   │   ├── HuggingFaceEmbeddingProvider.cs
│   │   │   ├── GeminiEmbeddingAdapter.cs
│   │   │   └── OpenAIEmbeddingProvider.cs
│   │   └── Chunking/
│   │       ├── FixedSizeChunker.cs
│   │       ├── SentenceChunker.cs
│   │       └── RecursiveChunker.cs
│   └── Helpers/
│       └── VectorHelper.cs        # Cosine similarity
│
└── DataAccessLayer/               # Tầng dữ liệu
    ├── Models/                    # EF Core entities + DbContext
    ├── Repository/
    │   ├── IGenericRepository.cs
    │   └── GenericRepository.cs
    ├── Seeds/
    │   └── TestSet50Questions.json # 50 câu hỏi PRN212 benchmark
    └── Migrations/                # EF Core migrations

---

🔬 Chạy Benchmark

1. Login với tài khoản Admin
2. Vào tab Benchmarks trên navbar
3. Chọn môn học và embedding model cần đánh giá
4. Bấm "Run Benchmark" — hệ thống chạy pipeline RAG trên 50 câu hỏi mẫu
5. Xem Dashboard với biểu đồ Precision@3, Recall@3, MRR, Latency

Metrics được tính

---

📊 Kết quả Benchmark (PRN212 — OOP với .NET)

Cập nhật sau khi chạy benchmark thực tế. Lưu ý: bge-m3 (1024d) không tương thích vector với Gemini (768d) — cần Re-Index riêng.

---

📌 Ghi chú kỹ thuật quan trọng

Dimension Mismatch

Mỗi embedding model tạo vector với số chiều khác nhau. Khi chat, query vector phải cùng chiều với chunk vectors trong DB. Nếu chọn model khác với model đã index → hệ thống tự động báo "Vui lòng Re-Index với model đang chọn".

RAG Pipeline Flow

User Question
    → Embed query (EmbeddingProviderFactory)
    → Cosine Similarity với chunks trong DB
    → Top-K retrieval (threshold 0.4)
    → Gemini 2.5 Flash (context + question)
    → Response với Citations

HuggingFace Network

HuggingFace Inference API (api-inference.huggingface.co) cần kết nối internet trực tiếp. Nếu mạng trường/công ty block → cần VPN hoặc hotspot.

---

👥 Thành viên nhóm

---

📄 License

MIT License — Free for educational use.