LumenAI / README.md
nipunkavindaAI's picture
Update README.md
5a359b1 verified
|
Raw
History Blame Contribute Delete
3.42 kB
metadata
title: Lumen AI - Dubai Utility Bill Assistant
emoji: 
colorFrom: blue
colorTo: indigo
sdk: gradio
sdk_version: 6.20.0
app_file: app.py
pinned: true
license: mit
short_description: AI Assistant for DEWA Utility Bill Questions
thumbnail: >-
  https://cdn-uploads.huggingface.co/production/uploads/681ecc9f68e6f14b1e7d43b0/cbzKXEzOCugIJB5lAe4lJ.png

⚡ Lumen AI — Dubai Utility Bill & Energy Assistant

Lumen is a Retrieval-Augmented Generation (RAG) chatbot that answers questions about DEWA (Dubai Electricity & Water Authority) residential electricity and water bills — slab tariffs, fuel surcharge, housing/sewerage fees, VAT, and energy-saving tips — grounded entirely in a local knowledge base, with no hallucinated or out-of-scope answers.

Built as a 3-day AI bootcamp project (Decoding Data Science), following a production-style RAG architecture: LlamaIndex + Pinecone + OpenAI + Gradio.

Python Gradio LlamaIndex Pinecone License


🧠 What It Does

  • Answers DEWA electricity & water billing questions strictly from an attached knowledge base.
  • Explains slab tariffs, fuel surcharge, housing fee, sewerage fee, and VAT.
  • Provides illustrative bill estimates.
  • Suggests energy-saving tips.
  • Refuses to answer questions outside the DEWA billing domain.
  • Never invents account-specific information.

🏗️ Architecture

PDF Knowledge Base
        │
        ▼
LlamaIndex Reader
        │
        ▼
Chunking
        │
        ▼
OpenAI Embeddings
        │
        ▼
Pinecone Vector Database
        │
        ▼
GPT-4o-mini Query Engine
        │
        ▼
Gradio Chat Interface

📁 Project Structure

.
├── app.py
├── data/
│   ├── DEWA_Utility_Bill_Knowledge_Base.pdf
│   └── DEWA_Sample_FAQs.pdf
├── requirements.txt
├── .env
└── README.md

🚀 Running Locally

git clone https://github.com/<your-username>/lumen-ai-dewa-assistant.git
cd lumen-ai-dewa-assistant

pip install -r requirements.txt

Create a .env file:

OPENAI_API_KEY=your_openai_api_key
PINECONE_API_KEY=your_pinecone_api_key

Run:

python app.py

☁️ Deploy on Hugging Face Spaces

  1. Create a Gradio Space.
  2. Push this repository.
  3. Add your secrets:
    • OPENAI_API_KEY
    • PINECONE_API_KEY
  4. The Space will automatically launch using app.py.

🛠️ Tech Stack

Layer Technology
LLM GPT-4o-mini
Embeddings OpenAI Embeddings
Framework LlamaIndex
Vector DB Pinecone
UI Gradio
Language Python

⚠️ Disclaimer

This project is intended for demonstration purposes. The included PDF documents are sample references and should not be considered official DEWA tariff documentation.


📬 Contact

Nipun Kavinda

Industrial AI & Intelligent Automation Engineer

📧 nipun.mecheng@gmail.com


Built for the Decoding Data Science AI Bootcamp