Accept OpenWebUI/Cohere-style rerank payloads; normalize documents an… #6
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
…d top_n/top_k; docs
Fixes a 422 on /api/v1/rerank/ when clients (e.g., OpenWebUI) send {query, documents:[...]} instead of {passages:[...]}. Adds input normalization in models so both styles are accepted without breaking existing clients.
Changes:
- app/models/requests.py: Add model-level pre-validation to map documents -> passages and top_n -> top_k; support documents as list[str] or list[{text:...}]. Keeps existing validation and behavior intact.
- app/models/cohere_models.py: Normalize Cohere request payloads to accept string or object documents (text/content/body/value) and map top_k -> top_n. No router changes required.
- README.md: Document that native /api/v1/rerank/ now accepts {documents: [...]} and {top_n} as aliases for {passages} and {top_k}.
Notes:
- Backward compatible: clients using passages/top_k remain unaffected.
- Cohere endpoints (/v1/rerank, /v2/rerank) already used documents; normalization now also accepts object documents and top_k alias.
- Tests: Provided diagnosis and suggestions to harden tests/test_cohere_api.py (readiness polling, httpx, timeouts), but no test code changes included in this commit.
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.
…d top_n/top_k; docs
Fixes a 422 on /api/v1/rerank/ when clients (e.g., OpenWebUI) send {query, documents:[...]} instead of {passages:[...]}. Adds input normalization in models so both styles are accepted without breaking existing clients.
Changes:
Notes: