Query Agent docs rework + naming, tests, and redirects#424
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 |
2 tasks
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
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 intests/test_agents.pyagainstweaviate-agentsPython1.5.0/ TypeScript1.4.1.Supersedes #410 with all review feedback applied.
What changed
Structure (
docs/agents/)docs/agents/personalization/,docs/agents/transformation/, anddocs/agents/query/entirely.index.md,installation.md,quickstart.mdat the top level.clients/{index, python, typescript}— install + import patterns for both client libraries.guides/{index, ask_mode, search_mode, suggest_queries}(research_mode.mdexists 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. (Oldpersonalization-agent-*andtransformation-agent-*recipes removed.)<!-- author TODO -->comments scrubbed;Client client/TypesScripttypos 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.jssection title + description,docs/weaviate/index.mdxecosystem 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 theqeuerytypo and a broken/agents/qeueryexample link).Package names (
weaviate-agentson 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:
/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/*/agentsSpecific paths come before the splat patterns so Netlify matches them first.
Tests (
tests/test_agents.py)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.weaviate-agentsto Python>=1.5.0(pyproject.toml) and TypeScript^1.4.1(package.json), withuv.lockandyarn.lockregenerated.suggest_queries.py— missingQueryAgentCollectionConfigimport in the async block.query_agent.py/query_agent.mts/search_mode.mts— diversity-rankingqa.search(..., diversity_weight=...)calls now scope to a single collection with a target vector so the agent can resolve a vectorizer.query_agent.py— theUsageAsyncQueryAgentblock referenced an undefinedheadersvariable and passed a bare string toauth_credentials; now definesheaders = {...}and usesAuth.api_key(...).query_agent.{py,mts}—SuggestQueriessnippet pointed at a non-existentIRPAPERScollection; replaced withFinancialContracts.Other small cleanups
tests/README-INDEXABILITY.md— updated the deleted/agents/query/tutorial-ecommerceURL to the new recipe path.Test plan
Test Agentsjob is green against the new pins (Python1.5.0, TypeScript1.4.1).yarn start— verify the new agents structure renders, redirects fire locally, no missing-image / broken-link warnings on the touched pages./agents/personalization→/agents,/agents/query/usage→/agents/guides/ask_mode,/agents/query/tutorial-ecommerce→/agents/recipes/query-agent-ecommerce-assistant.