Devi Sri Bandaru commited on
Commit
b747ca7
·
1 Parent(s): c76aa35

Improve README

Browse files

Updated README to enhance clarity and detail about the project structure, prerequisites, and setup instructions.

Files changed (1) hide show
  1. README.md +17 -7
README.md CHANGED
@@ -1,6 +1,6 @@
1
  # Agentic RAG Knowledge Search
2
 
3
- An Autonomous AI Microservice with Hybrid Retrieval & Self-Evaluation
4
 
5
  ## Overview
6
 
@@ -10,7 +10,7 @@ It uses a LangGraph Router to autonomously switch between:
10
 
11
  1. Internal Knowledge Base: A vector database (FAISS) for proprietary policy documents.
12
 
13
- 1. External Web Search: DuckDuckGo for real-time, public information.
14
 
15
  The system includes a custom LLM-as-a-Judge Evaluation Pipeline to continuously benchmark answer accuracy and hallucination rates.
16
 
@@ -30,6 +30,8 @@ The system follows a Hybrid RAG architecture. The Agent acts as the central brai
30
  - Automated Evaluation: Includes a custom "Judge" pipeline that uses one LLM to grade the accuracy of another, producing detailed CSV reports.
31
 
32
  - Containerized: Fully Dockerized for consistent deployment across any environment.
 
 
33
 
34
  ## Demo & Outputs
35
 
@@ -51,14 +53,19 @@ A generated CSV report scoring the agent's performance against ground truth data
51
 
52
  ## Setup & Installation
53
 
 
 
 
 
 
 
 
54
  ### Prerequisites
55
 
56
  - Python 3.10+ (Tested on 3.13)
57
-
58
  - Google Gemini API Key
59
-
60
  - Docker Desktop (Optional, for containerization)
61
-
62
  1. Clone the Repository
63
 
64
  git clone [https://github.com/Devisri-B/Agentic_RAG_Knowledge_Search.git](https://github.com/Devisri-B/Agentic_RAG_Knowledge_Search.git)
@@ -70,8 +77,11 @@ A generated CSV report scoring the agent's performance against ground truth data
70
 
71
  ```GOOGLE_API_KEY=your_actual_api_key_here```
72
 
 
 
 
73
 
74
- 3. Option A: Run Locally (Python)
75
 
76
  Install Dependencies:
77
 
@@ -85,7 +95,7 @@ A generated CSV report scoring the agent's performance against ground truth data
85
 
86
  The API will be available at http://localhost:8000/docs.
87
 
88
- 4. Option B: Run with Docker
89
 
90
  Build the Image:
91
 
 
1
  # Agentic RAG Knowledge Search
2
 
3
+ An Autonomous AI Microservice with Hybrid Retrieval & Self-Evaluation. Built with FastAPI, LangChain, Docker, and Google Gemini.
4
 
5
  ## Overview
6
 
 
10
 
11
  1. Internal Knowledge Base: A vector database (FAISS) for proprietary policy documents.
12
 
13
+ 2. External Web Search: DuckDuckGo for real-time, public information.
14
 
15
  The system includes a custom LLM-as-a-Judge Evaluation Pipeline to continuously benchmark answer accuracy and hallucination rates.
16
 
 
30
  - Automated Evaluation: Includes a custom "Judge" pipeline that uses one LLM to grade the accuracy of another, producing detailed CSV reports.
31
 
32
  - Containerized: Fully Dockerized for consistent deployment across any environment.
33
+
34
+ - REST API: Fully documented API using FastAPI.
35
 
36
  ## Demo & Outputs
37
 
 
53
 
54
  ## Setup & Installation
55
 
56
+ ### Project Structure
57
+
58
+ - src/rag_engine.py: Handles PDF ingestion and Vector Database (FAISS).
59
+ - src/agent.py: Defines the Agent, Tools, and LangChain logic.
60
+ - src/main.py: The FastAPI server entry point.
61
+ - data/: Place your PDF documents here.
62
+
63
  ### Prerequisites
64
 
65
  - Python 3.10+ (Tested on 3.13)
 
66
  - Google Gemini API Key
 
67
  - Docker Desktop (Optional, for containerization)
68
+
69
  1. Clone the Repository
70
 
71
  git clone [https://github.com/Devisri-B/Agentic_RAG_Knowledge_Search.git](https://github.com/Devisri-B/Agentic_RAG_Knowledge_Search.git)
 
77
 
78
  ```GOOGLE_API_KEY=your_actual_api_key_here```
79
 
80
+ 3. Add Data
81
+
82
+ - Place your PDF file (e.g., policy documents, course materials) into the data/ folder and rename it to policy.pdf (or update src/agent.py to match your filename).
83
 
84
+ 4. Option A: Run Locally (Python)
85
 
86
  Install Dependencies:
87
 
 
95
 
96
  The API will be available at http://localhost:8000/docs.
97
 
98
+ 5. Option B: Run with Docker
99
 
100
  Build the Image:
101