Interface: IDataset

sdkApi/interfaces/entities/iDataset.IDataset

An interface representing a Dataset object.

Interface

IDataset

Hierarchy

Implemented by

Table of contents

Properties

Properties

annotated

• annotated: number

The number of items in the dataset that have been annotated

clientId

• Optional clientId: string

A local identifier for the Entity, unique within the client.

Inherited from

IEntity.clientId

createdAt

• createdAt: IDate

The date the dataset was created

Overrides

IEntity.createdAt

creator

• creator: string

The dataset creator

Overrides

IEntity.creator

directoryTree

• directoryTree: string

The URL of the dataset's directory tree

driver

• driver: string

The dataset's driver

error

• Optional error: any

The dataset's error

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

Overrides

IEntity.id

indexDriver

• Optional indexDriver: "v1" | "v2"

The dataset's index driver

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 list of projects the dataset belongs to

readableType

• readableType: string

The dataset type

readonly

• Optional readonly: boolean

Whether the dataset is read-only

shareLevel

• shareLevel: "private" | "project"

The dataset's share level

updatedAt

• Optional updatedAt: IDate

The date and time when the Entity was last updated.

Inherited from

IEntity.updatedAt

updatedBy

• Optional updatedBy: string

The user who last updated the Entity.

Inherited from

IEntity.updatedBy

url

• url: string

The URL of the dataset