Sign in

v1

latestOpenAPI 3.1.02026-07-26231646860.9 KB
data
prompts
rows

Compute Health Score Endpoint

Compute the health score metric for a metrics testing run.

post/v2/projects/{project_id}/metrics-testing/{run_id}/health-score

Path parameters

project_idstring uuid4 required
run_idstring uuid4 required

Request body

scorer_idstring uuid4 required
output_type'boolean' | 'categorical' | 'count' | 'discrete' | 'freeform' | 'percentage' | 'multilabel' | 'retrieved_chunk_list_boolean' | 'boolean_multilabel' required

Enumeration of output types.

scoreable_node_typesStepType[]

The scorer's scoreable_node_types. Determines which record type carries the score.

mgt_overlayobject

Client-side pending MGT edits: {row_id: value}. Overrides committed dataset values.

Response

Successful Response

health_score_type'macro_f1' | 'micro_f1' | 'mse' | 'mae' required
valuenumber nullable required

Primary health score metric value, or None if no valid rows.

skipped_rowsinteger required

Rows excluded because MGT or score could not be parsed.

secondaryobject required

Secondary metrics (MAE, RMSE, R², per-class F1, etc.).

total_scored_rowsinteger required

Rows with a successful scorer result.

total_mgt_rowsinteger required

Rows with a non-null MGT value after overlay.

joined_rowsinteger required

Rows with both a score and a MGT value (used for computation).