docs(api): describe supported search rankers - #6395
Merged
Merged
Conversation
Signed-off-by: KXH <shepherdlaurie238@gmail.com>
KXHXK
requested review from
bbrowning,
cdoern,
franciscojavierarceo,
leseb,
mattf,
raghotham and
skamenan7
as code owners
August 13, 2026 05:33
mattf
approved these changes
Aug 14, 2026
mattf
left a comment
Collaborator
There was a problem hiding this comment.
update the test to check that the description is present or things like "weighted" "rff" are in it
Signed-off-by: KXH <shepherdlaurie238@gmail.com>
Signed-off-by: KXH <shepherdlaurie238@gmail.com>
Contributor
Author
|
Thanks - updated the test as suggested. It now verifies that the schema description is present and independently checks for Verification on the updated test file:
Current head: |
mattf
enabled auto-merge
August 15, 2026 15:37
github-merge-queue
Bot
removed this pull request from the merge queue due to no response for status checks
Aug 15, 2026
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 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 does this PR do?
Adds a schema description to
SearchRankingOptions.rankerthat lists the currently supported ranking algorithms:weighted,rrf,neural, andclassifier.The field remains
str | None, so this is documentation-only and preserves acceptance of other strings for OpenAI API compatibility. A regression test verifies the generated Pydantic schema, and the checked-in OpenAPI specifications are regenerated.Closes #6176
Test Plan
Output:
I also attempted the full pre-commit run twice; initialization could not fetch
pre-commit-hooksbecause the GitHub connection timed out/reset. The relevant Ruff, pytest, schema validation, and generated-file checks above completed locally.