Class AbstractSearchEngineAdapter`Abstract`

Blueprint for Search Engine adapters (QMD, Meilisearch, SQLite FTS, etc.). Guarantees a unified contract for indexing and hybrid document retrieval.

Hierarchy (View Summary)

AbstractSearchEngineAdapter
- QmdSearchEngineAdapter

Index

Constructors

Properties

Methods

clearIndex? indexDocument initialize removeDocument search

Constructors

constructor

new AbstractSearchEngineAdapter(
params: SearchEngineParameters,
): AbstractSearchEngineAdapter
Constructs the search engine adapter with fail-fast validation.
Parameters
- params: SearchEngineParameters
  Search engine initialization parameters.
Returns AbstractSearchEngineAdapter
Throws
Error if parameters are missing.
- Defined in searchengine/src/AbstractSearchEngineAdapter.ts:16

Properties

`Protected`_params

_params: SearchEngineParameters

Methods

`Optional` `Abstract`clearIndex

clearIndex?(): Promise<void>
Clears all indexed entries from the repository.

Returns Promise<void>
- Defined in searchengine/src/AbstractSearchEngineAdapter.ts:54

`Abstract`indexDocument

indexDocument(doc: SearchDocument): Promise<void>
Indexes or updates a document entry in the search engine repository.
Parameters
- doc: SearchDocument
  Document to be indexed.
Returns Promise<void>
- Defined in searchengine/src/AbstractSearchEngineAdapter.ts:33

`Abstract`initialize

initialize(): Promise<void>
Initializes underlying storage, index connections, or binary executables.

Returns Promise<void>
- Defined in searchengine/src/AbstractSearchEngineAdapter.ts:26

`Abstract`removeDocument

removeDocument(id: string): Promise<void>
Removes a document from the search index by its identifier.
Parameters
- id: string
  Document identifier.
Returns Promise<void>
- Defined in searchengine/src/AbstractSearchEngineAdapter.ts:40

`Abstract`search

search(query: string, options?: SearchQueryOptions): Promise<SearchResultItem[]>
Executes a query across the search index.
Parameters
- query: string
  Free text search query string.
- Optionaloptions: SearchQueryOptions
  Filtering and execution options.
Returns Promise<SearchResultItem[]>
List of matching document entries sorted by relevance score.
- Defined in searchengine/src/AbstractSearchEngineAdapter.ts:49