Skip to main content
Section ID: DOC-API-MODEL-schema-1js2bf073d#overview

EvalOverview

Aggregated trace, score, latency, and profile metrics for an evaluation window.

Meaning and usage​

Section ID: DOC-API-MODEL-schema-1js2bf073d#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-1js2bf073d#fields

UsageFields and validation
In responsesView fields

In responses​

Section ID: DOC-API-MODEL-schema-1js2bf073d#response

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-1js2bf073d#field-totaltracesSection ID: DOC-API-MODEL-schema-1js2bf073d#response-field-totaltracestotalTracesstring (int64)OptionalTotal trace count reported for the selected evaluation window. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1js2bf073d#field-tracesbynameSection ID: DOC-API-MODEL-schema-1js2bf073d#response-field-tracesbynametracesByNameArray of NamedCountOptionalTrace counts grouped by trace name.
Section ID: DOC-API-MODEL-schema-1js2bf073d#field-tracesovertimeSection ID: DOC-API-MODEL-schema-1js2bf073d#response-field-tracesovertimetracesOverTimeArray of TimeSeriesPointOptionalTrace counts grouped into time buckets.
Section ID: DOC-API-MODEL-schema-1js2bf073d#field-observationsbylevelSection ID: DOC-API-MODEL-schema-1js2bf073d#response-field-observationsbylevelobservationsByLevelArray of TimeSeriesPointOptionalObservation counts grouped by reported log level.
Section ID: DOC-API-MODEL-schema-1js2bf073d#field-scoresSection ID: DOC-API-MODEL-schema-1js2bf073d#response-field-scoresscoresArray of ScoreAggregateOptionalScore aggregates grouped separately by metric name and source.
Section ID: DOC-API-MODEL-schema-1js2bf073d#field-scoremovingaverageSection ID: DOC-API-MODEL-schema-1js2bf073d#response-field-scoremovingaveragescoreMovingAverageArray of TimeSeriesPointOptionalMoving-average score series returned for the selected window.
Section ID: DOC-API-MODEL-schema-1js2bf073d#field-scoredtraceratioSection ID: DOC-API-MODEL-schema-1js2bf073d#response-field-scoredtraceratioscoredTraceRationumber (double) or string (NaN, Infinity, -Infinity)OptionalCoverage card: share of traces carrying any score, and the annotated count.
Section ID: DOC-API-MODEL-schema-1js2bf073d#field-annotatedtracecountSection ID: DOC-API-MODEL-schema-1js2bf073d#response-field-annotatedtracecountannotatedTraceCountstring (int64)OptionalNumber of traces reported to have annotations in the selected window. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1js2bf073d#field-byprofileSection ID: DOC-API-MODEL-schema-1js2bf073d#response-field-byprofilebyProfileArray of ProfileQualityRowOptionalEvaluation metrics grouped by agent profile.
Section ID: DOC-API-MODEL-schema-1js2bf073d#field-latencypercentilesSection ID: DOC-API-MODEL-schema-1js2bf073d#response-field-latencypercentileslatencyPercentilesArray of LatencyPercentileRowOptionalLatency percentile summaries grouped by trace name.
Section ID: DOC-API-MODEL-schema-1js2bf073d#field-recentlowscoresSection ID: DOC-API-MODEL-schema-1js2bf073d#response-field-recentlowscoresrecentLowScoresArray of ScoreOptionalRecent scores selected by the overview’s low-score query.

Where used​

Section ID: DOC-API-MODEL-schema-1js2bf073d#where-used

ReferenceRelationship
Get the eval overviewPOST /api/v1/evals/get-overview

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-1js2bf073d