ELS Compass Logo

Overview

  • Overview
    • What Problem It Solves
    • Core Capabilities
    • How It Works
    • Permission Model
    • Deployment Shape
    • Where To Go Next

Installation

  • Installation
    • Planned Structure

Architecture

  • Architecture
    • Architecture Overview
      • Purpose
      • Layered Structure
        • Domain
        • Application
        • Infrastructure
        • Interfaces
      • Composition Root
      • Runtime Storage Split
        • Local filesystem
        • Models
        • OpenSearch
        • Valkey/Redis
        • Auth And RBAC
        • LLM
      • Request Flow
      • Startup Behavior
      • Current Boundaries That Matter
    • Request Routing And Conversation Orchestration
      • Public Modes
      • Conversation Spine
      • Direct Workspace Answers
      • Ordered Routing And Context
      • Document Discovery And Expansion
      • Planner Role
      • Evidence Regime Resolution
      • Evidence Binding
      • Workload Strategy
      • Latency, Cache, And Memory
      • Shared Output Contracts
    • Document Ingestion Pipeline
      • Goal
      • Pipeline Stages
      • Stage Breakdown
        • 1. Upload and registration
        • 2. Parse
        • 3. Chunk
        • 4. Embed and index
      • Document Catalog Projection
      • Retrieval Pyramid Projection
      • Full Orchestration
      • Threading And Event Loop Behavior
      • Language Backfill
      • Atomic Document Writes And Startup Integrity
      • Current Non-Goals
    • Chunking Pipeline
      • Purpose
      • Entry Point
      • Stage Flow
      • Chunk Layers
      • Section Chunks
      • Table Chunks
      • Document Chunk
      • Extractive Summary Source
      • Abstractive Summaries (Optional)
      • Chunk Metadata Fields
      • Chunk Policy Version
    • Answering Pipeline
      • Purpose
      • Entry Point
      • Dispatch Layer
        • Two-Phase Execution Planning
        • Planner Fallback
      • Execution Planner
        • Evidence Regime And Workload Boundary
        • Agent Flow Admission And Queue ETA
        • Planner Task Families
      • Workspace Awareness Service
        • Deterministic catalog document table
      • Grounded Answer Service
        • Document Scope Resolution
        • Retrieval
        • Document-Local Agent Research
        • Reranking
        • Evidence Sufficiency
        • Answer Generation
        • Citation Persistence
      • Answer Stream Contract
      • Execution Planning
    • Model Coordination And Valkey
      • Purpose
      • Boundary
      • ELS Compass Deployment Topology
      • Why Valkey Is Needed
      • What Uses The Coordination Plane
      • Failure Semantics
      • Enablement Gate
    • Document Lifecycle
      • Aggregate Role
      • Status Meanings
        • registered
        • parsing
        • parsed
        • chunking
        • chunked
        • embedding
        • indexing
        • indexed
        • ready
        • degraded
        • failed
        • archived
        • deleted
      • Allowed Transition Shape
      • Quality Signals
      • Searchability
      • Workspace Boundary Notes
    • Workspace, Conversation, And Governance Boundary
      • Aggregate Role
      • Workspace Lifecycle Meaning
        • active
        • archived
      • Conversation Role
      • Access And Identity Boundary
      • Governance Boundary
        • Archive
        • Destructive Delete
      • Current Bounded Resource Shape
      • Future Follow-Up
    • Current Implementation Decisions
      • 1. FastAPI is the current HTTP framework
      • 2. Uploads are staged before registration
      • 3. The local model directory is the default embedding source
      • 4. Workspace, conversation, and document metadata are JSON-backed for this phase
      • 5. Chunk indexing is OpenSearch-backed now
      • 6. Ingestion is driven by a durable OpenSearch-backed job queue
      • 7. Workspace access is enforced through the AIBS auth boundary
      • 8. Workspace deletion closes the in-process workspace boundary first
      • 9. Workspace archive is a governance-owned lifecycle operation
      • 10. Conversation records are lightweight backend-owned session containers
      • 11. Evidence-regime routing is now the stable query loop
      • 12. Shared chunk typing lives above infrastructure now
      • 13. LLM access is serialized through a concurrency gate
      • 14. Document language is a structured aggregate field, not a free-text hint
      • 15. Execution planning is split into intent and scope phases
      • 16. Document writes are atomic and validated at startup
      • 17. Workspace document catalog reads use an OpenSearch projection
      • 18. Smart document search is hybrid search with guarded AI expansion
      • 19. Broad document discovery uses a retrieval pyramid before chunk search
      • Deliberate Deferrals

Configuration

  • Configuration
    • Environment Setup
      • Before You Start
      • How To Create .env
      • Recommended Template
      • Section Notes
        • API server
        • OpenSearch
        • Embeddings
        • Reranker
        • Docling PDF parser
        • Chunking
        • Ingestion worker
        • Conversation memory
        • Answer pagination
        • Document Complexity
        • Heavy-tier multi-doc combine
        • Workspace document inventory
        • Remote GPU Worker Environment
        • Local storage
        • Document Catalog Rebuild CLI
        • Document Catalog Reconciliation CLI
        • Retrieval Pyramid Rebuild CLI
        • Auth and identity
        • Language Backfill CLI
        • Logging
        • LLM
        • LLM heavy reasoning lane
        • Shared coordination port
        • Shared model coordination
        • Best-effort application cache
        • Model admission and residency planning
      • Common Setup Checks
      • Related Docs

User Guide

  • User Guide
    • Planned Structure
    • What Is Needed To Write It

Operations

  • Operations
    • Worker Topology
    • Index And Projection Maintenance
    • Backfills
    • Administration And Capacity
      • Worker Split Deployment
        • Purpose
        • Process Roles
        • API Node
        • Worker Node
        • Shared Resources
        • Semantic Profile Lane
        • Validation Sequence
        • Scaling Notes
      • Ingestion Worker CLI
        • Purpose
        • Command
        • Required Environment
        • Startup Flow
        • Semantic Profile Stage
        • Worker Loop Behavior
        • Verification
        • Safety Notes
      • Rebuild Document Catalog CLI
        • Purpose
        • Command
        • Options
        • Execution Flow
        • What Gets Projected
        • Report Fields
        • Schema Upgrade
        • Operating Notes
      • Rebuild Retrieval Pyramid CLI
        • Purpose
        • Command
        • Options
        • Execution Flow
        • What Gets Projected
        • Report Fields
        • Schema Upgrade
        • Operating Notes
      • Backfill Language CLI
        • Purpose
        • Command
        • Options
        • Execution Flow
        • Report Fields
        • Exit Codes
        • Operating Notes
      • Backfill Semantic Profiles CLI
        • Purpose
        • Command
        • Options
        • Semantic Profile Contract
        • Model Lane
        • Execution Flow
        • Failure Behavior
        • Report Fields
        • Recommended Maintenance Sequence
        • Validation
      • Backfill Conversation Memory CLI
        • Purpose
        • Prerequisites
        • Command
        • Execution Flow
        • Idempotence And Recovery
        • Output And Exit Behavior
      • Bootstrap Admin CLI
        • Purpose
        • Command
        • Options
        • Execution Flow
        • Exit Codes
        • Security Notes
      • Model Capacity Audit
        • Command
        • What It Checks
        • Related Settings
        • Optional Host Telemetry Agent
        • Valkey Placement Test Gate
        • Residency Monitor Takeover Gate
        • Controlled Enable Smoke Test
      • Standalone Model Residency Monitor
        • Configuration
        • Demo control-plane deployment
        • Start
        • Verification

Integrations

  • Integrations
    • Current Runtime Dependencies
    • Planned

Security

  • Security
    • Auth And RBAC
      • Identity Source
      • Sessions
      • First Admin Bootstrap
      • Product User Management
      • Workspace Roles
      • Workspace Member Management
      • Frontend Visibility
      • Known Deferrals

API

  • API
    • HTTP API
      • Base Surface
      • Identity Boundary
      • Endpoints
        • POST /api/aibs/auth/login
        • POST /api/aibs/auth/logout
        • GET /api/aibs/auth/session
        • GET /api/aibs/admin/users
        • GET /api/aibs/admin/users/{username}
        • POST /api/aibs/admin/users
        • PUT /api/aibs/admin/users/{username}/entitlements
        • PUT /api/aibs/admin/users/{username}/password
        • PUT /api/aibs/admin/users/{username}/disable
        • POST /api/aibs/workspaces
        • GET /api/aibs/workspaces
        • GET /api/aibs/workspaces/{workspace_id}
        • PUT /api/aibs/workspaces/{workspace_id}
        • GET /api/aibs/workspaces/{workspace_id}/members
        • POST /api/aibs/workspaces/{workspace_id}/members
        • PUT /api/aibs/workspaces/{workspace_id}/members/{user_id}
        • DELETE /api/aibs/workspaces/{workspace_id}/members/{user_id}
        • POST /api/aibs/workspaces/{workspace_id}/archive
        • DELETE /api/aibs/workspaces/{workspace_id}
        • POST /api/aibs/workspaces/{workspace_id}/conversations
        • GET /api/aibs/workspaces/{workspace_id}/conversations
        • GET /api/aibs/conversations/{conversation_id}
        • PUT /api/aibs/conversations/{conversation_id}
        • DELETE /api/aibs/conversations/{conversation_id}
        • GET /api/aibs/conversations/{conversation_id}/history
        • POST /api/aibs/documents
        • GET /api/aibs/documents/catalog
        • GET /api/aibs/documents/search
        • GET /api/aibs/documents
        • PATCH /api/aibs/documents/{document_id}/knowledge
        • GET /api/aibs/documents/{document_id}/snippets
        • GET /api/aibs/documents/{document_id}/preview
        • GET /api/aibs/documents/{document_id}
        • POST /api/aibs/documents/{document_id}/process
        • DELETE /api/aibs/documents/{document_id}
        • POST /api/aibs/chat/
      • Response Models
        • WorkspaceResponse
        • WorkspaceListResponse
        • WorkspaceMemberResponse
        • ConversationResponse
        • ConversationListResponse
        • ConversationHistoryResponse
        • ConversationHistoryTurnResponse
        • DocumentResponse
        • DocumentListResponse
        • DocumentCatalogResponse
        • DocumentCatalogSummaryResponse
        • DocumentSnippetResponse
        • DocumentSnippetListResponse
        • ProcessAcceptedResponse
        • Error payload
      • Current Contract Boundaries

Troubleshooting

  • Troubleshooting
    • Startup Failures
      • Startup Succeeds But The Deployment Is Wrong
    • Login And Access Problems
    • Document Ingestion Problems
      • Reading The Backfill Report
    • Retrieval And Projection Problems
    • Answering Problems
    • Model Cluster Problems
    • Reading API Errors
    • Not Covered Yet

Release Notes

  • Release Notes
ELS Compass
  • Search

© Copyright 2026, EMCA Software. Last updated on 2026-07-28.

Built with Sphinx using a theme provided by Read the Docs.