feat(types): add reranking engine settings to types (#1378)

algolia · Jan 7, 2022 · e9c0f30 · e9c0f30
1 parent 8c8db3d
commit e9c0f30
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/packages/client-search/src/types/SearchOptions.ts b/packages/client-search/src/types/SearchOptions.ts
@@ -359,4 +359,12 @@ export type SearchOptions = {
    * This parameter is only used to turn off Dynamic Re-Ranking (with false) at search time.
    */
   readonly enableReRanking?: boolean;
+
+  /**
+   * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+   */
+  readonly reRankingApplyFilter?:
+    | string
+    | readonly string[]
+    | ReadonlyArray<readonly string[] | string>;
 };
diff --git a/packages/client-search/src/types/Settings.ts b/packages/client-search/src/types/Settings.ts
@@ -343,4 +343,21 @@ export type Settings = {
       };
     };
   };
+
+  /**
+   * Whether this index 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.
+   */
+  readonly enableReRanking?: boolean;
+
+  /**
+   * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+   */
+  readonly reRankingApplyFilter?:
+    | string
+    | readonly string[]
+    | ReadonlyArray<readonly string[] | string>;
 };