docs(SearchParams): Document that filter scores are supported in virtual replicas #5716
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NixFrog
added
documentation
Collaborator
✔️ Code generated!
📊 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
Author
|
Marked as do not merge while we deploy the feature |
jojva
approved these changes
Dec 8, 2025
| - 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). |
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧭 What and Why
Update the documentation schema to note that virtual replicas now support optional filters.
🎟 JIRA Ticket: SRCH-8369
Changes included:
SearchParamsdocmentation🧪 Test
N/A - no functional changes