Skip to content
View TM11005's full-sized avatar

Block or report TM11005

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Maximum 250 characters. Please don't include any personal information such as legal names or email addresses. Markdown supported. This note will be visible to only you.
Report abuse

Contact GitHub support about this userโ€™s behavior. Learn more about reporting abuse.

Report abuse
TM11005/README.md

RAG Analysis Model

๐Ÿ“Œ Project Description

RAG Analysis Model is a Retrieval-Augmented Generation (RAG) based web application that allows users to upload documents through a simple user interface and prepare them for future analysis using AI-driven retrieval systems. The project currently focuses on the frontend upload interface and Flask backend integration for document handling.

This system is designed as a foundation for a full RAG pipeline where uploaded documents will later be processed for embeddings, retrieval, and intelligent question answering.


๐Ÿš€ Features

  • ๐Ÿ“‚ Document Upload Interface (UI)
  • ๐Ÿ“ก Flask Backend API for file uploads
  • ๐Ÿ—‚๏ธ Automatic file storage in the uploads folder
  • ๐Ÿ–ฅ๏ธ Simple and clean user interface (HTML, CSS)
  • ๐Ÿ”— REST API integration with frontend
  • ๐Ÿงฑ Scalable architecture for future RAG pipeline (Embeddings + Vector Search)

๐Ÿ› ๏ธ Tech Stack

Frontend:

  • HTML
  • CSS
  • JavaScript (Basic)

Backend:

  • Python
  • Flask
  • Flask-CORS

Development Tools:

  • VS Code
  • Git & GitHub

๐Ÿ“ Project Structure

RAG-Analysis-Model/
โ”‚โ”€โ”€ app.py
โ”‚โ”€โ”€ uploads/
โ”‚โ”€โ”€ templates/
โ”‚โ”€โ”€ static/
โ”‚โ”€โ”€ README.md
  • app.py โ†’ Flask backend server
  • uploads/ โ†’ Stores uploaded documents
  • templates/ โ†’ Frontend HTML files
  • static/ โ†’ CSS and JS files

โš™๏ธ Installation & Setup

1๏ธโƒฃ Clone the Repository

git clone https://github.com/TM11005/TM11005.git
cd RAG-Analysis-Model

2๏ธโƒฃ Create Virtual Environment (Recommended)

python -m venv venv
venv\Scripts\activate   # For Windows

3๏ธโƒฃ Install Dependencies

pip install flask flask-cors

4๏ธโƒฃ Run the Flask Server

python app.py

5๏ธโƒฃ Open the Application

Open your browser and go to:

http://localhost:5000

๐Ÿ”Œ API Endpoints

๐Ÿ“ค Upload Files

Endpoint: /api/upload Method: POST Description: Uploads documents and saves them to the uploads folder for future RAG processing.


๐Ÿง  Current Project Status

โœ”๏ธ UI for document upload completed โœ”๏ธ Flask backend for file handling implemented โŒ Query/Chat RAG pipeline not yet implemented โŒ Embeddings and vector database integration pending


๐Ÿ”ฎ Future Improvements

  • ๐Ÿ” Add vector database (FAISS / ChromaDB)
  • ๐Ÿ’ฌ Implement chat/query endpoint for document Q&A
  • ๐Ÿค– Integrate LLM for intelligent responses
  • ๐Ÿ” Add authentication (Student/Teacher/Admin roles)
  • โšก Upgrade UI with React or Angular
  • ๐Ÿ“Š Document analysis dashboard

๐ŸŽฏ Learning Objectives

This project was developed to:

  • Understand Retrieval-Augmented Generation (RAG) architecture
  • Build full-stack AI applications using Flask
  • Design REST APIs for AI workflows
  • Create a scalable frontend for AI-based systems

๐Ÿ‘จโ€๐Ÿ’ป Author

Developed as part of a B.E. Computer Science project focusing on AI, cybersecurity, and intelligent document analysis systems.


๐Ÿ“„ License

This project is for educational and academic purposes.

Popular repositories Loading

  1. TM11005 TM11005 Public

    Config files for my GitHub profile.

    JavaScript 38