Skip to content

Query Agent docs rework + naming, tests, and redirects#424

Merged
g-despot merged 3 commits into
agents-reworkfrom
agents-rework-feedback
Jun 2, 2026
Merged

Query Agent docs rework + naming, tests, and redirects#424
g-despot merged 3 commits into
agents-reworkfrom
agents-rework-feedback

Conversation

@g-despot
Copy link
Copy Markdown
Contributor

Summary

Full rework of docs/agents/ to focus on the Query Agent — Personalization and Transformation Agents are removed, the remaining content is reorganized into a clear Modes / Configuration / Clients / Recipes layout, and the product is consistently called the Query Agent throughout the docs. All 22 agent snippets (Python + TypeScript) run green in tests/test_agents.py against weaviate-agents Python 1.5.0 / TypeScript 1.4.1.

Supersedes #410 with all review feedback applied.

What changed

Structure (docs/agents/)

  • Removed docs/agents/personalization/, docs/agents/transformation/, and docs/agents/query/ entirely.
  • New layout:
    • index.md, installation.md, quickstart.md at the top level.
    • clients/{index, python, typescript} — install + import patterns for both client libraries.
    • guides/{index, ask_mode, search_mode, suggest_queries} (research_mode.md exists but is intentionally de-listed in the sidebar).
    • reference/{index, instantiation, system_prompt, multi_turn_conversations, additional_filters, advanced_collections, troubleshooting}.
    • recipes/ — five Query-Agent recipes: query-agent-get-started, query-agent-ecommerce-assistant, query-agent-streamlit-chat, query-agent-vs-diy, query-agent-as-a-tool. (Old personalization-agent-* and transformation-agent-* recipes removed.)
  • Every page now opens with a short purpose sentence before the first subheading.
  • Stale <!-- author TODO --> comments scrubbed; Client client / TypesScript typos fixed.

Naming — "Weaviate Agents" → "Query Agent"

Now that the family is a single product, the docs use "Query Agent" consistently. Updated in: the docs/agents/ pages, secondaryNavbar.js section title + description, docs/weaviate/index.mdx ecosystem bullet, docs/cloud/faq.mdx, docs/cloud/tools/query-agent.mdx, docs/weaviate/client-libraries/python/index.mdx, docs/weaviate/search/query-agent.md, docs/weaviate/quickstart/local.md, docs/weaviate/config-refs/collections.mdx, docs/weaviate/best-practices/code-generation.md, and the contributor-guide style/development examples (also fixed the qeuery typo and a broken /agents/qeuery example link).

Package names (weaviate-agents on npm/PyPI), module paths (weaviate.agents.query), external URLs (weaviateagents.featurebase.app), and tag taxonomy ('agents') are deliberately preserved.

Redirects (netlify.toml)

11 redirects added so existing bookmarks and search-engine results don't 404:

Old New
/agents/query /agents
/agents/query/usage /agents/guides/ask_mode
/agents/query/tutorial-ecommerce /agents/recipes/query-agent-ecommerce-assistant
/agents/recipes/personalization-agent-get-started-{movies,recipes} /agents/recipes
/agents/recipes/transformation-agent-{get-started,retrieval-benchmark} /agents/recipes
/agents/personalization + /agents/personalization/* /agents
/agents/transformation + /agents/transformation/* /agents

Specific paths come before the splat patterns so Netlify matches them first.

Tests (tests/test_agents.py)

  • Every snippet under docs/agents/_includes/code/ is now explicitly listed (no globbing): 11 Python + 11 TypeScript files, 22 tests in total. util.{py,mts} stays out as it's the shared helper imported by the others.
  • Bumped weaviate-agents to Python >=1.5.0 (pyproject.toml) and TypeScript ^1.4.1 (package.json), with uv.lock and yarn.lock regenerated.
  • Snippet bugs fixed while wiring this up:
    • suggest_queries.py — missing QueryAgentCollectionConfig import in the async block.
    • query_agent.py / query_agent.mts / search_mode.mts — diversity-ranking qa.search(..., diversity_weight=...) calls now scope to a single collection with a target vector so the agent can resolve a vectorizer.
    • query_agent.py — the UsageAsyncQueryAgent block referenced an undefined headers variable and passed a bare string to auth_credentials; now defines headers = {...} and uses Auth.api_key(...).
    • query_agent.{py,mts}SuggestQueries snippet pointed at a non-existent IRPAPERS collection; replaced with FinancialContracts.
  • Local verified run: 22 / 22 passed in ~10 minutes against the test WCD cluster.

Other small cleanups

  • tests/README-INDEXABILITY.md — updated the deleted /agents/query/tutorial-ecommerce URL to the new recipe path.

Test plan

  • CI Test Agents job is green against the new pins (Python 1.5.0, TypeScript 1.4.1).
  • yarn start — verify the new agents structure renders, redirects fire locally, no missing-image / broken-link warnings on the touched pages.
  • Spot-check redirect targets: /agents/personalization/agents, /agents/query/usage/agents/guides/ask_mode, /agents/query/tutorial-ecommerce/agents/recipes/query-agent-ecommerce-assistant.

Copy link
Copy Markdown

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

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

@g-despot g-despot changed the base branch from main to agents-rework June 2, 2026 19:51
@g-despot g-despot merged commit d85431d into agents-rework Jun 2, 2026
12 checks passed
@g-despot g-despot deleted the agents-rework-feedback branch June 2, 2026 19:53
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.

2 participants