Get Experiment Run Metrics
Get metrics for an experiment run.
Requires the run_id query parameter. Use view to choose the breakdown
(summary, by_document, by_target, or votes), and narrow with
document_id or target_path. By default each score-bearing row also
carries a prior_score from the previous completed run; pass
include_prior=false to omit it or prior_run_id to compare against a
specific run.
[0.0, 1.0] scale where 0.0 is low agreement and 1.0 is total
agreement.
The view query parameter selects one of four successful response shapes. In
responses, branch on kind; it is the shared discriminator for the response
shape. Because this endpoint is scoped to a concrete run_id, it returns
historical metrics for that run even if the experiment definition has since
changed. Use the experiment’s freshness / run_plan_mode fields from
experiments.get or experiments.list to decide whether to create a newer run.
include_prior=false to omit prior-run comparison fields, or
prior_run_id=... to override which run is treated as the prior.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
summary, by_document, by_target, votes Response
Successful Response
- ExperimentSummaryMetricsResponse
- ExperimentByDocumentMetricsResponse
- ExperimentByTargetMetricsResponse
- ExperimentVotesMetricsResponse
- ExperimentMetricsStaleError
- ExperimentMetricsMissingError
Run-level summary plus block-specific diagnostics.
prior_run_id + prior_score populate when the request opts into
prior-comparison and a completed prior run exists.
score and documents cover only the documents that produced a result.
Compare scored_document_count against total_document_count to see
whether any of the run's documents failed and were left out.
extract, classifier, split, for_each "summary""summary"Extract-only diagnostics attached to the summary response.
- ExperimentExtractSummaryAggregate
- ExperimentConfusionSummaryAggregate