Skip to content

NoteNest: AI-powered note structuring tool using RAG pipeline. Developed by Team ProjectX at Students@AI Seoul Hackathon 2025.

License

Notifications You must be signed in to change notification settings

KwonNayeon/noteRAG

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NoteNest

noteRAG Logo

AI-Powered Multisensory Summarization for Cognitive-Friendly Learning

Python Swift OpenAI API LangChain Figma

Overview

NoteNest transforms complex content into accessible, cognitive-friendly summaries using RAG (Retrieval Augmented Generation). Our tool creates 3-line summaries for users with diverse cognitive needs, particularly those with reading or focus difficulties, with optional expandable details for each line.

Key Features

  • 3-Line AI Summaries: Concise summary of three key points from complex documents
  • Expandable Details: Click any summary line to reveal 3 supporting bullet points
  • Progressive Disclosure: Reduces cognitive load by showing details only when needed
  • Adaptive Content: Customized to user preferences and cognitive profiles
  • Visual Representations: Planned feature for future implementation

Problem & Solution

Many individuals with cognitive disabilities struggle with dense content. Traditional summarizers focus on condensing information without considering cognitive accessibility. NoteNest bridges this gap with summaries designed using cognitive science principles, making learning more accessible and engaging.

Technical Overview

Tech Stack

  • Backend: Python with LangChain for RAG processing
  • AI Integration: OpenAI API for summarization
  • Frontend: Swift iOS application
  • Design: Figma prototypes

Repository Structure

noterag/
├── backend/                  # Python RAG processing
│   ├── api.py                # API routes
│   ├── rag_pipeline.py       # LangChain flow
│   └── test_api.py           # For test
├── frontend/                 # iOS application
│   └── ProjectX/             # Swift implementation
├── scripts/                  # Development scripts
├── data/                     # Sample documents
├── prompts/                  # Prompt templates
├── README.md
└── requirements.txt

Quick Start

# Clone & install
git clone https://github.com/kwonnayeon/noteRAG.git
cd noteRAG
pip install -r requirements.txt

# Set up OpenAI API key
export OPENAI_API_KEY="your_api_key_here"

# Run backend
cd backend
python api.py

# For iOS frontend
cd ../frontend/ProjectX
open noteRAG.xcodeproj

Implementation Highlights

  • Learning Experience Optimization:

    • Progressive disclosure of information (click to expand)
    • Reduced cognitive burden through targeted summaries
    • Step-by-step exploration of complex topics
    • On-demand detail visibility
  • RAG-Enhanced Learning:

    • Smart document processing
    • Contextual understanding
    • Personalized content adaptation

Sample Files

The data/ directory contains example files demonstrating the input and output formats:

  • Input: Text files (.txt) containing content to be summarized
  • Output:
    • .json files with structured summary data for iOS app
    • .pdf files with formatted summaries for viewing/sharing

You can use these samples to understand the transformation process and expected formats.

Hackathon Project

This project was developed for Student@AI by Project X.

License

MIT License

About

NoteNest: AI-powered note structuring tool using RAG pipeline. Developed by Team ProjectX at Students@AI Seoul Hackathon 2025.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •