Skip to content
sgp
API Reference

Evaluation Items

Get a single evaluation item
evaluation_items.retrieve(strevaluation_item_id, EvaluationItemRetrieveParams**kwargs) -> EvaluationItem
GET/v5/evaluation-items/{evaluation_item_id}
List and filter evaluation items
evaluation_items.list(EvaluationItemListParams**kwargs) -> SyncCursorPage[EvaluationItem]
GET/v5/evaluation-items
Export evaluation items to a file
evaluation_items.export(EvaluationItemExportParams**kwargs) -> EvaluationItemExport
POST/v5/evaluation-items/export
ModelsExpand Collapse
class Component: …
data: ItemLocator

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

label: Optional[str]
class Container: …
children: List[Child]

The children to be displayed within the container

One of the following:
class Component: …
data: ItemLocator

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

label: Optional[str]
direction: Optional[Literal["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"
class EvaluationItem: …
id: str

The unique identifier of the entity.

created_at: datetime

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

formatdate-time
created_by: Identity

The identity that created the entity.

id: str
type: Literal["user", "service_account"]
One of the following:
"user"
"service_account"
object: Optional[Literal["identity"]]
data: Dict[str, object]
evaluation_id: str
archived_at: Optional[datetime]

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

formatdate-time
dataset_item_id: Optional[str]
dataset_item_version_num: Optional[int]
files: Optional[Dict[str, str]]
object: Optional[Literal["evaluation.item"]]
task_errors: Optional[Dict[str, TaskError]]

Map of task alias to error info.

message: str

Error message

type: str

Error type/category

task_result_statuses: Optional[Dict[str, Literal["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"
class EvaluationItemExport: …

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: str

The name of the exported file

content: Optional[str]

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

signed_url: Optional[str]

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

Literal["json", "jsonl", "csv"]
One of the following:
"json"
"jsonl"
"csv"
Literal["signed_url", "direct"]
One of the following:
"signed_url"
"direct"
class TaskError: …
message: str

Error message

type: str

Error type/category