DatasetResource
Represents the metadata of a dataset.
Properties
dataset_id
string
Id of the dataset
client_id
string
Id of the workspace the dataset belongs to
dataset_name
string
Name of the dataset
pipeline_spec
array
Labelling stages for the dataset with stage_id and edit permission.
pipeline_status_by_label_set_id
object
Number of tasks in each label set id in each stage for each task status type
sensor_config
object
Instance of SensorConfigResource
uploaded_files
array
List of uploaded files
fps
integer
Fps (Frames per second) information for video type datasets
frame_sizes
array
List of number of points in each frame for point cloud datasets
create_timestamp_millis
float
Timestamp at which dataset was created
dataset_format
string
Format of uploaded file for Point Cloud datasets
dataset_type
string
Type of dataset (images, videos, 3d)
labelling_mode
string
Labelling mode for the dataset
frame_by_frame: for Individual datasets
label_by_label : for Sequence datasets
tags
array
List of TagResource
files
array
Array of file metadata objects. Each object represents metadata about a file being uploaded as part of the dataset.
current_stage
string
Possible values for current stage: "FileUpload", "Processing", "Labelling", "Audit"
current_stage_status
string
Possible values for current stage status: "waiting", "ready", "in_progress", "done"
user_scopes
array
Array of DatasetUserScopeResource
user_group_scopes
array
Array of DatasetUserGroupScopeResource
Example
Represents the metadata of a Label.
Properties
file_id
string
File Id of the label resource
label_type
string
Label type of label resource
label_category_id
string
Label category Id of the label resource
label_id
string
Label Id of the label resource
box
array
Array of four float numbers representing the x, y coordinates, x-length, y-length of the box respectively.
polygons
array
Array of polygons. Each polygon is an array of points.
attributes
object
Object containing key value pairs of attribute keys and values.
Example
Represents the metadata of a file.
Properties
file_id
string
File Id of the file resource
Example
Represents a notification from Deepen AI. Currently, we support notification from Depeen AI after labelling of a dataset is complete. The url to notify should be configured at the dataset level.
Properties
dataset_id
string
Dataset Id of the notification
file_id
string
File Id of the notification
notification_type
string
Represents the type of notification. Currently, we support two notification types:
DatasetLabellingComplete: Sent after the dataset is completely labelled
FileLabellingComplete: Send after an individual file is labelled.
Example
Represents the metadata of an Issue.
Properties
issue_id
string
Issue Id of the issue resource
status
string
Status of the issue resource
issue_description
string
Description of the issue resource
file_id
string
File Id of the issue resource
author_email
string
Email of author for issue resource
label_category
string
Label category of the issue resource
label_id
string
Label Id of the issue resource
issue_creation_timestamp
Object (date)
Created time for issue resource in millis
region
Extruded polygon defining the region for the issue.
Example
Represents the metadata of a task.
Properties
task_id
string
Id of the task resource
status
string
Status of the task resource
client_id
string
Client_id of client
file_id
string
File Id of the task resource
string
Assigned user email for task resource
label_category_id
string
Label category of the task resource
sensor_id
string
Sensor Id of the task resource
stage_id
string
Stage Id of the task resource
label_id
string
Label Id of the task resource
label_type
string
Label type of task resource
task_type
string
Task type of task resource. File for a single frame
Label for sequence
dataset_id
string
dataset_id of dataset
previous_task_ids
List
List of task ids to be completed before starting a task (Note: It will not have previous_task_ids if the particular task is 1st task)
next_task_ids
List
List of task ids to be started after completion of a task (Note: It will not have next_task_ids if the particular task is last task)
history
List
List of changed events containing list of changed events which contains changed_by_email, timestamp_millis, from_status, to_status (Note: It will not have history if there is no relevant history for particular task)
Example
Represents the details of an embedded viewer.
Properties