Class QmdSearchEngineAdapter

Concrete Search Engine Adapter implementing QMD (Query Markup Documents) hybrid search.

Hierarchy (View Summary)

AbstractSearchEngineAdapter
- QmdSearchEngineAdapter

Index

Constructors

Properties

Accessors

collectionName storageDir

Methods

clearIndex indexDocument initialize removeDocument search

Constructors

constructor

new QmdSearchEngineAdapter(
params: SearchEngineParameters,
): QmdSearchEngineAdapter
Parameters
- params: SearchEngineParameters
Returns QmdSearchEngineAdapter
Overrides AbstractSearchEngineAdapter.constructor
- Defined in searchengine-qmd/src/QmdSearchEngineAdapter.ts:37

Properties

`Protected`_params

_params: SearchEngineParameters

Accessors

collectionName

get collectionName(): string
Gets configured collection name.

Returns string
- Defined in searchengine-qmd/src/QmdSearchEngineAdapter.ts:56

storageDir

get storageDir(): string
Gets storage directory location.

Returns string
- Defined in searchengine-qmd/src/QmdSearchEngineAdapter.ts:49

Methods

clearIndex

clearIndex(): Promise<void>
Clears all storage files and in-memory indexes.

Returns Promise<void>
Overrides AbstractSearchEngineAdapter.clearIndex
- Defined in searchengine-qmd/src/QmdSearchEngineAdapter.ts:236

indexDocument

indexDocument(doc: SearchDocument): Promise<void>
Indexes a document into the storage directory and memory repository.
Parameters
- doc: SearchDocument
  Document to be indexed.
Returns Promise<void>
Overrides AbstractSearchEngineAdapter.indexDocument
- Defined in searchengine-qmd/src/QmdSearchEngineAdapter.ts:83

initialize

initialize(): Promise<void>
Initializes storage directory and detects CLI availability.

Returns Promise<void>
Overrides AbstractSearchEngineAdapter.initialize
- Defined in searchengine-qmd/src/QmdSearchEngineAdapter.ts:63

removeDocument

removeDocument(id: string): Promise<void>
Removes a document from the index.
Parameters
- id: string
  Document identifier.
Returns Promise<void>
Overrides AbstractSearchEngineAdapter.removeDocument
- Defined in searchengine-qmd/src/QmdSearchEngineAdapter.ts:127

search

search(query: string, options?: SearchQueryOptions): Promise<SearchResultItem[]>
Executes a query against QMD or fallback search pipeline.
Parameters
- query: string
  Free text search query string.
- Optionaloptions: SearchQueryOptions
  Search parameters (limit, category, mode, rerank).
Returns Promise<SearchResultItem[]>
Ranked search result items.
Overrides AbstractSearchEngineAdapter.search
- Defined in searchengine-qmd/src/QmdSearchEngineAdapter.ts:147