Skip to content

Documentation

Welcome! GreenGovRAG is an AI assistant powered by Retrieval-Augmented Generation (RAG) that helps navigate Australian environmental and planning regulations.

What is GreenGovRAG?

GreenGovRAG combines regulatory document retrieval with geospatial filtering to answer questions about:

  • Environmental Compliance - EPBC Act, state environmental regulations
  • Land Use & Planning - Local council planning schemes, zoning rules
  • Vegetation Clearing - Native vegetation regulations by state and LGA
  • Emissions Standards - NGER reporting, ESG frameworks, carbon accounting

Key Features:

  • Multi-LLM support (OpenAI, Anthropic, AWS Bedrock, Azure)
  • Geospatial filtering by Local Government Area (LGA)
  • Legal-grade citations with page numbers and sections
  • Hybrid search (BM25 + vector similarity)
  • Cloud storage support (AWS S3, Azure Blob, Local)
  • Production-ready deployment options

Getting Started Paths

I want to use GreenGovRAG

Start here if you want to query Australian regulations:

  1. Installation Guide - Set up GreenGovRAG
  2. Quick Start - Get running in 5 minutes
  3. Configuration Guide - Configure your setup
  4. First Query Tutorial - Submit your first query

Then explore:

I want to contribute to GreenGovRAG

Start here if you want to add document sources or fix bugs:

  1. Contribution Overview - How to contribute
  2. Development Setup - Set up your environment
  3. Adding Document Sources - Add new regulations
  4. Code Style Guide - Follow our standards
  5. Testing Guide - Write and run tests
  6. Pull Request Workflow - Submit your changes

I want to customize or extend GreenGovRAG

Start here if you want to customize the RAG pipeline or add features:

  1. System Architecture - Understand the design
  2. RAG Pipeline Deep Dive - How RAG works
  3. ETL Pipeline Guide - Document processing
  4. Plugin System - Extensibility
  5. Metadata Standards - ESG & geospatial tags
  6. Citation System - Legal-grade citations

I want to deploy GreenGovRAG

Start here if you want to deploy to production:

  1. Deployment Overview - Choose your deployment
  2. Cloud Provider Comparison - AWS vs Azure vs Local
  3. Local Docker Setup - Development environment
  4. AWS Deployment - Deploy on AWS
  5. Azure Deployment - Deploy on Azure
  6. Production Checklist - Go-live requirements

Documentation Structure

User Guide

Learn how to use GreenGovRAG effectively:

Contributor Guide

For open-source contributors:

Developer Guide

For advanced customization:

Deployment

Production deployment guides:

API Reference

Comprehensive API documentation:

Reference

Quick lookup documentation:

Common Tasks

Troubleshooting

Technology Stack

Backend: - Python 3.12 - FastAPI for REST API - SQLModel for ORM - LangChain for RAG - PostgreSQL with pgvector

RAG: - FAISS/Qdrant for vector storage - HuggingFace embeddings - Multi-LLM support (OpenAI, Anthropic, AWS Bedrock, Azure)

ETL: - Airflow (local dev) - GitHub Actions (production) - Unstructured.io for PDF parsing

Cloud: - AWS (ECS Fargate, S3, RDS) - Azure (Container Apps, Blob Storage, PostgreSQL) - Docker for containerization

Project Status

Current Version: 0.1.0 (Pre-release)

What's Working:

  • RAG query pipeline with geospatial filtering
  • Multi-LLM support (OpenAI, Anthropic, AWS Bedrock, Azure)
  • Vector stores (FAISS, Qdrant)
  • Cloud storage (AWS S3, Azure Blob, Local)
  • ETL pipeline with plugin system
  • Legal-grade citations
  • AWS and Azure deployment

Planned:

  • 📋 Multi-LGA query support
  • 📋 Real-time document update webhooks
  • 📋 Parcel-level geospatial queries
  • 📋 Export to PDF/DOCX reports

Support & Community

Get Help

Contributing

We welcome contributions! See the Contributor Guide to get started.

Quick links: - Contributing Guidelines - Development Setup - Pull Request Process

Resources

  • GitHub Repository: https://github.com/sdp5/green-gov-rag
  • Project Board: https://github.com/sdp5/green-gov-rag/projects
  • Changelog: View release history
  • License: MIT License

About

Author: Sundeep Anand (contact@sundeep.id.au)

Purpose: GreenGovRAG helps individuals, businesses, and government navigate Australia's complex environmental and planning regulations through AI-powered document retrieval.

Data Sovereignty: All regulatory documents are sourced from official Australian government websites, and all data are processed and stored in Australia. (Sydney Datacenter) See Data Sources for details.

Ready to get started? Choose your path above or jump straight to the Quick Start Guide!