Skip to main content
POST

Authorizations

Authorization
string
header
required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Path Parameters

alignment_task_id
string
required

The unique alignment task identifier (base64) A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Body containing alignment run parameters.

Body containing alignment run parameters.

evaluator_version_id
string
required

The unique identifier for the evaluator version to score. The caller must have update access to the evaluator that owns it.

dataset_version_id
string
required

The unique identifier for the dataset version to score over. Must belong to the alignment task's dataset.

predicted_entity
object
required

The entity whose judge labels are compared against the human annotations.

Response

Returns the created alignment run

One alignment score: how closely an evaluator version's labels matched the human annotations over one dataset version, using the column pair and function its task names. A finished run is never rewritten -- re-scoring creates a new run.

id
string
required

The unique identifier for the alignment run

created_at
string<date-time>
required

When the alignment run was created

updated_at
string<date-time>
required

When the alignment run was last modified

alignment_task_id
string
required

The unique identifier for the alignment task that defined what this run compared

evaluator_version_id
string
required

The unique identifier for the evaluator version whose labels were scored

dataset_version_id
string
required

The unique identifier for the dataset version the comparison ran over

predicted_entity
object | null
required

The experiment or dataset version that supplied the evaluator labels. Recorded when the run starts and retained if scoring fails. Null for older runs whose prediction source was not recorded.

status
enum<string>
required

Status of the run. A run that could not be scored is returned with FAILED and a failed_reason; it is still a successfully created run, not a request error.

Available options:
PENDING,
RUNNING,
COMPLETED,
FAILED,
CANCELLED
score
number<double> | null
required

The fraction of comparable rows on which the evaluator's label and the human annotation agreed, from 0 to 1.

null means no row had both a judge label and a human annotation, so there was nothing to compare. null is not the same as 0: 0 means rows were compared and none of them agreed. Treating null as 0 reports total disagreement where nothing was measured at all.

Always null when status is FAILED.

Required range: 0 <= x <= 1
comparable_row_count
integer | null
required

How many rows had both a judge label and a human annotation. This is the denominator score was computed over, so a high score over a small comparable_row_count is not meaningful -- read the two together.

null when the count is unknown, which includes every FAILED run. A value of 0 pairs with a null score.

Required range: x >= 0
failed_reason
string | null
required

Why the run failed, when status is FAILED. null otherwise.