[v1.38] Document Boost API#432
Open
g-despot wants to merge 3 commits into
Open
Conversation
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Infrastructure as Code | View in Orca | ||
| SAST | View in Orca | ||
| Secrets | View in Orca | ||
| Vulnerabilities | View in Orca |
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Secrets | View in Orca |
trengrj
approved these changes
May 29, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the v1.38 Preview Boost API (post-retrieval soft reranking) and integrates it into existing search documentation so users can discover and apply Boost across vector, BM25, hybrid, and rerank-related workflows.
Changes:
- Adds a new how-to page for Boost (concepts, condition types, curves, blending/weights, and depth/pagination).
- Adds a shared “Preview” admonition include and cross-links (“Soft-rank with Boost”) from existing search pages.
- Adds a Python end-to-end snippet and documents the
QUERY_BOOST_DEFAULT_DEPTHenvironment variable; updates the sidebar to include the new page.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.js | Adds the Boost doc page to the “How-to: Query & Search” sidebar. |
| docs/weaviate/search/similarity.md | Adds Boost preview import and a “Soft-rank with Boost” section linking to the new page. |
| docs/weaviate/search/rerank.md | Adds Boost preview import and guidance on when to use Boost vs reranking modules. |
| docs/weaviate/search/hybrid.md | Adds Boost preview import and clarifies Boost runs on the fused hybrid results. |
| docs/weaviate/search/boost.md | New Boost how-to page detailing behavior, condition types, curves, blending, and depth. |
| docs/weaviate/search/bm25.md | Adds Boost preview import and a “Soft-rank with Boost” section linking to the new page. |
| docs/deploy/configuration/env-vars/index.md | Documents QUERY_BOOST_DEFAULT_DEPTH. |
| _includes/feature-notes/boost.mdx | New reusable preview admonition for Boost. |
| _includes/code/howto/search.boost.py | New Python snippet with multiple Boost examples used by the new docs page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Summary
Documents the v1.38 Preview Boost API — a post-retrieval rescorer that soft-promotes or demotes search results without removing non-matching documents.
Companion to server PR weaviate/weaviate#11103 and Python client PR weaviate/weaviate-python-client#2030.
What's in here
docs/weaviate/search/boost.md— condition types (filter / property / time decay / numeric decay), curves, blending, depth, negative weights, hybrid behavior. Python-only tabs._includes/code/howto/search.boost.py— seven worked examples, verified end-to-end againstweaviate:1.38.0-rc.0+text2vec-transformersviatests/docker-compose-anon.yml.## Soft-rank with Boostsections onsimilarity.md,hybrid.md,bm25.md,rerank.md, all using a shared<BoostPreview/>admonition.QUERY_BOOST_DEFAULT_DEPTHadded to the env-vars reference.weaviate/search/boostinserted afterrerank.tests/docker-compose*.ymlupgraded fromweaviate:1.37.2→weaviate:1.38.0-rc.0.Test plan
yarn buildclean.weaviate:1.38.0-rc.0withtext2vec-transformers.