Documentation | Evaluation Items

API Reference

Evaluation Items

EvaluationItemsResource

Methods

client.evaluation_items.list() -> SyncCursorPage[

EvaluationItem

]

get/v5/evaluation-items

List Evaluation Items

Parameters

ending_before: Optional[str]

evaluation_id: Optional[str]

include_archived: Optional[

bool

]

limit: Optional[int]

(maximum: 1000, minimum: 1, default: 100)

sort_order: Optional[Literal["asc", "desc"]]

(default: "asc")

"asc"

"desc"

starting_after: Optional[str]

Returns

EvaluationItem

id: str

created_at:

datetime

(format: date-time)

created_by:

Identity

The identity that created the entity.

data: Dict[str,

object

]

evaluation_id: str

archived_at: Optional[datetime]

(format: date-time)

dataset_item_id: Optional[str]

dataset_item_version_num: Optional[int]

object: Optional[Literal["evaluation.item"]]

(default: "evaluation.item")

Request example

from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
page = client.evaluation_items.list()
page = page.items[0]
print(page.id)

200Example

{
  "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,
      "object": "evaluation.item"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

client.evaluation_items.retrieve(, ) ->

EvaluationItem

get/v5/evaluation-items/{evaluation_item_id}

Get Evaluation Item

Domain types

class Component: ...

class Container: ...

class EvaluationItem: ...