Skip to main content
POST
Core - Add an evaluator column
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
evaluator_id
string
required

ID of the evaluator to add. Each row gets one evaluator cell per task column.

position
integer<int32>

0-based position among the run's columns. Defaults to the end.

Response

OK

A column of a run. Exactly one of the config fields is set, matching the column type.

column_id
string

Column ID. Dataset, prompt, evaluator and review columns keep their ID in new runs; agent columns get a new one.

key
string

Column key, derived from the display name: lowercased, with spaces replaced by underscores.

display_name
string

Column name.

position
integer<int32>

0-based position in the run, after the columns are grouped as dataset, task, job output, metric, evaluator and review columns.

active
boolean

Whether the column is shown in the AI Studio grid. False for hidden columns, such as the token metric columns.

prompt
object

Set on prompt task columns.

agent
object

Set on agent task columns.

openresponse
object

Set on task columns whose cells are filled outside orq.ai.

evaluator
object

Set on evaluator columns.

review
object

Set on human review columns.

dataset
object

Set on the dataset columns: inputs, messages and expected output.

metric
object

Set on metric columns: cost, latency and token counts.

job_output
object

Set on evaluatorq job output columns.

width
integer<int32>

Column width in the AI Studio grid. Task columns default to 280; evaluator, review and metric columns to 200. 0 when unset.