docs: correct reranker order contract from permutation to subset/empty - #143
Merged
WilliamAGH merged 1 commit intoJul 29, 2026
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
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Updated docs/retrieval-pipeline.md to reflect that the reranker order array may now be a strict subset of source indices (or empty when no documents are relevant), rather than a required complete permutation. The previous wording directly contradicted the new relevance-gating behavior, where unrelated documents are dropped before context and citation assembly.
For example, a developer writing a reranker test asserting that {"order":[2]} is invalid for 4 source documents would have been misled: the code now accepts such subset selections as valid.
Introduced by commit 2fed38c (@WilliamAGH, #141)
Doc Drift PRs can be configured here.