Class: SDKDataset

sdkApi/interfaces/entities/iDataset.SDKDataset

Represents a dataset instance within the SDK.

Implements

Implements

• IDataset

Table of contents

Constructors

• constructor

Properties

• annotated
• createdAt
• creator
• directoryTree
• driver
• export
• id
• items
• itemsCount
• metadata
• name
• projects
• readableType
• shareLevel
• url

Constructors

constructor

• new SDKDataset(dataset)

Creates an instance of SDKDataset.

Parameters

Properties

annotated

• annotated: number

The number of items in the dataset that have been annotated

Implementation of

IDataset.annotated

createdAt

• createdAt: IDate

The date the dataset was created

Implementation of

IDataset.createdAt

creator

• creator: string

The dataset creator

Implementation of

IDataset.creator

directoryTree

• directoryTree: string

The URL of the dataset's directory tree

Implementation of

IDataset.directoryTree

driver

• driver: string

The dataset's driver

Implementation of

IDataset.driver

export

• export: Object

The URLs of the dataset's exports

Type declaration

Implementation of

IDataset.export

id

• id: string

The unique identifier of the dataset

Implementation of

IDataset.id

items

• items: string

The URL of the dataset's items

Implementation of

IDataset.items

itemsCount

• itemsCount: number

The number of items in the dataset

Implementation of

IDataset.itemsCount

metadata

• Optional metadata: any

The dataset metadata

Implementation of

IDataset.metadata

name

• name: string

The name of the dataset

Implementation of

IDataset.name

projects

• projects: string[]

The projects the dataset belongs to

Implementation of

IDataset.projects

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