List and filter evaluation items

evaluation_items.list() -> SyncCursorPage[EvaluationItem]

GET/v5/evaluation-items

Return a paginated list of evaluation items belonging to the caller’s account.

Pass evaluation_id to restrict the results to a single evaluation’s items. The completion_status filter selects items by whether any of their tasks errored: failed returns only items that have task errors, passed returns only items with no task errors, and all (or omitting the parameter) returns every item. Archived items are excluded unless include_archived=true. Each returned item has its cached task results merged into data and its errors exposed in task_errors, identically to the single-item endpoint.

ParametersExpand Collapse

completion_status: Optional[Literal["failed", "passed", "all"]]

Filter items by completion status. Pass ‘failed’ to return only items with errors, ‘passed’ for items without errors. Pass ‘all’ or omit to return all items.

One of the following:

"failed"

"passed"

"all"

ending_before: Optional[str]

evaluation_id: Optional[str]

include_archived: Optional[bool]

limit: Optional[int]

maximum10000

minimum1

sort_by: Optional[str]

sort_order: Optional[SortOrder]

One of the following:

"asc"

"desc"

starting_after: Optional[str]

ReturnsExpand Collapse

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"

List and filter evaluation items

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
page = client.evaluation_items.list()
page = page.items[0]
print(page.id)

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "data": {
        "foo": "bar"
      },
      "evaluation_id": "evaluation_id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "dataset_item_id": "dataset_item_id",
      "dataset_item_version_num": 0,
      "files": {
        "foo": "string"
      },
      "object": "evaluation.item",
      "task_errors": {
        "foo": {
          "message": "message",
          "type": "type"
        }
      },
      "task_result_statuses": {
        "foo": "completed"
      }
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Returns Examples

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "data": {
        "foo": "bar"
      },
      "evaluation_id": "evaluation_id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "dataset_item_id": "dataset_item_id",
      "dataset_item_version_num": 0,
      "files": {
        "foo": "string"
      },
      "object": "evaluation.item",
      "task_errors": {
        "foo": {
          "message": "message",
          "type": "type"
        }
      },
      "task_result_statuses": {
        "foo": "completed"
      }
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}