Skip to content

Evaluation Items

Get a single evaluation item
GET/v5/evaluation-items/{evaluation_item_id}
List and filter evaluation items
GET/v5/evaluation-items
Export evaluation items to a file
POST/v5/evaluation-items/export
ModelsExpand Collapse
Component object { data, label }

A pointer to the data in each evaluation item to be displayed within the component

label: optional string
Container object { children, direction }
children: array of Container { children, direction } or Component { data, label }

The children to be displayed within the container

One of the following:
Container object { children, direction }
Component object { data, label }

A pointer to the data in each evaluation item to be displayed within the component

label: optional string
direction: optional "row" or "column"

The axis that children are placed in the container. Based on CSS flex-direction (see: https://developer.mozilla.org/en-US/docs/Web/CSS/flex-direction)

One of the following:
"row"
"column"
EvaluationItem object { id, created_at, created_by, 9 more }
id: string

The unique identifier of the entity.

created_at: string

The date and time when the entity was created in ISO format.

formatdate-time
created_by: Identity { id, type, object }

The identity that created the entity.

id: string
type: "user" or "service_account"
One of the following:
"user"
"service_account"
object: optional "identity"
data: map[unknown]
evaluation_id: string
archived_at: optional string

The date and time when the entity was archived in ISO format.

formatdate-time
dataset_item_id: optional string
dataset_item_version_num: optional number
files: optional map[string]
object: optional "evaluation.item"
task_errors: optional map[TaskError { message, type } ]

Map of task alias to error info.

message: string

Error message

type: string

Error type/category

task_result_statuses: optional map["completed" or "skipped" or "errored" or 2 more]

Per-alias task-result lifecycle status derived from task_result_cache. Present when at least one alias has a recorded status; null for legacy rows with an empty cache. Renderers use this to distinguish prefilled from completed on the wire (values themselves are already merged into data by merge_task_result_cache_into_data).

One of the following:
"completed"
"skipped"
"errored"
"pending"
"prefilled"
EvaluationItemExport object { filename, content, signed_url }

Response model for exporting evaluation items. This class represents the response when users export evaluation items. It contains either a signed URL to download the exported data from object storage, or the actual content bytes when direct download is used (in environments where object storage is not configured).

filename: string

The name of the exported file

content: optional string

The raw file content as bytes, used when direct download is enabled

signed_url: optional string

Pre-signed URL to download the file from object storage, if applicable

ExportFormat = "json" or "jsonl" or "csv"
One of the following:
"json"
"jsonl"
"csv"
ExportMethod = "signed_url" or "direct"
One of the following:
"signed_url"
"direct"
TaskError object { message, type }
message: string

Error message

type: string

Error type/category