SQLite FTS5-based keyword index implementation.
Uses SQLite's Full-Text Search 5 extension with BM25 scoring. FTS5 provides efficient text indexing and ranking capabilities.
Features:
- BM25 relevance scoring
- Snippet highlighting
- Boolean query operators (AND, OR, NOT)
- Phrase matching with quotes
- Prefix matching with *
Query syntax examples:
- "hello world" - documents containing both terms
- "hello OR world" - documents containing either term
- "hello NOT world" - documents with hello but not world
- ""hello world"" - exact phrase match
- "hello*" - prefix match
Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Clear all indexed documents.
Clear all indexed documents.
Attributes
- Returns
-
Unit on success, or error
- Definition Classes
Close the index and release resources.
Count total indexed documents.
Delete a document by ID.
Delete a document by ID.
Value parameters
- id
-
Document ID
Attributes
- Returns
-
Unit on success, or error
- Definition Classes
Delete multiple documents.
Delete multiple documents.
Value parameters
- ids
-
Document IDs to delete
Attributes
- Returns
-
Unit on success, or error
- Definition Classes
Delete all documents with IDs starting with the given prefix.
Delete all documents with IDs starting with the given prefix.
Value parameters
- prefix
-
The ID prefix to match
Attributes
- Returns
-
Number of documents deleted
- Definition Classes
Get a document by ID.
Get a document by ID.
Value parameters
- id
-
Document ID
Attributes
- Returns
-
Document if found, None if not found, or error
- Definition Classes
Index a single document.
Index a single document.
Value parameters
- doc
-
Document to index
Attributes
- Returns
-
Unit on success, or error
- Definition Classes
Index multiple documents in batch.
Index multiple documents in batch.
Value parameters
- docs
-
Documents to index
Attributes
- Returns
-
Unit on success, or error
- Definition Classes
Search for documents matching a query.
Search for documents matching a query.
Uses BM25 scoring for relevance ranking.
Value parameters
- filter
-
Optional metadata filter
- query
-
Search query (supports operators depending on implementation)
- topK
-
Maximum number of results to return
Attributes
- Returns
-
Ranked search results, or error
- Definition Classes
Search with highlighted snippets.
Search with highlighted snippets.
Value parameters
- filter
-
Optional metadata filter
- query
-
Search query
- snippetLength
-
Target length for highlight snippets
- topK
-
Maximum number of results
Attributes
- Returns
-
Results with highlighted matches
- Definition Classes
Get index statistics.
Inherited methods
Update a document (re-index with new content).
Update a document (re-index with new content).
Value parameters
- doc
-
Updated document
Attributes
- Returns
-
Unit on success, or error
- Inherited from:
- KeywordIndex