Create a dataset

client.Datasets.New(ctx, body) (*Dataset, error)

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

body DatasetNewParams

Data param.Field[[]map[string, any]]

Items to be included in the dataset

Name param.Field[string]

Description param.Field[string]Optional

Files param.Field[[]map[string, string]]Optional

Files to be associated to the dataset

Tags param.Field[[]string]Optional

The tags associated with the entity

ReturnsExpand Collapse

type Dataset struct{…}

ID string

The unique identifier of the entity.

CreatedAt Time

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

formatdate-time

CreatedBy Identity

The identity that created the entity.

ID string

Type IdentityType

One of the following:

const IdentityTypeUser IdentityType = "user"

const IdentityTypeServiceAccount IdentityType = "service_account"

Object IdentityObjectOptional

CurrentVersionNum int64

Name string

Tags []string

The tags associated with the entity

ArchivedAt TimeOptional

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

formatdate-time

Description stringOptional

Object DatasetObjectOptional

Create a dataset

package main

import (
  "context"
  "fmt"

  "github.com/scaleapi/sgp-dev-go"
  "github.com/scaleapi/sgp-dev-go/option"
)

func main() {
  client := sgpdev.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithAccountID("My Account ID"),
  )
  dataset, err := client.Datasets.New(context.TODO(), sgpdev.DatasetNewParams{
    Data: []map[string]any{map[string]any{
    "foo": "bar",
    }},
    Name: "name",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
}