-
Notifications
You must be signed in to change notification settings - Fork 1
future_work
Stand: 5. Dezember 2025
Version: 1.0.0
Kategorie: Development
Status: v1 Complete (BM25 HTTP + Hybrid Fusion) – v2 Planning
Verification – 16. November 2025
- Kurze Überprüfung gegen den Quellcode:
- Gefunden/implementiert: BM25 + FULLTEXT AQL Integration, Hybrid Text+Vector Fusion, Stemming/Analyzer, VectorIndex (HNSW optional), SemanticCache, HKDFCache, TSStore + Gorilla Codec, ContentManager ZSTD Wrapper.
- Fehlend / nur dokumentiert: CDC/Changefeed HTTP Endpoints (GET /changefeed, SSE), FieldEncryption batch API (
encryptEntityBatch) und PKI/eIDAS Signaturen (Design vorhanden, produktive Implementierung fehlt).- Empfehlung: Nächster Implementierungsschritt: CDC/Changefeed (MVP) — siehe
docs/development/todo.mdfür Details.
Stashed changes
- API: POST /search/fulltext
- Scoring: Okapi BM25 (k1=1.2, b=0.75)
- Index: TF/DocLength automatic maintenance
- Response: {pk, score} sorted by relevance
- Tests: 10/10 passed
- API: POST /search/fusion
- Modes: RRF (rank-based) and Weighted (score-based)
- Flexibility: Text-only, Vector-only, or combined
- Normalization: Min-Max for weighted, reciprocal rank for RRF
- Tests: No regressions in fulltext suite
- Implementation: Porter-Subset (EN), simplified suffix removal (DE)
-
Configuration: Per-index via
POST /index/createwith:{ "type": "fulltext", "config": { "stemming_enabled": true, "language": "en" // en | de | none } } - Index Maintenance: Consistent tokenization in Put/Delete/Rebuild
- Query-Time: Automatically uses index config for query tokens
-
Storage: Config persisted in
ftidxmeta:table:columnas JSON -
Backward Compatible: Default
{stemming_enabled: false, language: "none"} - Tests: 16/16 stemming tests passed + 10/10 fulltext regression tests
-
HTTP API:
/index/createwithtype: "fulltext"and optionalconfig - OpenAPI: Documented in openapi.yaml with examples
- Stopwords: Pro-Index konfigurierbar (Default-Listen EN/DE, Custom-Liste)
Goal: Implement FULLTEXT(field, query) operator in AQL
Status: ✅ Implementiert (aql_translator.cpp lines 101-174)
Features:
- Syntax:
FULLTEXT(doc.field, "query" [, limit]) - Standalone FULLTEXT queries
- FULLTEXT + AND Kombinationen (hybride Suche)
- FULLTEXT + OR via DisjunctiveQuery
- Integration mit BM25() Scoring
Beispiel-Queries:
-- Simple FULLTEXT
FOR doc IN articles
FILTER FULLTEXT(doc.content, "machine learning")
RETURN doc
-- FULLTEXT + BM25 scoring
FOR doc IN articles
FILTER FULLTEXT(doc.content, "machine learning")
SORT BM25(doc) DESC
LIMIT 10
RETURN {title: doc.title, score: BM25(doc)}
-- FULLTEXT + AND (hybrid)
FOR doc IN articles
FILTER FULLTEXT(doc.content, "neural networks") AND doc.year == "2024"
RETURN doc
-- FULLTEXT + OR (disjunctive)
FOR doc IN articles
FILTER FULLTEXT(doc.content, "AI") OR doc.category == "research"
RETURN doc
Tests: 23/23 green (test_aql_fulltext.cpp, test_aql_fulltext_hybrid.cpp)
Goal: Enable BM25 scoring in AQL queries with SORT support
Status: ✅ Implementiert
Implementation Details:
-
Query Engine Extension (query_engine.cpp)
- Neue Methode:
executeAndKeysWithScores()liefertKeysWithScores - Score-Map aus
scanFulltextWithScores() - Scores bleiben über AND-Intersections mit Strukturprädikaten erhalten
- Neue Methode:
-
Function Evaluation (query_engine.cpp lines 963-982)
-
BM25(doc)liest Score ausctx.getBm25ScoreForPk(pk) - 0.0 Fallback, wenn kein Score vorhanden
- Extrahiert
_keyoder_pkaus dem Dokumentobjekt
-
-
SORT Integration
-
SORT BM25(doc) DESCnutzt Score aus EvaluationContext - Automatische Befüllung via
ctx.setBm25Scores()bei FULLTEXT
-
Beispiel-Query:
FOR doc IN articles
FILTER FULLTEXT(doc.content, "machine learning")
SORT BM25(doc) DESC
LIMIT 10
RETURN {title: doc.title, score: BM25(doc)}
Tests: 4/4 grün (test_aql_bm25.cpp)
- BasicBM25FunctionParsing
- ExecuteAndKeysWithScores
- BM25ScoresDecreaseWithRelevance
- NoScoresForNonFulltextQuery
Goal: Extend stemming with additional linguistic features
Potential Enhancements:
Stopword Filtering
- Implemented in v1.2 (Default EN/DE + Custom per Index)
-
Umlaut Normalization (German)- ✅ Implemented in v1.2 (normalize_umlauts config option)
- Normalize "ä→a", "ö→o", "ü→u", "ß→ss"
- Improves matching for search queries without special chars
- Example: "läuft" → "lauft" (stems to "lauf")
- Implementation:
utils::Normalizer::normalizeUmlauts() - Tests:
test_normalization.cpp(2/2 passing)
-
Compound Word Splitting (German)
- Split "Fußballweltmeisterschaft" → "fußball welt meisterschaft"
- Critical for German precision/recall
- Requires dictionary or ML-based approach
-
Lemmatization (vs. Stemming)
- More accurate morphological analysis
- "running" → "run", "better" → "good"
- Requires POS tagging and lexicon
Effort Estimate: 2-5 days (depending on scope)
- Stopwords: 4-6 hours
- Umlaut normalization: 2-3 hours
- Compound splitting: 1-2 days (complex)
- Lemmatization: 2-3 days (requires NLP library)
Complexity: Medium-High
- Stopwords: Low
- Normalization: Low
- Compound splitting: High (ambiguity resolution)
- Lemmatization: High (dependency on NLP toolkit)
Priority: Medium
- Stopwords: High value/effort ratio
- Umlaut normalization: High for German content
- Compound splitting: Nice-to-have (complex)
- Lemmatization: Overkill for most use cases (stemming sufficient)
Alternative Analyzers (Future):
- N-Grams (for partial matching, typo tolerance)
- Phonetic matching (Soundex, Metaphone for fuzzy search)
- Synonym expansion
- Stop-word removal
Goal: Replace substring-based phrases with true position-aware phrase matching
Example:
{
"query": "\"machine learning\"",
"match": "exact phrase only, not 'machine' and 'learning' separately"
}Requirements:
- Extend index to store token positions (position arrays alongside TF)
- Phrase query parser: detect quoted strings
- Proximity verification: ensure tokens appear consecutively (or within k-window)
Effort: 2-3 days (incremental over current substring approach)
Goal: Return matched terms/snippets in response
Example Response:
{
"pk": "doc123",
"score": 8.5,
"highlights": {
"content": "...with <em>machine learning</em> algorithms..."
}
}Requirements:
- Extract matched tokens from query
- Locate occurrences in document text
- Generate snippets with highlighting markup
Effort: 1-2 days
Goal: Replace hand-tuned fusion with learned weights
Approach:
- Collect query logs with relevance judgments
- Train LambdaMART/LightGBM ranker
- Features: BM25 score, Vector similarity, metadata signals
- Online serving: predict fusion weights per query
Effort: 1-2 weeks (requires ML infrastructure)
Goal: Efficient retrieval → reranking architecture
Stages:
- Retrieval (fast, high recall): Fusion search with k=1000
- Reranking (slow, high precision): Cross-encoder on top-100
- Diversification (optional): MMR for result diversity
Effort: 2-3 days (without Cross-Encoder integration)
High Priority (v2):
- ✅ BM25 HTTP API (DONE)
- ✅ Hybrid Fusion (DONE)
- 🔲 Stemming (DE/EN) – Next
- 🔲 AQL Integration – After Stemming
Medium Priority (v3): 5. 🔲 Phrase Search 6. 🔲 Query Highlighting 7. 🔲 Advanced Analyzers (N-Grams, Synonyms)
Low Priority (v4+): 8. 🔲 Learned Fusion 9. 🔲 Multi-Stage Reranking 10. 🔲 Query Expansion
Unit Tests:
- Stemmer: token → stem mappings for DE/EN
- AQL Parser: BM25(doc) function parsing
- Query Engine: Score context propagation
Integration Tests:
- End-to-end AQL queries with FULLTEXT + SORT BM25
- Stemming: Query "running" matches docs with "run"
- Phrase search: Quoted vs. unquoted queries
Performance Tests:
- BM25 latency: 100k docs, 5-token queries (target: <50ms)
- Fusion overhead: Text+Vector vs. separate (target: <2× slowdown)
- Stemming impact: Index size increase (expect: +10-20%)
-
AQL Syntax Guide: FULLTEXT operator, BM25(doc) function ✅ COMPLETE
- Dokumentiert in
docs/aql_syntax.md(Zeilen 172-195, 491-577) - FULLTEXT operator vollständig dokumentiert mit Beispielen
- BM25(doc) Funktion für Score-Zugriff dokumentiert
- Hybrid Search (FULLTEXT + AND) dokumentiert
- Dokumentiert in
-
Index Configuration: Stemming options, language codes ✅ COMPLETE
- Dokumentiert in
docs/search/fulltext_api.md(Zeilen 1-150) - Stemming:
stemming_enabled,language(en/de/none) - Stopwords:
stopwords_enabled, customstopwordsarray - Umlaut-Normalisierung:
normalize_umlautsfür DE - Vollständige API-Beispiele mit Konfiguration
- Dokumentiert in
-
Performance Tuning Guide ✅ COMPLETE (07.11.2025)
- Neu erstellt:
docs/search/performance_tuning.md - BM25 Parameter Tuning (k1, b) mit Use-Case-Matrix
- efSearch für Vector-Queries (20-200 mit Recall/Latency trade-offs)
- k_rrf für Hybrid Search Fusion (20-100 Empfehlungen)
- weight_text/weight_vector für Weighted Fusion
- Index Rebuild Strategy & Maintenance
- Performance Benchmarks und Monitoring
- Production Checklist
- Neu erstellt:
-
Migration Guide: v1 → v2 ✅ COMPLETE (07.11.2025)
- Neu erstellt:
docs/search/migration_guide.md - Zero-Downtime Migration Strategy (Dual Index)
- Maintenance Window Strategy (In-Place)
- Incremental Migration für große Datasets (>10M docs)
- Rollback Procedures mit Timelines
- Backward Compatibility Matrix
- Testing Checklist (Pre/During/Post-Migration)
- Migration Examples: Stemming, Umlaut-Norm, Vector-Dim-Change
- Performance Impact & Monitoring
- FAQ & Troubleshooting
- Neu erstellt:
- Snowball Stemmer: https://snowballstem.org/
- Okapi BM25: Robertson & Zaragoza (2009)
- RRF: Cormack, Clarke, Büttcher. SIGIR 2009
- LambdaMART: Burges (2010)
-
BM25 Fulltext Search - Production-ready
- HTTP API: POST /search/fulltext mit Score-Ranking
- Index API: POST /index/create mit config options
- Query semantics: AND-logic, optional limit
-
Stemming & Normalization - Production-ready
- Languages: EN (Porter subset), DE (suffix stemming)
- Stopwords: Built-in lists + custom stopwords
- Umlaut normalization: ä→a, ö→o, ü→u, ß→ss (optional)
-
Phrase Search - Production-ready (v1)
- Quoted phrases: "exact match" queries
- Case-insensitive substring matching
- Works with normalize_umlauts
-
AQL Integration - Production-ready (v1.3)
- FILTER FULLTEXT(field, query [, limit])
- SORT BM25(doc) DESC/ASC
- RETURN {doc, score: BM25(doc)}
- Hybrid: FULLTEXT + AND predicates
- OR combinations: FULLTEXT(...) OR ...
-
Hybrid Search (Text + Vector) - Production-ready
- RRF fusion (Reciprocal Rank Fusion)
- Weighted fusion (configurable text/vector balance)
- HTTP API: POST /search/hybrid
Near-term (Q1 2026):
- Highlighting: Mark matched terms in response
-
Performance tuning guide with benchmarks✅ IMPLEMENTED → siehedocs/search/performance_tuning.md -
Migration guide for index rebuilds✅ IMPLEMENTED → siehedocs/search/migration_guide.md
Long-term (Q2+ 2026):
- Position-based phrase search (faster than substring)
- Advanced analyzers: n-grams, phonetic matching
- Query expansion with synonyms
- LambdaMART learning-to-rank
-
Umlaut-/ß-Normalisierung✅ IMPLEMENTED -
Phrase Queries✅ IMPLEMENTED (v1 substring-based) -
AQL-Integration: FULLTEXT-Operator + BM25✅ IMPLEMENTED (v1.3) - Highlighting für matched terms (v2 planned)
-
Performance Tuning Guide mit Benchmarks✅ IMPLEMENTED →docs/search/performance_tuning.md
- Architecture-ACCESS-MODEL-IMPLEMENTATION-SUMMARY
- Architecture-ADR-003-pg-dump-sql-parser
- Architecture-BASEENTITY-PRINCIPLE
- Architecture-CACHE-STORAGE-INTEGRATION
- Architecture-CMAKE-ARCHITECTURE
- Architecture-CMAKE-FLAGS-REFERENCE
- Architecture-CMAKE-MODULAR-ARCHITECTURE
- Architecture-CONCERNS-ARCHITECTURE-DIAGRAM
- Architecture-CONCERNS-IMPLEMENTATION-SUMMARY
- Architecture-CONTENT-MODEL
- Architecture-COPILOT-THEMISDB-GRAPH-RAG-BACKEND-ARCHITECTURE
- Architecture-CRYPTO-AND-KEYS
- Architecture-FEATURE-FLAGS-REFERENCE
- Architecture-GPU-ARCHITECTURE-REVIEW-TEMPLATE
- Architecture-HTTP-SHUTDOWN-HARDENING
- Architecture-MIGRATION-GUIDE-CONCERNS
- Architecture-MIGRATION-GUIDE-v13-v14
- Architecture-MODULARIZATION-GUIDE
- Architecture-MODULAR-ARCHITECTURE-ROADMAP
- Architecture-MODULE-ARCHITECTURE-INDEX
- Architecture-P1D01-ISSMPLUGIN-DESIGN-REVIEW
- Architecture-P1-D01-ISSMPLUGIN-DESIGN-REVIEW
- Architecture-P1-D08-MAMBA-GOVERNANCE-CONTRACT
- Architecture-P1-P2-IMPLEMENTATION-COMPLETION-INDEX
- Architecture-PHASE0-COMPLETION-ASSESSMENT
- Architecture-PHASE3-QUERYENGINE-DI-ARCHITECTURE
- Architecture-PHASE4-INDEX-MANAGER-DI
- Architecture-POSTGRESQL-WIRE-PROTOCOL
- Architecture-QUERYENGINE-IMPLEMENTATION-GUIDE
- Architecture-QUERY-SCHEDULING
- Architecture-RAFT-CONSENSUS-DESIGN
- Architecture-README
- Architecture-README-SSM-HYBRID-IMPLEMENTATION
- Architecture-REFACTORING-SUMMARY
- Architecture-RESOURCE-POOLING
- Architecture-SOURCE-DIRECTORY-GUIDE
- Architecture-THEMIS-CORE-GUIDE
- Architecture-UNIFIED-ACCESS-MODEL
- Architecture-WAL-GRPC-MTLS-CONFIGURATION
- Architecture-WIRE-PROTOCOL-RETRY
- Architecture-boltzmann-observability-draft
- Architecture-experimental-logarithmic-vector-storage
- Architecture-llm-wiki-mvp-adr
- Architecture-rewrite-engine-architecture
- Architecture-rope-api-architecture
- Architecture-ssm-gguf-mamba-status
- Architecture-ssm-hybrid-analysis
- Architecture-ssm-hybrid-rollout-plan
- Architecture-ssm-plugin-interface-design-review
- Architecture-transaction-coordinators
- Architecture-wiki-secondary-index
- Architecture-wire-protocol
- Governance-DISABLED-STUB-POLICY
- Governance-DOCS-PR-POLICY
- Governance-GA-PROMOTION-SIGN-OFF
- Governance-GITHUB-MILESTONES-SETUP
- Governance-MATURITY-CLAIM-VERIFICATION-CHECKLIST
- Governance-MATURITY-EVIDENCE-REGISTRY
- Governance-MERGE-GATE-BOT-CONFIG
- Governance-MERGE-GATE-STATUS-LIVE
- Governance-PHASE3-ENFORCEMENT-RUNBOOK
- Governance-PHASE-1-CLOSURE-REPORT
- Governance-PHASE-CLOSURE-POLICY
- Governance-PHASE-DEPENDENCY-GRAPH
- Governance-PLUGIN-SUBMODULE-ROLLBACK
- Governance-PRODUCTION-READY-2026-DELIVERY-PLAN
- Governance-PR-VERSION-TARGETING
- Governance-PR-VERSION-TARGETING-BACKFILL
- Governance-QUERY-MODULE-STATUS
- Governance-README
- Governance-RELEASE-PROMOTION-GATE-POLICY
- Governance-RELEASE-VALIDATION-CHECKLIST
- Governance-SECURITY-MODULE-5671-EVIDENCE-SUMMARY
- Governance-SHARDING-P6-RESIDUAL-RISK-ACCEPTANCE
- Governance-SOURCECODE-COMPLIANCE-GOVERNANCE
- Governance-UPDATES-DEVELOPMENT-STATUS-SIGN-OFF
- Governance-WAVE-C-IMPLEMENTATION-COMPLETE
- Module-acceleration-Roadmap
- Module-access-model-Roadmap
- Module-ai-Roadmap
- Module-analytics-Roadmap
- Module-api-Roadmap
- Module-aql-Roadmap
- Module-auth-Roadmap
- Module-base-Roadmap
- Module-cache-Roadmap
- Module-cdc-Roadmap
- Module-chaos-Roadmap
- Module-chimera-Roadmap
- Module-config-Roadmap
- Module-content-Roadmap
- Module-core-Roadmap
- Module-distributed-knowledge-Roadmap
- Module-distributed-tensor-Roadmap
- Module-document-Roadmap
- Module-ethics-ai-Roadmap
- Module-evaluation-Roadmap
- Module-execution-Roadmap
- Module-exporters-Roadmap
- Module-failover-Roadmap
- Module-geo-Roadmap
- Module-governance-Roadmap
- Module-gpu-Roadmap
- Module-graph-Roadmap
- Module-image-analysis-Roadmap
- Module-importers-Roadmap
- Module-index-Roadmap
- Module-ingestion-Roadmap
- Module-llama-cpp-Roadmap
- Module-llm-Roadmap
- Module-llm-streaming-Roadmap
- Module-llm-wiki-Roadmap
- Module-maintenance-Roadmap
- Module-metadata-Roadmap
- Module-network-Roadmap
- Module-observability-Roadmap
- Module-onnx-clip-Roadmap
- Module-performance-Roadmap
- Module-plugins-Roadmap
- Module-process-Roadmap
- Module-projects-Roadmap
- Module-prompt-engineering-Roadmap
- Module-query-Roadmap
- Module-rag-Roadmap
- Module-replication-Roadmap
- Module-retrieval-Roadmap
- Module-rpc-grpc-Roadmap
- Module-scheduler-Roadmap
- Module-scraper-Roadmap
- Module-search-Roadmap
- Module-security-Roadmap
- Module-server-Roadmap
- Module-sharding-Roadmap
- Module-stable-diffusion-Roadmap
- Module-storage-Roadmap
- Module-temporal-Roadmap
- Module-tensor-Roadmap
- Module-themis-Roadmap
- Module-timeseries-Roadmap
- Module-toolbox-Roadmap
- Module-training-Roadmap
- Module-transaction-Roadmap
- Module-updates-Roadmap
- Module-user-storage-encrypted-Roadmap
- Module-utils-Roadmap
- Module-vector-search-Roadmap
- Module-voice-Roadmap
- Module-whisper-Roadmap