Documentation | Datasets

API Reference

Datasets

DatasetsResource

Methods

client.datasets.create() ->

Dataset

post/v5/datasets

Create Dataset

client.datasets.delete() ->

DatasetDeleteResponse

delete/v5/datasets/{dataset_id}

Delete Dataset

client.datasets.list() -> SyncCursorPage[

Dataset

]

get/v5/datasets

List Datasets

client.datasets.retrieve(, ) ->

Dataset

get/v5/datasets/{dataset_id}

Get Dataset

client.datasets.update(, ) ->

Dataset

patch/v5/datasets/{dataset_id}

Update Dataset

Parameters

dataset_id: str

description: Optional[str]

name: Optional[str]

tags: Optional[

SequenceNotStr

[str]]

The tags associated with the entity

Returns

Dataset

id: str

created_at:

datetime

(format: date-time)

created_by:

Identity

The identity that created the entity.

current_version_num: int

name: str

tags: List[str]

The tags associated with the entity

archived_at: Optional[datetime]

(format: date-time)

description: Optional[str]

object: Optional[Literal["dataset"]]

(default: "dataset")

Request example

from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
dataset = client.datasets.update(
    dataset_id="dataset_id",
)
print(dataset.id)

200Example

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "current_version_num": 0,
  "name": "name",
  "tags": [
    "string"
  ],
  "archived_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "object": "dataset"
}

Domain types

class Dataset: ...