Validate and verify Quranic verses in LLM-generated text with high accuracy
Project description
Ijaza
Validate and verify Quranic verses in LLM-generated text with high accuracy.
Ijaza (Arabic: إجازة, meaning "authorization" or "permission to transmit") is a Python library that ensures the authenticity of Quranic text in AI-generated content. Just as traditional Islamic scholarship requires an ijaza to transmit sacred knowledge, this library provides a digital verification layer for Quranic quotes.
Motivation
Large Language Models (LLMs) frequently misquote Quranic verses — changing words, mixing verses, or even fabricating text that sounds Quranic but isn't. This is a serious concern for:
- Islamic content creators who need accurate Quranic citations
- Educational platforms teaching Quran and Islamic studies
- AI applications serving Muslim communities (chatbots, translation tools, khutbah assistants)
- Developers building LLM-powered tools that handle religious text
Ijaza catches these errors automatically, corrects misquotations, and ensures that every Quranic verse in your application is authentic.
Origin & Credits
This project began as a Python reimplementation of the excellent quran-validator npm package by Yazin Alirhayim. We needed the same functionality for our Python-based projects and decided to port it while adding features specific to our use case.
Ijaza was developed as part of the PolyKhateeb project — a real-time transcription and translation system for Islamic sermons (khutbahs). In that context, we needed to:
- Detect Quranic segments in transcribed speech to preserve them verbatim
- Validate LLM-corrected text to catch any misquotations
- Inject system prompts into LLMs to properly tag Quran quotes
Installation
pip install ijaza
For better fuzzy matching performance (optional):
pip install ijaza[performance]
Usage
Basic Validation
from ijaza import QuranValidator
validator = QuranValidator()
# Validate a specific quote
result = validator.validate("بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ")
print(result.is_valid) # True
print(result.reference) # "1:1"
print(result.match_type) # "exact"
print(result.confidence) # 1.0
Detect Quran Quotes in Text
from ijaza import QuranValidator
validator = QuranValidator()
text = "The Prophet said to recite بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ before eating."
detection = validator.detect_and_validate(text)
for segment in detection.segments:
if segment.validation and segment.validation.is_valid:
print(f"Found: {segment.text}")
print(f"Reference: {segment.validation.reference}")
Look Up Verses
from ijaza import QuranValidator
validator = QuranValidator()
# Get a specific verse
verse = validator.get_verse(surah=112, ayah=1)
print(verse.text) # Full text with diacritics
print(verse.text_simple) # Simplified text
# Get a range of verses
result = validator.get_verse_range(surah=112, start_ayah=1, end_ayah=4)
print(result['text'])
# Search for verses
results = validator.search("الرحمن", limit=5)
for r in results:
print(r)
LLM Integration
from ijaza import LLMProcessor, SYSTEM_PROMPTS
# 1. Add system prompt to your LLM call
system_prompt = SYSTEM_PROMPTS['xml'] # or 'markdown', 'bracket', 'minimal'
# 2. Process LLM response
processor = LLMProcessor()
result = processor.process(llm_response)
# 3. Use corrected text
print(result.corrected_text)
print(result.all_valid) # True if all quotes are authentic
# 4. Check for issues
for quote in result.quotes:
if quote.was_corrected:
print(f"Corrected: {quote.original} -> {quote.corrected}")
Quick Validate (One-liner)
from ijaza import quick_validate
result = quick_validate(llm_response)
print(result['has_quran_content']) # True/False
print(result['all_valid']) # True if all quotes are correct
print(result['issues']) # List of issues found
Arabic Normalization Utilities
from ijaza import normalize_arabic, remove_diacritics, contains_arabic
# Normalize Arabic text for comparison
normalized = normalize_arabic("بِسْمِ اللَّهِ") # "بسم الله"
# Remove only diacritics
clean = remove_diacritics("السَّلَامُ") # "السلام"
# Check for Arabic content
has_arabic = contains_arabic("Hello مرحبا") # True
Features
- Multi-tier matching: exact → normalized → partial → fuzzy
- LLM integration: System prompts + post-processing validation
- Arabic normalization: Handles diacritics, alef variants, hamza, etc.
- Auto-correction: Fixes misquoted verses automatically
- Detection: Finds untagged Quran quotes in text
- Full database: 6,236 verses with Uthmani script
- Zero dependencies: Pure Python implementation (optional
rapidfuzzfor performance)
API Reference
QuranValidator
from ijaza import QuranValidator, ValidatorOptions
# With custom options
validator = QuranValidator(ValidatorOptions(
fuzzy_threshold=0.85,
max_suggestions=5,
include_partial=True,
))
# Validate text
result = validator.validate("Arabic text here")
# Detect and validate all quotes in text
detection = validator.detect_and_validate("Text with Quran quotes...")
# Get specific verse
verse = validator.get_verse(surah=1, ayah=1)
# Get verse range
range_result = validator.get_verse_range(surah=112, start_ayah=1, end_ayah=4)
# Search verses
results = validator.search("search query", limit=10)
LLMProcessor
from ijaza import LLMProcessor, LLMProcessorOptions
processor = LLMProcessor(LLMProcessorOptions(
auto_correct=True,
min_confidence=0.85,
scan_untagged=True,
tag_format='xml', # or 'markdown', 'bracket'
))
# Get system prompt for your LLM
prompt = processor.get_system_prompt()
# Process LLM output
result = processor.process(llm_output)
Normalization Utilities
from ijaza import (
normalize_arabic,
remove_diacritics,
contains_arabic,
extract_arabic_segments,
calculate_similarity,
)
# Normalize Arabic text
normalized = normalize_arabic("بِسْمِ اللَّهِ") # "بسم الله"
# Remove only diacritics
clean = remove_diacritics("السَّلَامُ") # "السلام"
# Check for Arabic content
has_arabic = contains_arabic("Hello مرحبا") # True
# Extract Arabic segments from mixed text
segments = extract_arabic_segments("The verse بسم الله means...")
# Calculate text similarity
similarity = calculate_similarity("text1", "text2") # 0.0 - 1.0
Future Work
Translation Validation
Include major English translations (Sahih International, Pickthall, Yusuf Ali) and validate that translations correspond to the correct Arabic source verse.
Framework Integrations
- LangChain / LlamaIndex guardrails
- FastAPI middleware
- Streamlit components
- Django/Flask integration
Performance Optimizations
- N-gram indexing for pre-filtering
- BK-tree for metric-space nearest-neighbor search
- Async/streaming support for real-time pipelines
Contributing
Contributions are welcome! Please feel free to submit issues and pull requests.
License
MIT
Acknowledgments
- Yazin Alirhayim for the original quran-validator npm package
- AlQuran.cloud for the Quran API
- The PolyKhateeb project team
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ijaza-1.0.1.tar.gz.
File metadata
- Download URL: ijaza-1.0.1.tar.gz
- Upload date:
- Size: 2.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f5eb4e49fe72c823598bcf9eac0ca0901cecd3b851e6d61693d1b81c77fbe778
|
|
| MD5 |
4c03d318fb6536b322b695e6bebfbaa2
|
|
| BLAKE2b-256 |
3de230c20c6e698844b06491831279ca54c2feb4c332429b19fc36db3317e4bc
|
File details
Details for the file ijaza-1.0.1-py3-none-any.whl.
File metadata
- Download URL: ijaza-1.0.1-py3-none-any.whl
- Upload date:
- Size: 1.4 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
61e0a6b6f50d023040136f42c9552944900f9b3d05a486ccf0025c3ad7817e84
|
|
| MD5 |
935938c456b3ca5e7bba94cc71cea755
|
|
| BLAKE2b-256 |
f3f1f819f7e713e190c3fa1c9fe0aa77b1a9a603110cc6a672f6aabb9fc4422d
|