Skip to main content
GET
Get one evaluation record

Authorizations

Authorization
string
header
required

An organization API key. Keys carry a role (read_write or read_only) and may be restricted to a namespace prefix such as acme/*, or to one namespace such as acme/prod/tenant_1. A prefix matches on a / boundary: acme/prod/tenant_1* covers acme/prod/tenant_1 and everything under acme/prod/tenant_1/, never acme/prod/tenant_12.

Path Parameters

ns
string
required

The namespace name, with any / sent as %2F. Up to 256 bytes. / separates levels of the hierarchy, as in acme/prod/tenant_123. Never exactly . or .., which a URL path can't carry.

Required string length: 1 - 256
Pattern: ^(?!\.\.?$)[A-Za-z0-9._:/-]+$
id
string
required

The evaluation id, ev_ and a ULID.

Pattern: ^ev_[0-9a-z]{26}$

Response

The evaluation, with context and raw.

An immutable record of one computation.

id
string
required
document_id
string
required

Up to 128 bytes. Never exactly . or .., which a URL path can't carry.

Required string length: 1 - 128
Pattern: ^(?!\.\.?$)[A-Za-z0-9._:/-]+$
revision
integer<int64>
required
Required range: x >= 0
incarnation
integer<int64>
required
Required range: x >= 0
judgment
string
required

A judgment, attribute or threshold name. Names are path segments in field references, so they never contain ..

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
judgment_version
integer<int32>
required
Required range: x >= 1
engine
string
required
engine_version
string
required
context_hash
string
required
Pattern: ^sha256:[0-9a-f]{64}$
context_tokens
integer
required
Required range: x >= 0
context_truncated
boolean
required
output
object | null
required

The engine's numbers. Null when the evaluation failed.

status
enum<string>
required
Available options:
success,
failed
error
object | null
required

Why the evaluation failed. Null on success.

shadow
boolean
required

True for shadow evaluations from activation reports, which never produce answers.

replay_of
string | null
required

For a replay after a Jev drift, the evaluation whose stored context it judged again in the new epoch: its context is that evaluation's, so it has none of its own. Replays recalibrate the new epoch; they never produce answers and are never billed. Null for every other evaluation.

created_at
string<date-time>
required

RFC 3339, UTC.

latency_ms
integer

How long the engine request that produced it took, retries excluded. Absent for evaluations recorded before it was measured.

Required range: x >= 0
watermark
integer<int64>

Entity judgments only. The log position the context was read at.

Required range: x >= 0
answers_generation
integer<int64>

Entity judgments only. How far the context had read other judgments' answers and block changes, beside watermark, as on the answer.

Required range: x >= 0
child_answers_stale
boolean

Entity judgments only, beside answers_generation. True when a document whose answers the context read had a newer revision still pending, so its last answer was rendered. Wait it out rather than act on it, since that document's new answer re-judges this one if it changes what a relation shows.

Entity judgments only, with include=history,context or from GET .../evaluations/{id}. Every related document the context read, rendered or aggregated, with the revision it was read at.

previous_revision
integer<int64>

For a recipe with previous, the revision the previous rendering came from; absent with first_revision.

Required range: x >= 0
first_revision
boolean

For a recipe with previous, true when the context showed nothing under previous, such as a document's first evaluation in its incarnation or a re-created id, and then previous_revision is absent. Absent for a recipe without previous.

context
object

With include=history,context, the compiled context the engine saw.

raw
any

With include=history,raw, the engine's answer to this judgment alone, in the shape of output. It never carries other judgments' answers or the engine's token counts.