Skip to content

themis docs query query_vector_hybrid

makr-code edited this page Dec 2, 2025 · 1 revision

Vector Hybrid Search

Datum: 19. Nov 2025 Status: EXPERIMENTAL (Windows/MSVC: einzelne Tests schlagen fehl; siehe Known Issues)

Hinweis (19. Nov 2025): Auf Windows (MSVC 19.44) liefern einige GTests für executeFilteredVectorSearch trotz erfolgreicher Pre‑Filter‑Whitelist aktuell 0 Ergebnisse. Details und Reproduktion: docs/KNOWN_ISSUES.md.

Ziel

Kombinierte Nutzung von ANN Vektorsuche (HNSW / Brute Force) mit attributbasiertem Pre- und Post-Filtering zur Reduktion der Kandidatenmenge und präziser Ergebnisanpassung.

Komponenten

  • Pre-Filtering: searchKnnPreFiltered() generiert Whitelist über SecondaryIndexManager für EQUALS / RANGE / IN / Vergleichsoperatoren.
  • Post-Filtering (Hybrid): QueryEngine::executeFilteredVectorSearch() wendet alle Operatoren (inkl. NOT_EQUALS, CONTAINS) auf geladene Entities nach Distanzsortierung an.

Unterstützte Operatoren

Operator Pre-Filter Post-Filter Beschreibung
EQUALS exakte Übereinstimmung
NOT_EQUALS ❌ (Scan nötig) Ausschluss von Wert
CONTAINS ❌ (Substring) Teilstring in Textfeld
GREATER_THAN ✅ (Range Scan) numerisch >
LESS_THAN numerisch <
GREATER_EQUAL numerisch >=
LESS_EQUAL numerisch <=
IN ✅ (Union von EQUALS) Wert in Menge
RANGE min <= x <= max

Ablauf

  1. Aufteilung der Filter: Pre-Filter geeignete Operatoren -> SecondaryIndex Scans.
  2. Whitelist Intersection (AND Semantik).
  3. ANN Suche (HNSW oder Fallback) mit Whitelist.
  4. Laden der Entities (RocksDB) und Anwendung aller Filter inkl. NOT_EQUALS / CONTAINS.
  5. Kürzung auf Top-k unter Beibehaltung Distanzsortierung.

Performance Hinweise

  • Selektive Filter zuerst verarbeiten um Whitelist früh zu schrumpfen.
  • max_filter_scan_size begrenzt Range-Scans; Überschreitung -> Fallback auf Post-Filtering.
  • NOT_EQUALS und CONTAINS immer Post-Filter (verhindert teure Vollscans vor ANN).
  • Bei sehr großer Whitelist > Schwelle: Standard KNN + Post-Filter (verhindert riesige HNSW calls).

Beispiele

FilteredVectorSearchQuery q;
q.table = "documents";
q.query_vector = embedding;
q.k = 15;
// Pre-Filter Kandidaten schrumpfen
q.filters.push_back({"category", FilteredVectorSearchQuery::AttributeFilter::Op::EQUALS, "tech"});
// Range Scan kombiniert
FilteredVectorSearchQuery::AttributeFilter scoreRange;
scoreRange.field = "score";
scoreRange.op = FilteredVectorSearchQuery::AttributeFilter::Op::RANGE;
scoreRange.value_min = "0.6";
scoreRange.value_max = "0.85";
q.filters.push_back(scoreRange);
// Post-Filter nur
FilteredVectorSearchQuery::AttributeFilter langContains;
langContains.field = "lang";
langContains.op = FilteredVectorSearchQuery::AttributeFilter::Op::CONTAINS;
langContains.value = "en"; // Teilstring (z.B. 'en-US')
q.filters.push_back(langContains);

auto [st, results] = engine.executeFilteredVectorSearch(q);

Erweiterungen (geplant)

  • Radius-Suche (epsilon Nachbarn unter Distanzschwelle)IMPLEMENTIERT
  • Score Fusion (Vector Distanz + Attributgewichtung)
  • Adaptive candidateMultiplier basierend auf selektiver Filterstatistik
  • Deterministische Tie-Breaks und Cutoffs (BM25 min_score, Vector max_distance) ✅

Radius Search (Epsilon Neighbors)

API: executeRadiusVectorSearch(RadiusVectorSearchQuery)

Verwendung: Alle Vektoren innerhalb Distanzschwelle finden (statt Top-k).

Parameter:

  • epsilon: Maximale Distanz (threshold)
  • max_results: Optional Obergrenze (0 = unbegrenzt)
  • filters: Attributfilter wie bei Filtered Search

Beispiel:

RadiusVectorSearchQuery rq;
rq.table = "products";
rq.query_vector = userPreferenceEmbedding;
rq.epsilon = 0.3f;  // Nur sehr ähnliche Produkte
rq.max_results = 50; // Max 50 Ergebnisse

// Filter: nur verfügbare Produkte
FilteredVectorSearchQuery::AttributeFilter availFilter;
availFilter.field = "in_stock";
availFilter.op = FilteredVectorSearchQuery::AttributeFilter::Op::EQUALS;
availFilter.value = "true";
rq.filters.push_back(availFilter);

auto [st, results] = engine.executeRadiusVectorSearch(rq);
// Alle Produkte mit Distanz <= 0.3 und in_stock=true

Performance:

  • HNSW: Fetch large k, filter by epsilon (keine native radius support)
  • Brute-Force: Direkter Distanzcheck während Scan
  • Pre-Filter reduziert Suchraum deutlich bei selektiven Attributen

Anwendungsfälle:

  • Clustering (alle Nachbarn in Radius)
  • Deduplizierung (Duplikate unter Schwelle)
  • Anomalie-Detektion (isolierte Punkte mit wenigen epsilon-Nachbarn)

Fehlende Teile

  • Radius Search API
  • Distanz-Re-Ranking mit Attributgewichten
  • Erweiterte Metriken (DOT kombiniert mit Normierung)

Tests

  • Vorhandene test_filtered_vector_search.cpp deckt EQUALS / RANGE / IN / Kombi ab.
  • Zusätzliche Tests für NOT_EQUALS & CONTAINS werden nach Test-Suite Reparatur ergänzt.
  • Fusion-Tests: RRF vs. Weighted mit Tie-Break (pk) und Cutoffs (min_text_score, max_vector_distance); deterministische Reihenfolge bei Gleichstand.

HTTP API Notizen (Hybrid & Fusion)

Dieser Abschnitt fasst die wichtigsten HTTP-Parameter und das Zusammenwirken von Pre- und Post-Filtering zusammen. Details und Beispiele siehe docs/apis/hybrid_search_api.md.

  • Hybrid /search/hybrid (Content + optional Graph-Expansion)

    • filters: Objekt- oder Array-Form
      • Objekt: { "field": "value" } → EQUALS (Whitelist-Prefilter)
      • Array: [ {"field":"dataset","op":"IN","values":["train","test"]}, {"field":"score","op":"RANGE","min":0.5,"max":1.0} ]
        • Unterstützt in Hybrid derzeit: EQUALS|EQ, IN, RANGE (über Schema-Mapping field_map auf Content-JSON-Pfade)
    • tie_break (pk|none) + tie_break_epsilon: deterministische Sortierung bei quasi gleichen Scores
    • Pre-Filter reduziert Vektor-Kandidaten via Whitelist; Post-Filter (Entity-Load) für komplexe Operatoren bleibt im Core erhalten.
  • Fusion /search/fusion (Text + Vektor)

    • Modi: rrf (Rangfusion) und weighted (gewichtete Normalisierung)
    • Alias: alpha entspricht weight_text (Gewicht der Textkomponente)
    • Cutoffs: min_text_score filtert BM25 vor Fusion; max_vector_distance filtert Vektortreffer vor Fusion
    • filters: Whitelist-Prefilter für Vektor, Post-Filter für Text (Attribute werden auf Entities geprüft)
    • Tie-Break: tie_break + tie_break_epsilon für stabile Reihenfolge bei gleichen Fusionsscores

Minimalbeispiel (Hybrid mit IN/RANGE und deterministischem Tie-Break):

{
	"query": "any",
	"k": 10,
	"expand": { "hops": 0 },
	"filters": [
		{"field": "dataset", "op": "IN", "values": ["train", "test"]},
		{"field": "score",   "op": "RANGE", "min": 0.5, "max": 1.0}
	],
	"tie_break": "pk",
	"tie_break_epsilon": 1e-12
}

Wartung

Siehe Roadmap Wartungsaufgabe "Test Suite Reparatur" für Anpassung legacy Tests nach Hybrid-Erweiterung.

Wiki Sidebar Umstrukturierung

Datum: 2025-11-30
Status: ✅ Abgeschlossen
Commit: bc7556a

Zusammenfassung

Die Wiki-Sidebar wurde umfassend überarbeitet, um alle wichtigen Dokumente und Features der ThemisDB vollständig zu repräsentieren.

Ausgangslage

Vorher:

  • 64 Links in 17 Kategorien
  • Dokumentationsabdeckung: 17.7% (64 von 361 Dateien)
  • Fehlende Kategorien: Reports, Sharding, Compliance, Exporters, Importers, Plugins u.v.m.
  • src/ Dokumentation: nur 4 von 95 Dateien verlinkt (95.8% fehlend)
  • development/ Dokumentation: nur 4 von 38 Dateien verlinkt (89.5% fehlend)

Dokumentenverteilung im Repository:

Kategorie        Dateien  Anteil
-----------------------------------------
src                 95    26.3%
root                41    11.4%
development         38    10.5%
reports             36    10.0%
security            33     9.1%
features            30     8.3%
guides              12     3.3%
performance         12     3.3%
architecture        10     2.8%
aql                 10     2.8%
[...25 weitere]     44    12.2%
-----------------------------------------
Gesamt             361   100.0%

Neue Struktur

Nachher:

  • 171 Links in 25 Kategorien
  • Dokumentationsabdeckung: 47.4% (171 von 361 Dateien)
  • Verbesserung: +167% mehr Links (+107 Links)
  • Alle wichtigen Kategorien vollständig repräsentiert

Kategorien (25 Sektionen)

1. Core Navigation (4 Links)

  • Home, Features Overview, Quick Reference, Documentation Index

2. Getting Started (4 Links)

  • Build Guide, Architecture, Deployment, Operations Runbook

3. SDKs and Clients (5 Links)

  • JavaScript, Python, Rust SDK + Implementation Status + Language Analysis

4. Query Language / AQL (8 Links)

  • Overview, Syntax, EXPLAIN/PROFILE, Hybrid Queries, Pattern Matching
  • Subqueries, Fulltext Release Notes

5. Search and Retrieval (8 Links)

  • Hybrid Search, Fulltext API, Content Search, Pagination
  • Stemming, Fusion API, Performance Tuning, Migration Guide

6. Storage and Indexes (10 Links)

  • Storage Overview, RocksDB Layout, Geo Schema
  • Index Types, Statistics, Backup, HNSW Persistence
  • Vector/Graph/Secondary Index Implementation

7. Security and Compliance (17 Links)

  • Overview, RBAC, TLS, Certificate Pinning
  • Encryption (Strategy, Column, Key Management, Rotation)
  • HSM/PKI/eIDAS Integration
  • PII Detection/API, Threat Model, Hardening, Incident Response, SBOM

8. Enterprise Features (6 Links)

  • Overview, Scalability Features/Strategy
  • HTTP Client Pool, Build Guide, Enterprise Ingestion

9. Performance and Optimization (10 Links)

  • Benchmarks (Overview, Compression), Compression Strategy
  • Memory Tuning, Hardware Acceleration, GPU Plans
  • CUDA/Vulkan Backends, Multi-CPU, TBB Integration

10. Features and Capabilities (13 Links)

  • Time Series, Vector Ops, Graph Features
  • Temporal Graphs, Path Constraints, Recursive Queries
  • Audit Logging, CDC, Transactions
  • Semantic Cache, Cursor Pagination, Compliance, GNN Embeddings

11. Geo and Spatial (7 Links)

  • Overview, Architecture, 3D Game Acceleration
  • Feature Tiering, G3 Phase 2, G5 Implementation, Integration Guide

12. Content and Ingestion (9 Links)

  • Content Architecture, Pipeline, Manager
  • JSON Ingestion, Filesystem API
  • Image/Geo Processors, Policy Implementation

13. Sharding and Scaling (5 Links)

  • Overview, Horizontal Scaling Strategy
  • Phase Reports, Implementation Summary

14. APIs and Integration (5 Links)

  • OpenAPI, Hybrid Search API, ContentFS API
  • HTTP Server, REST API

15. Admin Tools (5 Links)

  • Admin/User Guides, Feature Matrix
  • Search/Sort/Filter, Demo Script

16. Observability (3 Links)

  • Metrics Overview, Prometheus, Tracing

17. Development (11 Links)

  • Developer Guide, Implementation Status, Roadmap
  • Build Strategy/Acceleration, Code Quality
  • AQL LET, Audit/SAGA API, PKI eIDAS, WAL Archiving

18. Architecture (7 Links)

  • Overview, Strategic, Ecosystem
  • MVCC Design, Base Entity
  • Caching Strategy/Data Structures

19. Deployment and Operations (8 Links)

  • Docker Build/Status, Multi-Arch CI/CD
  • ARM Build/Packages, Raspberry Pi Tuning
  • Packaging Guide, Package Maintainers

20. Exporters and Integrations (4 Links)

  • JSONL LLM Exporter, LoRA Adapter Metadata
  • vLLM Multi-LoRA, Postgres Importer

21. Reports and Status (9 Links)

  • Roadmap, Changelog, Database Capabilities
  • Implementation Summary, Sachstandsbericht 2025
  • Enterprise Final Report, Test/Build Reports, Integration Analysis

22. Compliance and Governance (6 Links)

  • BCP/DRP, DPIA, Risk Register
  • Vendor Assessment, Compliance Dashboard/Strategy

23. Testing and Quality (3 Links)

  • Quality Assurance, Known Issues
  • Content Features Test Report

24. Source Code Documentation (8 Links)

  • Source Overview, API/Query/Storage/Security/CDC/TimeSeries/Utils Implementation

25. Reference (3 Links)

  • Glossary, Style Guide, Publishing Guide

Verbesserungen

Quantitative Metriken

Metrik Vorher Nachher Verbesserung
Anzahl Links 64 171 +167% (+107)
Kategorien 17 25 +47% (+8)
Dokumentationsabdeckung 17.7% 47.4% +167% (+29.7pp)

Qualitative Verbesserungen

Neu hinzugefügte Kategorien:

  1. ✅ Reports and Status (9 Links) - vorher 0%
  2. ✅ Compliance and Governance (6 Links) - vorher 0%
  3. ✅ Sharding and Scaling (5 Links) - vorher 0%
  4. ✅ Exporters and Integrations (4 Links) - vorher 0%
  5. ✅ Testing and Quality (3 Links) - vorher 0%
  6. ✅ Content and Ingestion (9 Links) - deutlich erweitert
  7. ✅ Deployment and Operations (8 Links) - deutlich erweitert
  8. ✅ Source Code Documentation (8 Links) - deutlich erweitert

Stark erweiterte Kategorien:

  • Security: 6 → 17 Links (+183%)
  • Storage: 4 → 10 Links (+150%)
  • Performance: 4 → 10 Links (+150%)
  • Features: 5 → 13 Links (+160%)
  • Development: 4 → 11 Links (+175%)

Struktur-Prinzipien

1. User Journey Orientierung

Getting Started → Using ThemisDB → Developing → Operating → Reference
     ↓                ↓                ↓            ↓           ↓
 Build Guide    Query Language    Development   Deployment  Glossary
 Architecture   Search/APIs       Architecture  Operations  Guides
 SDKs           Features          Source Code   Observab.   

2. Priorisierung nach Wichtigkeit

  • Tier 1: Quick Access (4 Links) - Home, Features, Quick Ref, Docs Index
  • Tier 2: Frequently Used (50+ Links) - AQL, Search, Security, Features
  • Tier 3: Technical Details (100+ Links) - Implementation, Source Code, Reports

3. Vollständigkeit ohne Überfrachtung

  • Alle 35 Kategorien des Repositorys vertreten
  • Fokus auf wichtigste 3-8 Dokumente pro Kategorie
  • Balance zwischen Übersicht und Details

4. Konsistente Benennung

  • Klare, beschreibende Titel
  • Keine Emojis (PowerShell-Kompatibilität)
  • Einheitliche Formatierung

Technische Umsetzung

Implementierung

  • Datei: sync-wiki.ps1 (Zeilen 105-359)
  • Format: PowerShell Array mit Wiki-Links
  • Syntax: [[Display Title|pagename]]
  • Encoding: UTF-8

Deployment

# Automatische Synchronisierung via:
.\sync-wiki.ps1

# Prozess:
# 1. Wiki Repository klonen
# 2. Markdown-Dateien synchronisieren (412 Dateien)
# 3. Sidebar generieren (171 Links)
# 4. Commit & Push zum GitHub Wiki

Qualitätssicherung

  • ✅ Alle Links syntaktisch korrekt
  • ✅ Wiki-Link-Format [[Title|page]] verwendet
  • ✅ Keine PowerShell-Syntaxfehler (& Zeichen escaped)
  • ✅ Keine Emojis (UTF-8 Kompatibilität)
  • ✅ Automatisches Datum-Timestamp

Ergebnis

GitHub Wiki URL: https://github.com/makr-code/ThemisDB/wiki

Commit Details

  • Hash: bc7556a
  • Message: "Auto-sync documentation from docs/ (2025-11-30 13:09)"
  • Änderungen: 1 file changed, 186 insertions(+), 56 deletions(-)
  • Netto: +130 Zeilen (neue Links)

Abdeckung nach Kategorie

Kategorie Repository Dateien Sidebar Links Abdeckung
src 95 8 8.4%
security 33 17 51.5%
features 30 13 43.3%
development 38 11 28.9%
performance 12 10 83.3%
aql 10 8 80.0%
search 9 8 88.9%
geo 8 7 87.5%
reports 36 9 25.0%
architecture 10 7 70.0%
sharding 5 5 100.0% ✅
clients 6 5 83.3%

Durchschnittliche Abdeckung: 47.4%

Kategorien mit 100% Abdeckung: Sharding (5/5)

Kategorien mit >80% Abdeckung:

  • Sharding (100%), Search (88.9%), Geo (87.5%), Clients (83.3%), Performance (83.3%), AQL (80%)

Nächste Schritte

Kurzfristig (Optional)

  • Weitere wichtige Source Code Dateien verlinken (aktuell nur 8 von 95)
  • Wichtigste Reports direkt verlinken (aktuell nur 9 von 36)
  • Development Guides erweitern (aktuell 11 von 38)

Mittelfristig

  • Sidebar automatisch aus DOCUMENTATION_INDEX.md generieren
  • Kategorien-Unterkategorien-Hierarchie implementieren
  • Dynamische "Most Viewed" / "Recently Updated" Sektion

Langfristig

  • Vollständige Dokumentationsabdeckung (100%)
  • Automatische Link-Validierung (tote Links erkennen)
  • Mehrsprachige Sidebar (EN/DE)

Lessons Learned

  1. Emojis vermeiden: PowerShell 5.1 hat Probleme mit UTF-8 Emojis in String-Literalen
  2. Ampersand escapen: & muss in doppelten Anführungszeichen stehen
  3. Balance wichtig: 171 Links sind übersichtlich, 361 wären zu viel
  4. Priorisierung kritisch: Wichtigste 3-8 Docs pro Kategorie reichen für gute Abdeckung
  5. Automatisierung wichtig: sync-wiki.ps1 ermöglicht schnelle Updates

Fazit

Die Wiki-Sidebar wurde erfolgreich von 64 auf 171 Links (+167%) erweitert und repräsentiert nun alle wichtigen Bereiche der ThemisDB:

Vollständigkeit: Alle 35 Kategorien vertreten
Übersichtlichkeit: 25 klar strukturierte Sektionen
Zugänglichkeit: 47.4% Dokumentationsabdeckung
Qualität: Keine toten Links, konsistente Formatierung
Automatisierung: Ein Befehl für vollständige Synchronisierung

Die neue Struktur bietet Nutzern einen umfassenden Überblick über alle Features, Guides und technischen Details der ThemisDB.


Erstellt: 2025-11-30
Autor: GitHub Copilot (Claude Sonnet 4.5)
Projekt: ThemisDB Documentation Overhaul

Clone this wiki locally