Skip to content

Commit 00ad924

Browse files
authored
feat(ts): document enableReRanking (#1306)
see algolia/algoliasearch-client-specs-internal#164
1 parent a5df2fb commit 00ad924

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

packages/client-search/src/types/SearchOptions.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,4 +349,14 @@ export type SearchOptions = {
349349
* less relevant results.
350350
*/
351351
readonly relevancyStrictness?: number;
352+
353+
/**
354+
* Whether this search should use Dynamic Re-Ranking.
355+
* @link https://www.algolia.com/doc/guides/algolia-ai/re-ranking/
356+
*
357+
* Note: You need to turn on Dynamic Re-Ranking on your index for it to have an effect on
358+
* your search results. You can do this through the Re-Ranking page on the dashboard.
359+
* This parameter is only used to turn off Dynamic Re-Ranking (with false) at search time.
360+
*/
361+
readonly enableReRanking?: boolean;
352362
};

0 commit comments

Comments
 (0)