Skip to content

0221csds146/EZ_Gen_Ai_project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📚 EZ GenAI – Smart Assistant for Research Summarization

An AI-powered research assistant built with Streamlit, LangChain, and Groq API, designed to intelligently summarize, query, and challenge users with MCQs based on uploaded PDF/TXT research documents.

🎥 Demo Video

YouTube
Video Link: Watch the demo video on YouTube

Use this GenAI

🔗 Live App: https://ezgenaiproject-rajeevkumar.streamlit.app/)


📜 License: License: MIT


🚀 Features

  • ✅ Upload and process .pdf or .txt documents
  • ✨ AI-generated summary
  • 🔍 Ask custom questions with source references
  • 🧠 "Challenge Me" mode with logic-based MCQs and answer feedback
  • 💬 Conversational Q&A using memory buffer
  • ⚡ Fast response powered by Groq’s LLaMA3 LLMs

🧱 Architecture & Reasoning Flow

flowchart TD
    A[User Uploads PDF/TXT] --> B[Text Extraction]
    B --> C[Text Chunking & Embedding via FAISS]
    C --> D[Summarization with LLM]
    C --> E[Q&A with RetrievalQA]
    C --> F[Logic-Based MCQ Generation]
    F --> G[User Response Evaluation]
    E --> H[Answer + Source Snippets]
    G --> I[Feedback on Answers]
Loading

⚙️ Setup Instructions

1. Clone the repository

git clone https://github.com/0221csds146/EZ_Gen_Ai_project.git
cd EZ_Gen_Ai_project

2. Create and activate a virtual environment (optional but recommended)

# Linux/macOS
python -m venv venv
source venv/bin/activate

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

3. Install the dependencies

pip install -r requirements.txt

4. Configure your API key

You need a Groq API Key for LLaMA3 access.

Option A – Create a .env file:

GROQ_API_KEY=your_groq_key_here

Option B – Use Streamlit Secrets:

Create a file at .streamlit/secrets.toml:

GROQ_API_KEY = "your_groq_key_here"

5. Run the Streamlit app

streamlit run main.py

📂 Project Structure

EZ_Gen_Ai_project/
├── main.py                 # Streamlit frontend
├── backend.py              # LangChain logic + prompt handling
├── prompts.py              # Prompt templates
├── requirements.txt
├── .env / secrets.toml     # API keys
└── README.md

🧰 Tech Stack

Technology Description
Python Core backend language used to build the application
Streamlit UI framework for creating the interactive web app
LangChain Framework for managing LLM chains (Q&A, summarization, MCQs)
Groq API (LLaMA3) Fast LLM used for all generative tasks
FAISS Vector database for efficient semantic search
PyPDF2 PDF text extraction utility
dotenv / Secrets Secure handling of API keys using .env or Streamlit secrets

💡 Acknowledgements


🤝 License

This project is licensed under the MIT License.

About

An AI-powered Streamlit app that helps you summarize, query, and reason over academic documents (PDF/TXT) using state-of-the-art language models via Groq API. Designed for researchers, students, and professionals to quickly extract insights and test comprehension.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages