Skip to main content
PATCH
Core - Reorder and resize columns
Related guide: Experiments guide. See the Experiments guide for a walkthrough with examples.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

experiment_id
string
required

ID of the experiment.

run_id
string
required

ID of the run.

Body

application/json
columns
object[]
required

Layout changes, at least one. Columns not listed keep their layout.

Response

OK

A run: one pass of the experiment's columns over a copy of its dataset rows.

run_id
string

Run ID (ULID).

experiment_id
string

Experiment the run belongs to.

key
string

Run name. Run 1 for the first run; Run plus the last four characters of the run ID when a run is created without a key.

status
enum<string>

Run state. RUN_STATUS_DRAFT: created, never executed. RUN_STATUS_RUNNING: executing. RUN_STATUS_COMPLETED: no rows left to execute, although individual cells may have failed. RUN_STATUS_FAILED: execution stopped on an internal error. RUN_STATUS_CANCELED: stopped by Cancel a run. RUN_STATUS_QUEUED counts as active, like running.

Available options:
RUN_STATUS_UNSPECIFIED,
RUN_STATUS_DRAFT,
RUN_STATUS_QUEUED,
RUN_STATUS_RUNNING,
RUN_STATUS_COMPLETED,
RUN_STATUS_FAILED,
RUN_STATUS_CANCELED
dataset_id
string

Dataset the rows were copied from, taken from the experiment when the run was created. Empty for evaluatorq uploads.

row_count
integer<int32>

Number of rows in the run.

cell_status_counts
object

Number of cells in each status.

columns
object[]

Columns of the run, hidden ones included with active false. Get, create and update order them as dataset, task, job output, metric, evaluator and review columns.

settings
object | null

Null on runs created without settings, such as evaluatorq uploads.

started_at
string<date-time> | null

Time the latest execution started. Null until the run is executed.

completed_at
string<date-time> | null

Time the run completed or was canceled. Null until then, and kept when the run is executed again.

created_at
string<date-time>

Creation time.

updated_at
string<date-time>

Time of the last change to the run.

metrics
object

Average evaluator results per task column, keyed {task_column_id}_{evaluator_id} (the run ID replaces the task column ID for run-level values). Only returned by List runs with include_metrics; categorical evaluators are left out.

stats
object

Execution totals of the run.

created_by_id
string

ID of the user or API key that created the run.