Skip to the content

Read an Evaluation

GET /v1/knowledge-bases/{knowledge_base_id}/evaluations/{evaluation_id}

Property	Value
Operation	`get_knowledge_evaluation`
Group	Knowledge bases
Scope	`knowledge:read`
Route class	`read`
Idempotency	No `Idempotency-Key`
Audit	Not audited: A metadata read; an Evaluation holds ids, ranks and scores only.
Released in	1.53.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Answers one Evaluation with its metrics, its per-query ranks and scores by id, the thresholds it applied and its gate outcome (1.53.0); never a query or a passage.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the knowledge:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/knowledge-bases/kb_.../evaluations/kev_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/knowledge-bases/kb_.../evaluations/kev_...`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/knowledge-bases/kb_.../evaluations/kev_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`knowledge_base_id`	path	KnowledgeBaseId	yes	The id of a Knowledge base: `kb_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`evaluation_id`	path	KnowledgeEvaluationId	yes	The id of an Evaluation of a Knowledge base version or its working set: `kev_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	KnowledgeEvaluation
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`
`404`	`application/json`	ErrorEnvelope	`not_found`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is KnowledgeEvaluation.

Field	Type	Required	Description
`baseline`	KnowledgeEvaluationBaseline or null	yes	Null when no version is active or the active one has no completed Evaluation, so no relative check applied.
`corpus_sha256`	string	yes	The digest of the ids and revisions of the corpus queries it ran.
`created_at`	Timestamp	yes
`created_by`	ActorRef or null	yes	Who asked for it; null when an automatic publish ran it after a sync.
`error_code`	string or null	yes	Why it `failed`, such as `embedding_failed`; null otherwise.
`failing_checks`	array of KnowledgeGateCheck	yes	The checks the metrics fail, also when the outcome is advisory.
`finished_at`	Timestamp or null	yes
`gate`	KnowledgeGateOutcome or null	yes	`passed`, `failed` or `advisory` once `completed` (`knowledgeGateOutcome`); null before.
`id`	KnowledgeEvaluationId	yes
`job_id`	JobId	yes	The `knowledge.evaluation` job that runs it.
`knowledge_base_id`	KnowledgeBaseId	yes
`manifest_sha256`	string	yes	The digest of the Document revisions and configuration it searched; a publish compares it with the working set.
`metrics`	KnowledgeEvaluationMetrics or null	yes	Null until `completed`.
`object`	`"knowledge_evaluation"`	yes
`results`	array of KnowledgeEvalResult	yes
`started_at`	Timestamp or null	yes
`status`	KnowledgeEvaluationStatus	yes
`thresholds`	KnowledgeGateThresholds	yes
`top_k`	integer	yes
`version`	integer or null	yes	The version evaluated; null for the working set.