Class DatasetsResource

Index

Constructors

Methods

list get create upload delete download addItem addItems listItems getItem updateItem archiveItem

Constructors

constructor

new DatasetsResource(_client: Client): DatasetsResource
Parameters
- _client: Client
Returns DatasetsResource
- Defined in resources/datasets.ts:51

Methods

list

list(params?: ListDatasetsParams): Promise<PaginatedResponse<{}>>
List datasets
Parameters
- Optionalparams: ListDatasetsParams
Returns Promise<PaginatedResponse<{}>>
- Defined in resources/datasets.ts:56

get

get(id: string, download?: boolean): Promise<{}>
Get dataset details
Parameters
- id: string
- download: boolean = false
Returns Promise<{}>
- Defined in resources/datasets.ts:82

create

create(data: {}): Promise<{}>
Create a new dataset
Parameters
- data: {}
Returns Promise<{}>
- Defined in resources/datasets.ts:105

upload

upload(file: FileInput, metadata: DatasetMetadata): Promise<{}>
Upload a file as a dataset
Parameters
- file: FileInput
- metadata: DatasetMetadata
Returns Promise<{}>
- Defined in resources/datasets.ts:125

delete

delete(id: string): Promise<void>
Delete a dataset
Parameters
- id: string
Returns Promise<void>
- Defined in resources/datasets.ts:210

download

download(id: string): Promise<{}>
Download dataset file
Parameters
- id: string
Returns Promise<{}>
- Defined in resources/datasets.ts:228

addItem

addItem(datasetId: string, item: {}): Promise<{}>
Add a single item to a dataset
Parameters
- datasetId: string
- item: {}
Returns Promise<{}>
- Defined in resources/datasets.ts:235

addItems

addItems(datasetId: string, items: {}[]): Promise<{}[]>
Bulk add items to a dataset (at most 5000 per call)
Parameters
- datasetId: string
- items: {}[]
Returns Promise<{}[]>
- Defined in resources/datasets.ts:254

listItems

listItems(
datasetId: string,
params?: ListDatasetItemsParams,
): Promise<PaginatedResponse<{}>>
List the latest-version items of a dataset (with embedded published annotations)
Parameters
- datasetId: string
- params: ListDatasetItemsParams = {}
Returns Promise<PaginatedResponse<{}>>
- Defined in resources/datasets.ts:273

getItem

getItem(datasetId: string, itemId: string): Promise<{}>
Get a single dataset item
Parameters
- datasetId: string
- itemId: string
Returns Promise<{}>
- Defined in resources/datasets.ts:300

updateItem

updateItem(datasetId: string, itemId: string, item: {}): Promise<{}>
Edit a dataset item (creates a new version; only the latest version is editable)
Parameters
- datasetId: string
- itemId: string
- item: {}
Returns Promise<{}>
- Defined in resources/datasets.ts:318

archiveItem

archiveItem(datasetId: string, itemId: string): Promise<void>
Archive (soft-delete) a dataset item
Parameters
- datasetId: string
- itemId: string
Returns Promise<void>
- Defined in resources/datasets.ts:341