KnowledgeQueryRequest
Searches one version of a Knowledge base (1.53.0; the plan's KnowledgeQuery). Each limit omitted takes the version's retrieval_defaults.
An object with 7 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
filter | KnowledgeFilterInput | no | |
max_context_tokens | integer | no | Stops adding passages once their tokens would exceed it. |
min_score | number | no | Drops candidates whose semantic similarity is below it. |
query | string | yes | The question, 1 to 2,000 characters (a target). Content: never logged. From 1.54.0 the query route holds it only sealed in the query embedding task the worker reads (KnowledgeQueryTask), for the wait of the query (5 s, a target), and deletes it when the wait ends, whatever its outcome. |
rerank | boolean | no | Rerank through the rerank stage when a Provider resolves; skipped, and the answer says reranked: false, otherwise. |
top_k | integer | no | At most this many passages. |
version | KnowledgeVersionTarget | no | The active version when omitted. |
Used by
The operations whose parameters, request body or responses name this shape directly.