RAG - lesson 7 | HackIndia Skills

RAG - lesson 7 | HackIndia Skills | HackIndia

Example

Simple repo shape

Use boring names. They help people inspect your project fast.

doc-qa-rag/
  README.md
  requirements.txt
  .env.example
  app.py
  ingest.py
  evaluate.py
  data/
    sample_docs/
      college_faq.txt
      refund_policy.txt
  examples/
    questions.json
    cited_answers.md
  eval/
    grounding_eval.md

Example

README skeleton

Your README is the front door. Write it for someone who has five minutes before their next meeting.

# Document QA RAG App

Ask questions from the sample documents and get answers with citations.

## Features
- Loads documents from data/sample_docs
- Splits documents and creates embeddings
- Retrieves evidence for each question
- Answers with source citations
- Includes a small grounding evaluation

## Setup
1. Clone the repo
2. Create a virtual environment
3. Install dependencies: pip install -r requirements.txt
4. Copy .env.example to .env and add your API key
5. Run ingestion: python ingest.py
6. Start the app: python app.py

## Try these questions
- What is the refund window?
- Who can apply for the hostel Wi-Fi pass?

## Grounding evaluation
See eval/grounding_eval.md for questions, answers, citations, and notes.

Ship the repo end to end

Repo proves the skill

What to include

Minimum repo checklist

Simple repo shape

README skeleton

Do not overclaim

Use AI carefully

Do this now

Quick check