feat(ts): document enableReRanking (#1306)

see algolia/algoliasearch-client-specs-internal#164
algolia · Sep 28, 2021 · 00ad924 · 00ad924
1 parent a5df2fb
commit 00ad924
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/packages/client-search/src/types/SearchOptions.ts b/packages/client-search/src/types/SearchOptions.ts
@@ -349,4 +349,14 @@ export type SearchOptions = {
    * less relevant results.
    */
   readonly relevancyStrictness?: number;
+
+  /**
+   * Whether this search should use Dynamic Re-Ranking.
+   * @link https://www.algolia.com/doc/guides/algolia-ai/re-ranking/
+   *
+   * Note: You need to turn on Dynamic Re-Ranking on your index for it to have an effect on
+   * your search results. You can do this through the Re-Ranking page on the dashboard.
+   * This parameter is only used to turn off Dynamic Re-Ranking (with false) at search time.
+   */
+  readonly enableReRanking?: boolean;
 };