VocalDocscontracts 1.65.0

KnowledgeQueryResult

The answer of a query (1.53.0; the plan's KnowledgeResult): the version searched and its passages with their citations.

An object with 7 fields.

Fields

FieldTypeRequiredDescription
elapsed_msintegeryesThe time the api took to answer, a measurement.
knowledge_base_idKnowledgeBaseIdyes
object"knowledge_query_result"yes
passagesarray of KnowledgePassageyesBest first: at most top_k, none below min_score, and no more than fit max_context_tokens. An empty list is an answer, not a failure.
rerankedbooleanyesFalse when the fused order was kept, as when no rerank Provider resolves.
top_scorenumber or nullyesThe highest score of the passages; null when there is none.
versioninteger or nullyesThe version searched; null for the working set.

Used by

The operations whose parameters, request body or responses name this shape directly.