VocalDocscontracts 1.65.0

KnowledgeEvalQuery

A query of the retrieval-quality corpus (1.53.0): the question, its relevant Documents or expect_empty, a filter and tags.

An object with 11 fields.

Fields

FieldTypeRequiredDescription
created_atTimestampyes
expect_emptybooleanyesTrue when no passage should score at or above min_score for the query.
filterKnowledgeFilter or nullyesThe filter the query is run under, as a binding would fix it; null for none.
idKnowledgeEvalQueryIdyes
knowledge_base_idKnowledgeBaseIdyes
object"knowledge_eval_query"yes
querystring or nullyesThe question as a caller would ask it: the content class text, null unless the read names include=text, and null in the answer of a write.
relevant_documentsarray of KnowledgeDocumentIdyesThe Documents that answer the query; empty when expect_empty.
revisionintegeryesCounts writes; returned as the ETag and required in If-Match.
tagsarray of KnowledgeEvalQueryTagyessnake_case labels that group the queries, such as lab_visits.
updated_atTimestampyes

Used by

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