Documentation | Dataset Items

API Reference

Dataset Items

DatasetItemsResource

Methods

client.dataset_items.batch_create() ->

DatasetItemBatchCreateResponse

post/v5/dataset-items/batch

Batch Create Dataset Items

client.dataset_items.delete() ->

DatasetItemDeleteResponse

delete/v5/dataset-items/{dataset_item_id}

Delete Dataset Item

client.dataset_items.list() -> SyncCursorPage[

DatasetItem

]

get/v5/dataset-items

List Dataset Items

client.dataset_items.retrieve(, ) ->

DatasetItem

get/v5/dataset-items/{dataset_item_id}

Get Dataset Item

client.dataset_items.update(, ) ->

DatasetItem

patch/v5/dataset-items/{dataset_item_id}

Update Dataset Item

Parameters

dataset_item_id: str

data: Dict[str,

object

]

Updated dataset item data

Returns

DatasetItem

id: str

content_hash: str

created_at:

datetime

(format: date-time)

created_by:

Identity

The identity that created the entity.

data:

object

updated_at:

datetime

(format: date-time)

archived_at: Optional[datetime]

(format: date-time)

dataset_id: Optional[str]

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

(default: "dataset.item")

Request example

from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
dataset_item = client.dataset_items.update(
    dataset_item_id="dataset_item_id",
    data={
        "foo": "bar"
    },
)
print(dataset_item.id)

200Example

{
  "id": "id",
  "content_hash": "content_hash",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "data": {},
  "updated_at": "2019-12-27T18:11:19.117Z",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "dataset_id": "dataset_id",
  "object": "dataset.item"
}

Domain types

class DatasetItem: ...