update

rag_sec/README.md

@@ -1,24 +1,51 @@
+# Document Search and Response Generation System
 
-# RAG-Chagu Test Suite
+This project implements a **Document Search and Response Generation System** combining semantic search, malicious query detection, and generative response capabilities. It is designed for efficient and context-aware information retrieval and response generation.
 
-## Overview
-This project demonstrates a RAG system enhanced with Chagu features for:
-- Data Poisoning Detection
-- Model Drift Handling
-- Query Injection Attack Prevention
-- Adversarial Embedding Detection
+---
 
-## Setup
+## Features
 
-### Install Dependencies
-```bash
-pip install -r requirements.txt
-```
+1. **Semantic Search**:
+   - Uses SentenceTransformer embeddings for document similarity.
+   - Retrieves top-k relevant documents for a given query.
 
-### Run the Test Suite
-```bash
-python rag_chagu_demo.py
-```
+2. **Malicious Query Detection**:
+   - Identifies and blocks malicious or harmful queries using sentiment analysis.
+
+3. **Query Transformation**:
+   - Rephrases or enhances ambiguous queries for better processing.
+
+4. **Generative Response**:
+   - Generates a context-aware response using Hugging Face models like `distilgpt2`.
+
+5. **Expandable Architecture**:
+   - Modular components for easy enhancement and integration.
+   - Compatible with lightweight and resource-efficient models.
+
+---
+
+## Architecture
+
+1. **Bad Query Detector**:
+   - Detects malicious or inappropriate queries using sentiment analysis (`distilbert-base-uncased-finetuned-sst-2-english`).
+
+2. **Query Transformer**:
+   - Rephrases or improves queries for better retrieval results.
+
+3. **Document Retriever**:
+   - Encodes documents into dense vectors using `all-MiniLM-L6-v2` embeddings.
+   - Finds similar documents using cosine similarity.
+
+4. **Semantic Response Generator**:
+   - Generates context-aware responses using models like `distilgpt2` or `EleutherAI/gpt-neo-1.3B`.
+
+---
 
 ## Requirements
-- Python 3.8 or higher
+
+### Python Libraries
+Install the necessary libraries using `pip`:
+```bash
+pip install transformers sentence-transformers scikit-learn numpy flask
+```