Class: SDKDataset

entities.SDKDataset

Represents a dataset instance within the SDK.

Implements

Table of contents

Constructors

Properties

Constructors

constructor

new SDKDataset(dataset)

Creates an instance of SDKDataset.

Parameters

Name Type
dataset Partial<SDKDataset>

Properties

annotated

annotated: number

The number of items in the dataset that have been annotated


createdAt

createdAt: IDate

The date the dataset was created


creator

creator: string

The dataset creator


directoryTree

directoryTree: string

The URL of the dataset's directory tree


driver

driver: string

The dataset's driver


export

export: Object

The URLs of the dataset's exports

Type declaration

Name Type
json string
zip string

id

id: string

The unique identifier of the dataset


items

items: string

The URL of the dataset's items


itemsCount

itemsCount: number

The number of items in the dataset


metadata

Optional metadata: any

The dataset metadata


name

name: string

The name of the dataset


projects

projects: string[]

The projects the dataset belongs to


readableType

readableType: string

The type of the dataset

Implementation of

IDataset .readableType


shareLevel

shareLevel: "private" | "project"

The share level of the dataset

Implementation of

IDataset .shareLevel


url

url: string

The URL of the dataset

Implementation of

IDataset .url