Skip to content
sgp
API Reference
Datasets

Create a dataset

datasets.create(DatasetCreateParams**kwargs) -> Dataset
POST/v5/datasets

Create a dataset and populate it with its initial items in a single call.

Use this when the dataset does not exist yet: it creates the dataset and seeds it with the items you provide. To add more items to a dataset that already exists, use POST /v5/dataset-items/batch instead. A name is required, and the request must include at least one item in data; the optional files field associates files with the created items. The provided items are inserted as dataset items as a side effect of creation, and any tags are attached to the dataset. The returned dataset is at version 1.

ParametersExpand Collapse
data: Iterable[Dict[str, object]]

Items to be included in the dataset

name: str
description: Optional[str]
files: Optional[Iterable[Dict[str, str]]]

Files to be associated to the dataset

tags: Optional[Sequence[str]]

The tags associated with the entity

ReturnsExpand Collapse
class Dataset: …
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"]]
current_version_num: int
name: str
tags: Optional[List[str]]

The tags associated with the entity

archived_at: Optional[datetime]

The date and time when the entity was archived in ISO format.

formatdate-time
description: Optional[str]
object: Optional[Literal["dataset"]]

Create a dataset

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
)
dataset = client.datasets.create(
    data=[{
        "foo": "bar"
    }],
    name="name",
)
print(dataset.id)
{
  "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"
}
Returns Examples
{
  "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"
}