VocalDocscontracts 1.65.0

KnowledgeEvaluation

An Evaluation of a Knowledge base version or of its working set (1.53.0): metrics, per-query ranks by id, the thresholds applied and the gate outcome. Immutable once final; never content.

An object with 20 fields.

Fields

FieldTypeRequiredDescription
baselineKnowledgeEvaluationBaseline or nullyesNull when no version is active or the active one has no completed Evaluation, so no relative check applied.
corpus_sha256stringyesThe digest of the ids and revisions of the corpus queries it ran.
created_atTimestampyes
created_byActorRef or nullyesWho asked for it; null when an automatic publish ran it after a sync.
error_codestring or nullyesWhy it failed, such as embedding_failed; null otherwise.
failing_checksarray of KnowledgeGateCheckyesThe checks the metrics fail, also when the outcome is advisory.
finished_atTimestamp or nullyes
gateKnowledgeGateOutcome or nullyespassed, failed or advisory once completed (knowledgeGateOutcome); null before.
idKnowledgeEvaluationIdyes
job_idJobIdyesThe knowledge.evaluation job that runs it.
knowledge_base_idKnowledgeBaseIdyes
manifest_sha256stringyesThe digest of the Document revisions and configuration it searched; a publish compares it with the working set.
metricsKnowledgeEvaluationMetrics or nullyesNull until completed.
object"knowledge_evaluation"yes
resultsarray of KnowledgeEvalResultyes
started_atTimestamp or nullyes
statusKnowledgeEvaluationStatusyes
thresholdsKnowledgeGateThresholdsyes
top_kintegeryes
versioninteger or nullyesThe version evaluated; null for the working set.

Used by

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