Skip to main content

Interface: MLTOptions

Defined in: src/types/interfaces/search.interface.ts:437

Options for More Like This queries.

Properties

limit?

readonly optional limit: number

Defined in: src/types/interfaces/search.interface.ts:443

Maximum number of similar documents to return.

Default Value

10

maxQueryTerms?

readonly optional maxQueryTerms: number

Defined in: src/types/interfaces/search.interface.ts:464

Maximum number of query terms to extract from the source document.

Default Value

25

minDocFreq?

readonly optional minDocFreq: number

Defined in: src/types/interfaces/search.interface.ts:457

Minimum document frequency across the index.

Default Value

2

minimumShouldMatch?

readonly optional minimumShouldMatch: string

Defined in: src/types/interfaces/search.interface.ts:471

Minimum percentage of terms that must match.

Default Value

'30%'

minTermFreq?

readonly optional minTermFreq: number

Defined in: src/types/interfaces/search.interface.ts:450

Minimum term frequency in the source document.

Default Value

1

saturationPivot?

readonly optional saturationPivot: number

Defined in: src/types/interfaces/search.interface.ts:479

Pivot value for saturation score normalization. The raw BM25 score at which the normalized similarity equals 0.5.

Default Value

8