Skip to content

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📚 Study Agent

An AI-powered study assistant that helps students learn from their own study materials using Retrieval-Augmented Generation (RAG) and Agentic AI.

✨ Features

  • 📄 Upload PDF lecture notes
  • 🔍 Semantic search with ChromaDB
  • 💬 Ask questions about uploaded documents
  • 📝 AI-generated summaries
  • 🧠 Flashcard generation
  • ❓ Quiz generation
  • 📅 Personalized study plans
  • 📊 Progress tracking

🏗️ Architecture

User
  │
FastAPI / Streamlit
  │
Orchestrator Agent
  ├── RAG Agent
  ├── Summary Agent
  ├── Quiz Agent
  ├── Flashcard Agent
  ├── Planner Agent
  └── Progress Agent

🛠️ Tech Stack

  • Python
  • FastAPI
  • PydanticAI
  • ChromaDB
  • Pydantic
  • Streamlit / React
  • Docker
  • GitHub Actions

📂 Project Structure

app/
 ├── agents/
 ├── rag/
 ├── memory/
 ├── tools/
 ├── prompts/
 ├── schemas/
 ├── models/
 └── main.py

⚙️ Environment Variables

Create a .env file:

OPENAI_API_KEY=
EMBEDDING_MODEL=
CHROMA_PATH=

▶️ Run

uv run python -m app.main

🧪 Example Workflow

  1. Upload a PDF.
  2. The document is parsed and chunked.
  3. Chunks are converted into embeddings.
  4. ChromaDB indexes the embeddings.
  5. Ask questions about the document.
  6. Generate summaries, quizzes, and flashcards.

📌 Roadmap

  • PDF Upload
  • RAG Pipeline
  • Semantic Search
  • Multi-Agent Workflow
  • Study Planner
  • Memory
  • Tools
    • Web Search Integration
    • ...
  • API
  • UI
  • Progress Tracking
  • Voice Assistant

📜 License

MIT License.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages