Skip to main content
GET
Get the calibration report for the active version

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

A namespace name, or a template prefix ending in /* (§7.7), with any / sent as %2F: acme%2Fprod%2Ftenant_123 or acme%2Fprod%2F*.

A namespace name, or a template prefix: a namespace path ending in /*, such as acme/prod/*, which every namespace under acme/prod/ inherits judgments from (§7.7). Up to 256 bytes.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9._:/-]+(/\*)?$
name
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_-]+$

Response

The report.

How well the active version's answers match their outcomes (§6.10). epochs holds one entry per engine epoch with outcomes, newest first. An epoch is the engine_version its evaluations were computed under: each Jev epoch label, or the exact version for a pinned engine.

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_-]+$
type
enum<string>
required
Available options:
bool,
choice,
score
version
integer<int32>
required

The active version the report is for.

Required range: x >= 1
outcomes
integer<int64>
required

Outcomes joined to evaluations of this version, across every epoch.

Required range: x >= 0
epochs
object[]
required