Add docs for effort in Search Mode - #483
Merged
Merged
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 |
CShorten
marked this pull request as draft
July 28, 2026 15:58
CShorten
marked this pull request as ready for review
August 5, 2026 11:51
Contributor
There was a problem hiding this comment.
Pull request overview
Adds Search Mode effort documentation and examples, alongside clearer semantic-search behavior.
Changes:
- Documents effort levels and tradeoffs.
- Adds Python and TypeScript examples.
- Expands Search Mode’s conceptual introduction.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
docs/query-agent/guides/search_mode.md |
Documents Search Mode and effort. |
docs/query-agent/_includes/code/search_mode.py |
Adds a Python effort example. |
docs/query-agent/_includes/code/search_mode.mts |
Adds a TypeScript effort example. |
Suppressed comments (2)
docs/query-agent/_includes/code/search_mode.py:114
- The test suite executes this entire file using the repository's locked
weaviate-agents1.7.0, but that release'sQueryAgent.search()signature does not accepteffort. This call therefore raisesTypeError: unexpected keyword argument 'effort'. Please wait for a compatible release and updatepyproject.toml/uv.lockas part of this change.
effort="ultrahigh",
docs/query-agent/_includes/code/search_mode.mts:108
- The repository currently locks
weaviate-agents1.6.0, whoseQueryAgent.search()destructures onlylimit,collections,diversityWeight, andfiltering;effortis not forwarded and is silently ignored at runtime. Upstream support is still in open PR #58, so publish a compatible release and updatepackage.json/yarn.lockbefore adding this example.
effort: "ultrahigh",
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
erika-shorten
approved these changes
Aug 11, 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's being changed:
Type of change:
How has this been tested?
yarn start