Skip to content

Add docs for effort in Search Mode - #483

Merged
CShorten merged 5 commits into
mainfrom
effort-search-mode
Aug 11, 2026
Merged

Add docs for effort in Search Mode#483
CShorten merged 5 commits into
mainfrom
effort-search-mode

Conversation

@CShorten

Copy link
Copy Markdown
Member

What's being changed:

Type of change:

  • Documentation content updates (non-breaking change to fix/update documentation )
  • Bug fix (non-breaking change to fixes an issue with the site)
  • Feature or enhancements (non-breaking change to add functionality)

How has this been tested?

  • Local build - the site works as expected when running yarn start

@orca-security-eu orca-security-eu Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

@CShorten CShorten self-assigned this Jul 28, 2026
@CShorten
CShorten marked this pull request as draft July 28, 2026 15:58
@CShorten
CShorten marked this pull request as ready for review August 5, 2026 11:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-agents 1.7.0, but that release's QueryAgent.search() signature does not accept effort. This call therefore raises TypeError: unexpected keyword argument 'effort'. Please wait for a compatible release and update pyproject.toml/uv.lock as part of this change.
    effort="ultrahigh",

docs/query-agent/_includes/code/search_mode.mts:108

  • The repository currently locks weaviate-agents 1.6.0, whose QueryAgent.search() destructures only limit, collections, diversityWeight, and filtering; effort is not forwarded and is silently ignored at runtime. Upstream support is still in open PR #58, so publish a compatible release and update package.json/yarn.lock before 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.

Comment thread docs/query-agent/guides/search_mode.md
Comment thread docs/query-agent/_includes/code/search_mode.py
Comment thread docs/query-agent/_includes/code/search_mode.mts
@CShorten
CShorten merged commit 6da13b4 into main Aug 11, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants