search_docs
Retrieve ranked, citable passages from Neutrinos product documentation by natural-language query. Ensure accurate answers for your specific product version across thousands of topics.
Instructions
Search the Neutrinos product documentation (53 publications, 3,117 topics) and return ranked, citable passages. This is the entry point for any question about Neutrinos products. IMPORTANT: the same topic is often documented separately for several product versions. If the user's version is known, pass product and version; otherwise only current versions are searched. Check sufficient_evidence before answering - when it is false, say the documentation does not cover the question rather than inferring an answer. Call list_products first if unsure what to pass for product.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The user's question in natural language. Prefer the user's own wording - the index is built to absorb vocabulary mismatch. Several narrow searches beat one broad one. | |
| top_k | No | Number of passages to return. Near-duplicate passages across versions are collapsed before this limit is applied. | |
| product | No | Restrict to one product, e.g. 'Studio'. Values come from `list_products`. Omit to search all products. | |
| version | No | Restrict to one product version, e.g. '9'. Requires `product`. Omit to use the current version. | |
| response_format | No | 'concise' returns ~400-token excerpts (use this by default). 'detailed' returns full sections and costs roughly 4x the tokens. | concise |
| include_superseded | No | Include documentation for superseded product versions. Use only when the user is explicitly on an older version or asking about history. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notice | No | Present when results were capped or scope was widened. Tells you how to narrow the next call. | |
| results | Yes | ||
| truncated | No | ||
| confidence | Yes | Aggregate confidence over the returned set. | |
| scope_applied | Yes | ||
| match_expression | No | The lexical expression that produced hits, after the relaxation ladder. If it shows OR-relaxation, matching was loose - weigh the results accordingly. | |
| version_ambiguous | No | True when strong hits exist in multiple product versions and the user did not state one. Ask the user which version they are on. | |
| sufficient_evidence | Yes | False means the documentation does not adequately cover this question. Tell the user so; do not compose an answer from weak hits. |