Skip to content

Meilisearch JS / index / SearchSimilarDocumentsParams

Type Alias: SearchSimilarDocumentsParams ​

SearchSimilarDocumentsParams = object

Defined in: src/types/types.ts:480

Properties ​

attributesToRetrieve? ​

optional attributesToRetrieve?: string[]

Defined in: src/types/types.ts:486


embedder? ​

optional embedder?: string

Defined in: src/types/types.ts:485


filter? ​

optional filter?: Filter

Defined in: src/types/types.ts:484


id ​

id: string | number

Defined in: src/types/types.ts:481


limit? ​

optional limit?: number

Defined in: src/types/types.ts:483


offset? ​

optional offset?: number

Defined in: src/types/types.ts:482


rankingScoreThreshold? ​

optional rankingScoreThreshold?: number

Defined in: src/types/types.ts:489


showPerformanceDetails? ​

optional showPerformanceDetails?: boolean

Defined in: src/types/types.ts:490


showRankingScore? ​

optional showRankingScore?: boolean

Defined in: src/types/types.ts:487


showRankingScoreDetails? ​

optional showRankingScoreDetails?: boolean

Defined in: src/types/types.ts:488