docs: fix Boost API examples and supported-query list#451
Open
g-despot wants to merge 1 commit into
Open
Conversation
- Correct the Python examples on the Boost search page:
- Boost.property(...) -> Boost.numeric_property(...) (the .property
factory does not exist on the client)
- Boost.blend(...) with multiple conditions now passes them as a list,
matching the signature Boost.blend(boosts, *, weight, depth); the
old multi-positional form raised TypeError
- List near-image and near-media among the boost-supported queries.
- Remove the mention of boost on aggregation: the server accepts it over
gRPC but no client exposes it yet, so it does not belong in the
client-facing docs.
The corrected snippet was verified end-to-end against Weaviate 1.38.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
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
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.
What
Fixes the Boost search docs page (
/weaviate/search/boost) and its Python example so the example actually runs, and trims an unsupported claim.Changes
_includes/code/howto/search.boost.py:Boost.property(...)→Boost.numeric_property(...)(the.propertyfactory doesn't exist on the client — the old example raisedAttributeError)Boost.blend(cond1, cond2, ...)→Boost.blend([cond1, cond2], ...)— multiple conditions must be passed as a list per the signatureBoost.blend(boosts, *, weight, depth); the old multi-positional form raisedTypeErrornear-imageandnear-media(the client supports boost on both).Verification
The corrected snippet was run end-to-end against Weaviate 1.38.0 with the dev/1.38 Python client (which adds the Boost API): exit 0, every block executed, all inline assertions held.
yarn build-devpasses locally.🤖 Generated with Claude Code