This page is about the task object in Ango Hub's export file. For more information on tasks as they are used in Ango Hub, see the page named Tasks.
The task is the main sub-unit of the asset object in the Ango Annotation Format. When obtaining an export from Ango Hub, you are essentially getting a list of assets, with each containing a task.
Tasks are what contain the actual labeling data (e.g. points, classifications, relations, etc.) as well as metadata regarding the labeling task (who labeled the asset, when, etc.)
When downloading the export, you can pick the stage from which the export will be downloaded. By default, it's the Complete stage.
The task object contains the annotations as they were provided to and saved in the stage from which you are exporting the asset.
For example, if you have a task go through multiple labeling stages and then to Complete, the task object will contain the annotations which were sent to Complete after the last labeling stage.
This page details tasks and their metadata in the Ango Export Format.
General Structure
"task" : { taskId // string, ID of the task stage // string, name of the task (e.g. "Review Stage 2") stageId // string, ID of the stage (e.g. "f9313189-d532-4fa3-ad9e-876af7321f6b") updatedAt // string, last task update time (e.g. "2023-09-01T13:02:49.271Z") updatedBy // string, email of user who last updated task (e.g. "lorenzo@example.com") tools // list, annotation information pertaining to labels created with tools. See below for more. classifications // list, annotation information pertaining to classifications. See below for more. relations // list, annotation informatoin pertaining to relations. See below for more. brushDataUrl // string, signed, expiring URL to PNG mask containing brush traces. medicalBrushDataUrl // string, signed, expiring URL to NRRD segmentation file containing med brush traces stageHistory // list, contains more 'task' objects for each stage the asset has been through }
Task Object Fields
Property
Type
Description
Example
taskId
Str
Unique alphanumeric ID assigned to the labeling task.
"taskId": "64e5e5b985eb730015b4ebd9"
stage
Str
Name of the stage from which the task has been exported.
"stage": "Complete"
stageId
Str
Unique ID of the stage from which the task has been exported.
By default, the first Start, Label, and Complete stages automatically created by Hub on project creation have an ID of "Start", "Label", and "Complete" respectively.
"stageId": "f9313189-d532-4fa3-ad9e-876af7321f6b"
updatedAt
Str
GMT time and date at which the task was last updated in the stage from which the export was obtained.
"updatedAt": "2023-08-23T11:36:38.027Z"
updatedBy
Str
Email of the user who last updated the task in the stage from which the export was obtained.
"updatedBy": "lorenzo@imerit.net"
totalDuration
Int
The time it took, in milliseconds, to label the asset in the stage from which the export was obtained. The timer starts when a user opens the asset and stops when they click on "Submit."
In the near future, as the idle time detection features come online, the export will contain a more detailed breakdown of time, including active and idle time.
"totalDuration": 49596
tools
List
Annotation data related to labels created with non-classification and non-relation tools (e.g. bounding box, entity, polygon, etc.)
This object contains the actual annotation information (e.g. coordinates).
Documentation for this object can be found at the Tools page.
Annotation data related to labels created with classification tools.
This object contains the classification questions and answers, as well as classification metadata.
Documentation for this object can be found at the Classifications page.
URL pointing to a PNG image file containing the brush traces created on the asset with Brush tools.
Only one such URL is generated for each asset.
The URL is valid for 120000 seconds from its creation (e.g. time of export).
The resulting PNG will be a file with the same width and height as the original asset, it will have a transparent background, and brush traces will be drawn on it with a color with the same hex value as the color of the brush tool used.
URL pointing to a NRRD file containing the segmentations created on the asset with Medical Brush tools.
Only one such URL is generated for each asset.
The URL is valid for 120000 seconds from its creation (e.g. time of export).
If enabled in export settings, stageHistory contains one task objects of the asset for each of the previous stages the asset has passed through.
For example, if the asset went through Start -> Label -> Review -> Complete, and you obtained the export for Complete, the stageHistory object will list three task objects, one each for Start, Label, and Review.
In each, you will get the state of the task as it was when it left its stage.
