enableReRanking
'enableReRanking' => true|false
Can be used in these methods:
search,
browseObjects,
searchForFacetValues,
generateSecuredApiKey,
addApiKey,
updateApiKey
search,
browse_objects,
search_for_facet_values,
generate_secured_api_key,
add_api_key,
update_api_key
search,
browseObjects,
searchForFacetValues,
generateSecuredApiKey,
addApiKey,
updateApiKey
search,
browse_objects,
search_for_facet_values,
generate_secured_api_key,
add_api_key,
update_api_key
search,
browse,
searchForFacetValues,
generateSecuredApiKey,
addAPIKey,
updateAPIKey
search,
browseObjects,
searchForFacetValues,
generateSecuredApiKey,
addApiKey,
updateApiKey
Search,
Browse,
SearchForFacetValues,
GenerateSecuredApiKeys,
AddApiKey,
UpdateApiKey
Search,
browse,
searchForFacetValues,
generateSecuredApiKey,
addApiKey,
updateApiKey
Search,
BrowseObjects,
SearchForFacetValues,
GenerateSecuredAPIKey,
AddAPIKey,
UpdateAPIKey
search,
browse index,
search into facet values,
generateSecuredApiKey,
add key,
update key
About this parameter
Whether this search will use Dynamic Re-Ranking.
Usage notes
This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
Set enableReRanking
to false
to turn off Dynamic Re-Ranking for a search query.
When A/B testing with Dynamic Re-ranking, be aware that enableReRanking
overwrites the A/B testing group.
- When
enableReRanking
istrue
, users are placed in the re-ranked group. - When
enableReRanking
isfalse
, users are removed from the re-ranked group.
This can lead to issues in A/B test comparisons as the presence or absence of Dynamic Re-ranking will affect the test results.
Avoid this problem by keeping enableReRanking
consistent across both A/B test variants.
Examples
Turn off re-ranking
1
2
3
$results = $index->search('query', [
'enableReRanking' => false
]);