Skip to content

Meilisearch JS / index / SearchSimilarDocumentsParams

Type Alias: SearchSimilarDocumentsParams ​

SearchSimilarDocumentsParams = object

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

Properties ​

attributesToRetrieve? ​

optional attributesToRetrieve?: string[]

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


embedder? ​

optional embedder?: string

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


filter? ​

optional filter?: Filter

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


id ​

id: string | number

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


limit? ​

optional limit?: number

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


offset? ​

optional offset?: number

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


rankingScoreThreshold? ​

optional rankingScoreThreshold?: number

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


showPerformanceDetails? ​

optional showPerformanceDetails?: boolean

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


showRankingScore? ​

optional showRankingScore?: boolean

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


showRankingScoreDetails? ​

optional showRankingScoreDetails?: boolean

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