Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shortcuts merged 2 commits into from
Jan 7, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af5c124
feat(types): add reranking engine settings to types
alphonseb Jan 6, 2022
7b4d607
chore: fix description
alphonseb Jan 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/client-search/src/types/SearchOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>;
};
17 changes: 17 additions & 0 deletions packages/client-search/src/types/Settings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>;
};