Documentation | Dataset Items › batch

API Reference

Dataset Items

DatasetItemsResource

Methods

client.dataset_items.batch_create() ->

DatasetItemBatchCreateResponse

post/v5/dataset-items/batch

Batch Create Dataset Items

Parameters

data:

Iterable

[Dict[str,

object

]]

Items to be added to the dataset

dataset_id: str

Identifier of the target dataset

Returns

class DatasetItemBatchCreateResponse:

items: List[

DatasetItem

]

object: Optional[Optional[Literal["list"]]]

(default: "list")

Request example

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
)
response = client.dataset_items.batch_create(
    data=[{
        "foo": "bar"
    }],
    dataset_id="dataset_id",
)
print(response.items)

200Example

{
  "items": [
    {
      "id": "id",
      "content_hash": "content_hash",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by_user_id": "created_by_user_id",
      "data": {},
      "updated_at": "2019-12-27T18:11:19.117Z",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "dataset_id": "dataset_id",
      "object": "dataset.item"
    }
  ],
  "object": "list"
}

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

Domain types

class DatasetItem: ...