Evaluate a version or the working set

POST /v1/knowledge-bases/{knowledge_base_id}/evaluations

Runs the corpus through the search path against a version or, when version is omitted, the working set, as a knowledge.evaluation job, and answers 202 with the Evaluation queued, its job_id and its Location (1.53.0; knowledge-bases.md section 10). A request while an Evaluation of the same target is queued or running answers that one. An empty corpus is 422 validation_failed with knowledge_corpus_empty; a version that does not exist is not_found and a retired one knowledge_base_version_retired. The job emits job.succeeded or job.failed.

Request

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

curl -X POST "$VOCAL_API/v1/knowledge-bases/kb_.../evaluations" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/knowledge-bases/kb_.../evaluations`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/knowledge-bases/kb_.../evaluations",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: KnowledgeEvaluationCreateRequest.

Responses

Fields of the 202 answer

The shape is KnowledgeEvaluation.