Skip to content

Evaluation Items

Get a single evaluation item
client.EvaluationItems.Get(ctx, evaluationItemID, query) (*EvaluationItem, error)
GET/v5/evaluation-items/{evaluation_item_id}
List and filter evaluation items
client.EvaluationItems.List(ctx, query) (*CursorPage[EvaluationItem], error)
GET/v5/evaluation-items
Export evaluation items to a file
client.EvaluationItems.Export(ctx, body) (*EvaluationItemExport, error)
POST/v5/evaluation-items/export
ModelsExpand Collapse
type Component struct{…}

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

Label stringOptional
type Container struct{…}
Children []ContainerChildUnion

The children to be displayed within the container

One of the following:
type Container Container
type Component struct{…}

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

Label stringOptional
Direction ContainerDirectionOptional

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:
const ContainerDirectionRow ContainerDirection = "row"
const ContainerDirectionColumn ContainerDirection = "column"
type EvaluationItem struct{…}
ID string

The unique identifier of the entity.

CreatedAt Time

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

formatdate-time
CreatedBy Identity

The identity that created the entity.

ID string
Type IdentityType
One of the following:
const IdentityTypeUser IdentityType = "user"
const IdentityTypeServiceAccount IdentityType = "service_account"
Object IdentityObjectOptional
Data map[string, any]
EvaluationID string
ArchivedAt TimeOptional

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

formatdate-time
DatasetItemID stringOptional
DatasetItemVersionNum int64Optional
Files map[string, string]Optional
Object EvaluationItemObjectOptional
TaskErrors map[string, TaskError]Optional

Map of task alias to error info.

Message string

Error message

Type string

Error type/category

TaskResultStatuses map[string, string]Optional

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:
const EvaluationItemTaskResultStatusCompleted EvaluationItemTaskResultStatus = "completed"
const EvaluationItemTaskResultStatusSkipped EvaluationItemTaskResultStatus = "skipped"
const EvaluationItemTaskResultStatusErrored EvaluationItemTaskResultStatus = "errored"
const EvaluationItemTaskResultStatusPending EvaluationItemTaskResultStatus = "pending"
const EvaluationItemTaskResultStatusPrefilled EvaluationItemTaskResultStatus = "prefilled"
type EvaluationItemExport struct{…}

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 stringOptional

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

SignedURL stringOptional

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

type ExportFormat string
One of the following:
const ExportFormatJson ExportFormat = "json"
const ExportFormatJSONL ExportFormat = "jsonl"
const ExportFormatCsv ExportFormat = "csv"
type ExportMethod string
One of the following:
const ExportMethodSignedURL ExportMethod = "signed_url"
const ExportMethodDirect ExportMethod = "direct"
type TaskError struct{…}
Message string

Error message

Type string

Error type/category