Interface: IDataset
An interface representing a Dataset object.
Interface
IDataset
Hierarchy
↳
IDataset
Implemented by
Table of contents
Properties
- clientId
- updatedAt
- updatedBy
- id
- name
- annotations
- annotated
- classes
- attributes
- itemsCount
- url
- items
- directoryTree
- creator
- projects
- export
- metadata
- clientObjectId
- maxClientObjectId
- createdAt
- readableType
- readonly
- shareLevel
- driver
- error
- indexDriver
Properties
clientId
• Optional clientId: string
A local identifier for the Entity, unique within the client.
Inherited from
updatedAt
• Optional updatedAt: IDate
The date and time when the Entity was last updated.
Inherited from
updatedBy
• Optional updatedBy: string
The user who last updated the Entity.
Inherited from
id
• id: string
The unique identifier of the dataset
Overrides
name
• name: string
The name of the dataset
annotations
• annotations: DatasetClassInfo[]
annotated
• annotated: number
The number of items in the dataset that have been annotated
classes
• classes: Object
Index signature
▪ [label: string]: string
attributes
• attributes: string[]
itemsCount
• itemsCount: number
The number of items in the dataset
url
• url: string
The URL of the dataset
items
• items: string
The URL of the dataset's items
directoryTree
• directoryTree: string
The URL of the dataset's directory tree
creator
• creator: string
The dataset creator
Overrides
projects
• projects: string[]
The list of projects the dataset belongs to
export
• export: Object
The URLs of the dataset's exports
Type declaration
| Name | Type |
|---|---|
zip | string |
json | string |
metadata
• Optional metadata: any
The dataset metadata
clientObjectId
• Optional clientObjectId: number
maxClientObjectId
• Optional maxClientObjectId: number
createdAt
• createdAt: IDate
The date the dataset was created
Overrides
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
driver
• driver: string
The dataset's driver
error
• Optional error: any
The dataset's error
indexDriver
• Optional indexDriver: "v1" | "v2"
The dataset's index driver