From 20044938aa8ada6d0882a6963a426642799cea4c Mon Sep 17 00:00:00 2001
From: Haroen Viaene <hello@haroen.me>
Date: Mon, 27 Sep 2021 17:48:21 +0200
Subject: [PATCH] feat(ts): document enableReRanking

see https://github.com/algolia/algoliasearch-client-specs-internal/issues/164
---
 packages/client-search/src/types/SearchOptions.ts | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/packages/client-search/src/types/SearchOptions.ts b/packages/client-search/src/types/SearchOptions.ts
index f1b83fbd9..3a5692d13 100644
--- 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;
 };