Skip to content

docs(SearchParams): Document that filter scores are supported in virtual replicas #5716

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

Open
NixFrog wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(SearchParams): Document that filter scores are supported in virtual replicas #5716

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion specs/common/schemas/SearchParams.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,8 +410,8 @@ optionalFilters:
Records that match the optional filter rank before records that don't match.
If you're using a negative filter `facet:-value`, matching records rank after records that don't match.

- Optional filters don't work on virtual replicas.
- Optional filters are applied _after_ sort-by attributes.
- On virtual replicas, optional filters are applied _after_ the replica's [relevant sort](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort).
Copy link

@jojva jojva Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I would put this line anywhere but here. Lines 413 and 415 describe how optional filters apply in a primary index/standard replica, so it's a bit weird to put the virtual replica behavior in-between.

- Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)).
- Optional filters don't work with numeric attributes.

Expand Down