Welcome to the complete documentation for iris-vector-rag - Enterprise-grade RAG framework powered by InterSystems IRIS.
This index provides organized access to all documentation by topic and user journey.
New to iris-vector-rag? Start here:
| Document | Description | Audience |
|---|---|---|
| User Guide | Complete installation, configuration, and usage guide | All users |
| API Reference | Detailed API documentation for all pipelines | Developers |
| Pipeline Guide | Pipeline selection guide - which pipeline for your use case | Developers |
Deep dives into specific features:
| Document | Description |
|---|---|
| IRIS EMBEDDING Guide | Auto-vectorization with model caching, multi-field embeddings |
| MCP Integration | Model Context Protocol setup for Claude Desktop |
| IRIS Global GraphRAG | Academic papers with 3D visualization |
| IRIS Graph Core Integration | Graph-based retrieval integration |
For contributors and developers:
| Document | Description |
|---|---|
| Contributing Guide | Development setup, testing, pull requests |
| Custom Reranker Guide | Build custom reranking models |
| Example Enhancement Guide | Extend examples and demos |
| Test Setup | Testing environment configuration |
System design and architecture documentation:
| Document | Description |
|---|---|
| Comprehensive Architecture Overview | Complete system architecture |
| ColBERT Component Interfaces | ColBERT integration design |
| ColBERT Modular Design | Modular ColBERT architecture |
| GraphRAG Entity Extraction | Entity extraction system |
| GraphRAG Service Interfaces | GraphRAG service layer |
| RAG Memory Architecture | Memory component design |
| RAG Templates Adapter | Adapter pattern implementation |
Test coverage, execution, and quality reports:
| Document | Description |
|---|---|
| E2E Test Coverage Report | End-to-end test coverage |
| E2E Test Results | Test execution results |
| Test Execution Guide | How to run tests |
| E2E Test Strategy | Testing approach and methodology |
| TDD Compliance | Test-driven development practices |
| Coverage Warnings | Coverage gaps and improvements |
| Error Messages | Common errors and solutions |
Production deployment and migration guides:
| Document | Description |
|---|---|
| Production Readiness Assessment | Production checklist |
| Pipeline Migration Strategy | Migrating between pipelines |
| Public Repository Sync | Open-source repository management |
Roadmaps, progress tracking, and governance:
| Document | Description |
|---|---|
| Unified Project Roadmap | Long-term project roadmap |
| Implementation Progress | Current implementation status |
| Implementation Status | Detailed feature status |
| Completion Roadmap | Path to completion |
| Project Completion Report | Validated completion analysis |
Known issues and workarounds:
| Document | Description |
|---|---|
| IRIS SQL Vector Parameterization Bug | Known IRIS vector query bug |
| IRIS Vector SQL Parameterization Repro | Bug reproduction steps |
| Schema Migration Loop Bug | Schema migration issue |
| E2E Schema Compatibility Fix | Schema compatibility resolution |
Performance benchmarks and RAGAS evaluation:
| Document | Description |
|---|---|
| Benchmarking Consolidation Guide | Unified benchmarking approach |
| PyLate RAGAS Evaluation | PyLate ColBERT evaluation results |
| PyLate ColBERT Testing | ColBERT testing methodology |
Feature design and specification documents:
| Document | Description |
|---|---|
| Comprehensive Reconciliation Design | Reconciliation system design |
| Pseudocode Report Generator | Code generation specifications |
Historical documents (no longer active):
| Document | Description |
|---|---|
| Graph RAG Templates Roadmap | Archived GraphRAG roadmap |
Evaluator (trying out iris-vector-rag):
- User Guide - Installation
- Pipeline Guide - Which pipeline to use
- API Reference - API details
Developer (building with iris-vector-rag):
- API Reference - Complete API
- IRIS EMBEDDING Guide - Auto-vectorization
- MCP Integration - Claude Desktop integration
- Contributing Guide - Development setup
Contributor (improving iris-vector-rag):
- Contributing Guide - Setup and standards
- Test Execution Guide - Run tests
- Architecture Overview - System design
Enterprise Architect (evaluating for production):
- Production Readiness Assessment - Deployment checklist
- Architecture Overview - System design
- E2E Test Coverage - Quality metrics
RAG Pipelines:
- Pipeline Guide - Selection guide
- User Guide - Usage examples
- API Reference - API documentation
IRIS Integration:
- IRIS EMBEDDING Guide - Auto-vectorization
- IRIS Graph Core - Graph integration
- IRIS Global GraphRAG - Advanced GraphRAG
Advanced Features:
- MCP Integration - Model Context Protocol
- Custom Reranker Guide - Custom models
- Ontology Integration - Domain ontologies
Production & Quality:
- Production Readiness - Deployment checklist
- E2E Test Coverage - Test metrics
- Benchmarking Guide - Performance evaluation
Found a documentation issue? Want to improve these docs?
- Check Contributing Guide for documentation standards
- Submit a pull request with your improvements
- Tag documentation changes with
docs:prefix in commit message
- Documentation Issues: GitHub Issues
- Questions: GitHub Discussions
- Enterprise Support: InterSystems Support
Last Updated: 2025-11-09 Documentation Version: 1.0