From f246a2417865caf413c79c58932d01afadbd4ecf Mon Sep 17 00:00:00 2001 From: Eunjae Lee Date: Wed, 10 Feb 2021 11:25:24 +0100 Subject: [PATCH] fix(ts): add types for smart sort (algolia/algoliasearch-helper-js#809) * fix(ts): add types for smart sort * chore: update comments --- packages/algoliasearch-helper/index.d.ts | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/packages/algoliasearch-helper/index.d.ts b/packages/algoliasearch-helper/index.d.ts index 35476c5eff..48759dbe4d 100644 --- a/packages/algoliasearch-helper/index.d.ts +++ b/packages/algoliasearch-helper/index.d.ts @@ -511,6 +511,13 @@ declare namespace algoliasearchHelper { ruleContexts?: string[]; optionalFilters?: Array; queryLanguages?: string[]; + + /** + * The relevancy threshold to apply to search in a virtual index [0-100]. A Bigger + * value means fewer, but more relevant results, smaller value means more, but + * less relevant results. + */ + relevancyStrictness?: number; } export class SearchParameters implements PlainSearchParameters { @@ -1156,6 +1163,14 @@ declare namespace algoliasearchHelper { * total number of hits of this query on the index */ nbHits: number; + /** + * subset of hits selected when relevancyStrictness is applied + */ + nbSortedHits?: number; + /** + * the relevancy threshold applied to search in a virtual index + */ + appliedRelevancyStrictness?: number; /** * total number of pages with respect to the number of hits per page and the total number of hits */