Evaluation Items

Get a single evaluation item

client.evaluationItems.retrieve(, ?, ?): EvaluationItem { id, created_at, created_by, 9 more }

GET/v5/evaluation-items/{evaluation_item_id}

List and filter evaluation items

client.evaluationItems.list(?, ?): CursorPage<EvaluationItem { id, created_at, created_by, 9 more } >

GET/v5/evaluation-items

Export evaluation items to a file

client.evaluationItems.export(, ?): EvaluationItemExport { filename, content, signed_url }

POST/v5/evaluation-items/export

ModelsExpand Collapse

Component { data, label }

data: ItemLocator

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

label?: string

Container { children, direction }

children: Array<Container { children, direction } | Component { data, label } >

The children to be displayed within the container

One of the following:

Container = Container { children, direction }

Component { data, label }

data: ItemLocator

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

label?: string

direction?: "row" | "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 { 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" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

data: Record<string, unknown>

evaluation_id: string

archived_at?: string

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

formatdate-time

dataset_item_id?: string

dataset_item_version_num?: number

files?: Record<string, string>

object?: "evaluation.item"

task_errors?: Record<string, TaskError { message, type } >

Map of task alias to error info.

message: string

Error message

type: string

Error type/category

task_result_statuses?: Record<string, "completed" | "skipped" | "errored" | 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 { 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?: string

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

signed_url?: string

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

ExportFormat = "json" | "jsonl" | "csv"

One of the following:

"json"

"jsonl"

"csv"

ExportMethod = "signed_url" | "direct"

One of the following:

"signed_url"

"direct"

TaskError { message, type }

message: string

Error message

type: string

Error type/category