JSON Format Export
If using Windows, we recommend using 7-Zip to unzip the exported labels.
Label Coordinates
In the JSON format, label coordinates are normalized to be between 0 and 1. This means that the corners of the frame or image correspond to the coordinates (1,1), (1,0), (0,0), (0,1) regardless of frame dimensions.
To get the pixel values of normalized coordinates:
- The
x
andh
coordinates of a label should be multiplied by the pixel width of the frame or image. - The
y
andw
coordinates of a label should be multiplied by the pixel height of the frame or image.
Format of Exported Labels
The last_edited_by
and last_edited_at
fields are updated only when the label or its nested attributes are modified in the Label Editor. If the SDK is used to update the label, these fields must be updated manually.
The tables below provide descriptions of all values contained JSON format exports.
data_type
is deleted
, while image groups and image sequences only contain a single data_unit
.Single Images
The export contains a list of JSON objects, with each JSON object representing a single data unit and containing detailed information for all exported labels.
The example below describes all the keys for a single exported data unit.
Key | Description | Notes |
---|---|---|
label_hash | The Label Row hash | The ‘hash’ represents a unique identifier |
created_at | Time and date the label was created | |
last_edited_at | Time and date the label was last edited | |
dataset_hash | The Dataset’s hash | The ‘hash’ represents a unique identifier |
data_type | The data unit’s file format | Always “video” for videos |
is_image_sequence | ”true” when the data unit is an image sequence | Always “null” for images |
video_link | Contains a private cloud URL for videos | Always “null” for images |
data_units | List of all files the data unit is composed of | Details of the export information for `data_units“ can be found below. |
object_answers | All the attributes in this data unit | The object attributes are identified using their hash |
classification_answers | All the classifications in a particular data unit | The classification labels are identified using their hash |
object_actions | The number of states a dynamic attribute can be in. | A change in state occurs each time the attribute answer changes. The objectHash within the object_actions is the attribute answer’s ID. |
label_status | Indicates whether the data unit has been labeled. | |
export_history | Contains a record of the export history for this data unit | Exporting labels to confirm export history generates an export history entry. |
export_hash | The hash for this particular export instance | The ‘hash’ represents a unique identifier |
exported_at | The date and time when a particular export instance took place. |
data_units
data_units
The data_units
key contains all files that compose the data unit. For a given image there is only ever a single element in this list. This element contains the following information.
data_units
here refer to individual files that compose a data unit, as defined in our glossary, and are not to be confused with data units elsewhere in the platform. Encord will update this nomenclature soon, but we always communicate changes to all customers first.Key | Description | Notes |
---|---|---|
data_hash | The file’s hash | The ‘hash’ represents a unique identifier |
data_title | The file’s title | |
data_type | The file type | |
data_sequence | The sequence number of this file within the data unit | Always 0 for images, as single images are composed of a single file by definition |
labels | A container for the image’s label information | This contains the label information for the image. |
data_link | A link to the file stored in your private cloud | |
width | The width of the image in pixel (px) | |
height | The height of the image in pixel (px) |
labels
labels
labels
contains all object labels, classification labels, and attributes present in the image.
Key | Description | Notes |
---|---|---|
objects | A list of label objects in this frame | Contains geometric information for object labels |
classifications | A list of classifications applying to image as a whole |
objects
objects
objects
contains all object label information for the image. A key with the name of the object shape is always present - bounding_box
in the example below. All shapes contain coordinates for each vertex.
The example below shows a single object instance.
Key | Description | Notes |
---|---|---|
objectHash | The specific label’s hash | The ‘hash’ represents a unique identifier |
featureHash | The Ontology object’s hash | Corresponds to the FeatureNodeHash in the ontology |
name | The object’s name | As specified in the ontology |
value | The name given to the object | |
color | The color used to draw the object | As specified in the ontology |
shape | The Ontology class used to create the object | As specified in the ontology |
confidence | The confidence score for this object | A confidence score of 1 is given for all labels created manually. More info can be found here |
frame | The frame number of the data unit where the label appears | A frame number of 0 represents the first frame of the data unit. Images always have a frame number of 0. |
createdBy | The email of the user that created this object | |
createdAt | Date and time the object was created | |
lastEditedBy | The email of the user that last edited this object | |
lastEditedAt | Date and time the object was last edited | |
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
boundingBox | A list containing the coordinates for the bounding box | Refer to the ontology shapes section for more details |
classifications
classifications
classifications
contains all classification information for the image.
The following example shows a single object instance.
Key | Description | Notes | |
---|---|---|---|
name | The classification’s name | As specified in the ontology | |
value | The classification value | Same as the name | |
createdAt | Time and day the classification was created | ||
createdBy | The email of the user that created this classification | ||
confidence | The confidence score for this classification | A confidence score of 1 is given for all labels created manually. More info can be found here | |
featureHash | The classification instance hash | Corresponds to the FeatureNodeHash in the Ontology | |
lastEditedAt | Time and date of the last time this classification was edited | ||
classificationHash | The classification instance hash hash | ||
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
object_answers
object_answers
object_answers
is a list of objects that have at least one nested attribute and contains information for all attributes. Expanding object_answers
reveals the following:
Key | Description | Notes |
---|---|---|
objectHash | The hash of the object containing the attributes | The ‘hash’ represents a unique identifier |
classifications | A list of attributes related to the object. Includes Dynamic attributes and Relation attributes | Not to be confused with classifications as defined in our glossary, which apply to a frame |
name | The attribute name | |
value | The attribute value | Always the same as the name |
answers | The value(s) the attribute(s) were set to | If the attribute was a radio button, the answer is the option selected by the annotator |
featureHash | The attribute’s hash | The ‘hash’ represents a unique identifier |
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
classification_answers
classification_answers
Contains a list of classifications that apply to entire frames or slices. classification_answer
is represented by its hash. Expanding classification_answers
reveals the following:
Key | Description | Notes |
---|---|---|
classificationHash | The classification’s hash | Corresponds to the featureNodeHash in the Ontology |
classifications | A list of classification information | |
name | The classification name | As set in the Ontology (Quality in the example above) |
value | The classification value | Always the same as the classification name |
answers | A list of all classification answers | ”answers” refer to the values the classification were set to. |
name | The name of the classification answer | ”Night” in the example above |
value | The classification answer’s value | Always the same as the classifications answer’s name |
featureHash | The hash for the particular classification answer | Included in answers |
featureHash | The hash for the particular classification | |
manualAnnotation | ”true” for all manually created labels. “false” for all labels created with automated labeling techniques |
export_history
export_history
The export_history
contains a list of all exports for this data unit, the first entry being the current export. Each instance contains the following:
Key | Description | Notes |
---|---|---|
export_hash | The export instance’s hash | The ‘hash’ represents a unique identifier |
exported_at | Date and time of the export | |
user_email | The email of the user that made this export |
Image Groups & Image Sequences
The export contains a list of JSON objects, with each JSON object representing a single image group or image sequence, and containing detailed information for all exported labels.
The example below describes all the keys for a single exported data unit.
Key | Description | Notes |
---|---|---|
label_hash | The Label Row hash | The ‘hash’ represents a unique identifier |
created_at | Time and date the label was created | |
last_edited_at | Time and date the label was last edited | |
dataset_hash | The dataset’s hash | The ‘hash’ represents a unique identifier |
data_type | The data unit’s file format | Always “img_group” for image groups and image sequences |
is_image_sequence | true when the data unit is an image sequence | false for all other types of data, including image groups. This is what distinguishes image groups and image sequences in your export |
video_link | Contains a link to file storage location if file is a video | Always “null” for image groups and image sequences |
data_units | List of all files the data unit is composed of | Details of the export information for data units can be found below. |
object_answers | All the attributes in this data unit | The object attributes are identified using their hash |
classification_answers | All the classifications in a particular data unit | The classification labels are identified using their hash |
object_actions | The number of states a dynamic attribute can be in. | A change in state occurs each time the attribute answer changes. The objectHash within the object_actions is the attribute answer’s ID. |
label_status | Indicates whether the data unit has been labeled. | |
export_history | Contains a record of the export history for this data unit | Exporting labels to confirm export history generates an export history entry. |
export_hash | The hash for this particular export instance | The ‘hash’ represents a unique identifier |
exported_at | The date and time when a particular export instance took place. |
data_units
data_units
The data_units
key contains a list of all files that compose the image group or image sequence (sometimes referred to as frames). It contains the following information.
data_units
here refer to individual files that compose a data unit, as defined in our glossary, and are not to be confused with data units elsewhere in the platform. Encord will update this nomenclature soon, but we always communicate changes to all customers first.Key | Description | Notes |
---|---|---|
data_hash | The file’s hash | The ‘hash’ represents a unique identifier |
data_title | The file’s title | |
data_type | The file type | |
data_sequence | The sequence number of this file within the data unit | 0 represents the first file |
labels | A list of all frames contained in image group or sequence, and any labels on each frame | This contains the label information for each frame. |
width | The width of the frame in pixel (px) | |
height | The height of the frame in pixel (px) |
labels
labels
Each number within labels
represents an individual frame within the image group or sequence. Each frame contains the following:
Key | Description | Notes |
---|---|---|
objects | A list of label objects in this frame | Contains geometric information for object labels |
classifications | A list of classifications applying to the entire frame | Is the same value for all instances of this classification. |
objects
objects
objects
contains label information for all object instances in a frame. A key with the name of the object shape is always present - bounding_box
in the example below. All shapes contain coordinates for each vertex.
The example below shows a single object instance.
Key | Description | Notes |
---|---|---|
name | The object’s name | As specified in the ontology |
color | The color used to draw the object | As specified in the ontology |
shape | The Ontology class used to create the object | As specified in the ontology |
value | The name given to the object | |
createdAt | Date and time the object was created | |
createdBy | The email of the user that created this object | |
confidence | The confidence score for this object | A confidence score of 1 is given for all labels created manually. More info can be found here |
objectHash | The specific label’s hash | The ‘hash’ represents a unique identifier |
featureHash | The Ontology object’s hash | Corresponds to the FeatureNodeHash in the ontology |
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
boundingBox | A list containing the coordinates for the bounding box | Refer to the ontology shapes section for more details |
classifications
classifications
classifications
contains all frame level classification information for the image group or sequence.
The example below shows a single classification instance.
Key | Description | Notes | |
---|---|---|---|
name | The classification’s name | As specified in the ontology | |
value | The classification value | Same as the name | |
createdAt | Time and day the classification was created | ||
createdBy | The email of the user that created this classification | ||
confidence | The confidence score for this classification | A confidence score of 1 is given for all labels created manually. More info can be found here | |
featureHash | The classification instance hash | Corresponds to the FeatureNodeHash in the Ontology | |
lastEditedAt | Time and date of the last time this classification was edited | ||
classificationHash | The classification instance hash hash | ||
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
object_answers
object_answers
object_answers
is a list of objects that have at least one nested attribute and contains information for all attributes. Expanding object_answers
reveals the following:
Key | Description | Notes |
---|---|---|
objectHash | The hash of the object containing the attributes | The ‘hash’ represents a unique identifier |
classifications | A list of attributes related to the object. Includes Dynamic attributes and Relation attributes | Not to be confused with classifications as defined in our glossary, which apply to a frame |
name | The attribute name | |
value | The attribute value | Always the same as the name |
answers | The value(s) the attribute(s) were set to | If the attribute was a radio button, the answer is the option selected by the annotator |
featureHash | The attribute’s hash | The ‘hash’ represents a unique identifier |
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
classification_answers
classification_answers
Contains a list of classifications that apply to entire frames or slices. classification_answer
is represented by its hash. Expanding classification_answers
reveals the following:
Key | Description | Notes |
---|---|---|
classificationHash | The classification’s hash | The ‘hash’ represents a unique identifier |
classifications | A list of classifications information | |
name | The classification name | As set in the Ontology (Quality in the example above) |
value | The classification value | Always the same as the classification name |
answers | A list of all classification answers | ”answers” refer to the values the classifications were set to. |
name | The name of the classification answer | ”out of focus” in the example above |
value | The classification answer’s value | Always the same as the classification answer’s name |
featureHash | The hash for the particular classification answer | Included in answers |
featureHash | The hash for the particular classification | |
manualAnnotation | ”true” for all manually created labels. “false” for all labels created with automated labeling techniques |
export_history
export_history
The export_history
contains a list of all exports for this data unit, the first entry being the current export. Each instance contains the following:
Key | Description | Notes |
---|---|---|
export_hash | The export instance’s hash | The ‘hash’ represents a unique identifier |
exported_at | Date and time of the export | |
user_email | The email of the user that made this export |
Videos
The export contains a list of JSON objects, with each JSON object representing a single data unit and containing detailed information for all exported labels.
The example below describes all the keys for a single exported data unit.
Key | Description | Notes |
---|---|---|
label_hash | The Label Row hash | The ‘hash’ represents a unique identifier |
created_at | Time and date the label was created | |
last_edited_at | Time and date the label was last edited | |
dataset_hash | The Dataset’s hash | The ‘hash’ represents a unique identifier |
data_type | The data unit’s file format | Always “video” for videos |
is_image_sequence | ”true” when the data unit is an image sequence | Always “null” for videos |
video_link | Link to the video saved on your private cloud | Always “null” for all other file types |
data_units | List of all files the data unit is composed of | Details of the export information for `data_units“ can be found below. |
object_answers | All the attributes in this data unit | The object attributes are identified using their hash |
classification_answers | All the classifications in a particular data unit | The classification labels are identified using their hash |
object_actions | The number of states a dynamic attribute can be in. | A change in state occurs each time the attribute answer changes. The objectHash within the object_actions is the attribute answer’s ID. |
label_status | Indicates whether the data unit has been labeled. | |
export_history | Contains a record of the export history for this data unit | Exporting labels to confirm export history generates an export history entry. |
export_hash | The hash for this particular export instance | The ‘hash’ represents a unique identifier |
exported_at | The date and time when a particular export instance took place. |
data_units
data_units
The data_units
key contains all files that compose the data unit. For a given video there is only a single element in this list. This element contains the following information.
data_units
here refer to individual files that compose a data unit, as defined in our glossary, and are not to be confused with data unit elsewhere in the platform. Encord will update this nomenclature soon, but we always communicate changes to all customers first.Key | Description | Notes |
---|---|---|
data_hash | The file’s hash | The ‘hash’ represents a unique identifier |
data_title | The file’s title | |
data_type | The file type | |
data_sequence | The sequence number of this file within the data unit | 0 represents the first file |
labels | A list of all frames contained in the video and any labels on each frame | This contains the label information for each frame. |
data_fps | The frames per second for this video | |
data_duration | The video length | In seconds |
data_link | A link to the file stored in your private cloud | |
width | The width of the frame in pixel (px) | |
height | The height of the frame in pixel (px) |
labels
labels
Each number within labels
represents an individual frame within the data unit. Each frame contains the following:
Key | Description | Notes |
---|---|---|
objects | A list of label objects in this frame | Contains geometric information for object labels |
classifications | A list of classifications applying to the entire frame | Is the same value for all instances of this classification. |
objects
objects
objects
contains label information for all object instances in a frame. A key with the name of the object shape is always present - bounding_box
in the example below. All shapes contain coordinates for each vertex.
The following example shows a single object instance.
Key | Description | Notes |
---|---|---|
name | The object’s name | As specified in the ontology |
color | The color used to draw the object | As specified in the ontology |
shape | The ontology class used to create the object | As specified in the ontology |
value | The name given to the object | |
createdAt | Date and time the object was created | |
createdBy | The email of the user that created this object | |
confidence | The confidence score for this object | A confidence score of 1 is given for all labels created manually. More info can be found here |
objectHash | The specific label’s hash | The ‘hash’ represents a unique identifier |
featureHash | The Ontology object’s hash | Corresponds to the FeatureNodeHash in the ontology |
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
boundingBox | A list containing the coordinates for the bounding box | Refer to the ontology shapes section for more details |
classifications
classifications
classifications
contains all frame level classification information for the video.
The example below shows a single classification instance.
Key | Description | Notes | |
---|---|---|---|
name | The classification’s name | As specified in the ontology | |
value | The classification value | Same as the name | |
createdAt | Time and day the classification was created | ||
createdBy | The email of the user that created this classification | ||
confidence | The confidence score for this classification | A confidence score of 1 is given for all labels created manually. More info can be found here | |
featureHash | The classification instance hash | Corresponds to the FeatureNodeHash in the Ontology | |
lastEditedAt | Time and date of the last time this classification was edited | ||
classificationHash | The classification instance hash hash | ||
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
object_answers
object_answers
object_answers
is a list of objects that have at least one nested attribute and contains information for all attributes. Expanding object_answers
reveals the following:
Key | Description | Notes |
---|---|---|
objectHash | The hash of the object containing the attributes | The ‘hash’ represents a unique identifier |
classifications | A list of attributes related to the object | Not to be confused with classifications as defined in our glossary, which apply to a frame |
name | The attribute name | |
value | The attribute value | Always the same as the name |
answers | The value(s) the attribute(s) were set to | If the attribute was a radio button, the answer is the option selected by the annotator |
featureHash | The attribute’s hash | The ‘hash’ represents a unique identifier |
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
classification_answers
classification_answers
Contains a list of classifications that apply to entire frames or slices. classification_answer
is represented by its hash. Expanding classification_answers
reveals the following:
Key | Description | Notes |
---|---|---|
classificationHash | The classification’s hash | The ‘hash’ represents a unique identifier |
classifications | A list of classifications information | |
name | The classification name | As set in the ontology (Quality in the example above) |
value | The classification value | Always the same as the classification name |
answers | A list of all classification answers | ”answers” refer to the values the classifications were set to. |
name | The name of the classification answer | ”out of focus” in the example above |
value | The classification answer’s value | Always the same as the classification answer’s name |
featureHash | The hash for the particular classification answer | Included in answers |
featureHash | The hash for the particular classification | |
manualAnnotation | ”true” for all manually created labels. “false” for all labels created with automated labeling techniques |
export_history
export_history
The export_history
contains a list of all exports for this data unit, the first entry being the current export. Each instance contains the following:
Key | Description | Notes |
---|---|---|
export_hash | The export instance’s hash | The ‘hash’ represents a unique identifier |
exported_at | Date and time of the export | |
user_email | The email of the user that made this export |
DICOM
The export contains a list of JSON objects, with each JSON object representing a single data unit and containing detailed information for all exported labels.
The following example describes all the keys for a single exported data unit.
Key | Description | Notes |
---|---|---|
label_hash | The Label Row hash | The ‘hash’ represents a unique identifier |
created_at | Time and date the label was created | |
last_edited_at | Time and date the label was last edited | |
dataset_hash | The dataset’s hash | The ‘hash’ represents a unique identifier |
data_type | The data unit’s file format | Always “dicom” in a DICOM series |
is_image_sequence | ”true” when the data unit is an image sequence | Always “null” for a DICOM series |
video_link | Link to the video or image sequence | Always “null” for a DICOM series |
data_units | List of all files the data unit is composed of | Details of the export information for `data_units“ can be found below. |
object_answers | All the object attributes in this data unit | The object attribute are identified using their hash |
classification_answers | All the classifications in a particular data unit | The classification labels are identified using their hash |
object_actions | The number of states a dynamic attribute can be in. | A change in state occurs each time the attribute answer changes. The objectHash within the object_actions is the attribute answer’s ID. |
label_status | Indicates whether the data unit has been labeled. | |
export_history | Contains a record of the export history for the data unit | Exporting labels to confirm export history generates an export history entry. |
export_hash | The hash for this particular export instance | The ‘hash’ represents a unique identifier |
exported_at | The date and time when a particular export instance took place. |
data_units
data_units
The data_units
key contains all files that compose the data unit.
data_units
here refer to individual files that compose a data unit, as defined in our glossary, and are not to be confused with data units elsewhere in the platform. Encord will update this nomenclature soon, but we always communicate changes to all customers first.Key | Description | Notes |
---|---|---|
data_hash | The file’s hash | The ‘hash’ represents a unique identifier |
data_title | The file’s title | |
data_type | The file type | |
data_sequence | The sequence number of this file within the data unit | 0 represents the first file |
labels | A list of all slices contained in the series and any labels on each slice | This contains the label information for each slice. |
metadata | The DICOM series metadata. | Contains the ID for the patient, the study, and the series. |
data_links | Links to all slices within the series, ordered by their sequence number | |
width | The width of the slice in pixel (px) | |
height | The height of the slice in pixel (px) |
labels
labels
Each number within labels
represents an individual slice or frame within the data unit. Each slice or frame contains the following:
Key | Description | Notes |
---|---|---|
objects | A list of label objects on this slice | Contains geometric information for object labels |
classifications | A list of classifications applying to the entire slice or frame | Is the same value for all instances of this classification. |
metadata | Slice specific metadata |
objects
objects
objects
contains label information for all object instances in a frame. A key with the name of the object shape is always present - polygon
in the example below. All shapes contain coordinates for each vertex.
The example below shows a single object instance.
Key | Description | Notes |
---|---|---|
name | The object’s name | As specified in the ontology |
color | The color used to draw the object | As specified in the ontology |
shape | The ontology class used to create the object | As specified in the ontology |
value | The name given to the object | |
polygon | A list containing the x and y coordinates of each vertex on the polygon | Refer to the ontology shapes section for more details |
createdAt | Date and time the object was created | |
createdBy | The email of the user that created this object | |
confidence | The confidence score for this object | A confidence score of 1 is given for all labels created manually. More info can be found here |
objectHash | The specific label’s hash | The ‘hash’ represents a unique identifier |
featureHash | The ontology object’s hash | Corresponds to the FeatureNodeHash in the ontology |
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
classifications
classifications
classifications
contains all frame level classification information for the slice.
The example below shows a single classification instance.
Key | Description | Notes | |
---|---|---|---|
name | The classification’s name | As specified in the ontology | |
value | The classification value | Same as the name | |
createdAt | Time and day the classification was created | ||
createdBy | The email of the user that created this classification | ||
confidence | The confidence score for this classification | A confidence score of 1 is given for all labels created manually. More info can be found here | |
featureHash | The classification instance hash | Corresponds to the FeatureNodeHash in the ontology | |
lastEditedAt | Time and date of the last time this classification was edited | ||
classificationHash | The classification instance hash hash | ||
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
metadata
metadata
Key | Description | Notes |
---|---|---|
dicom_instance_uid | The DICOM instance UID | DICOM tag value (0008,0018). More information can be found here |
multiframe_frame_number | A field indicating the frame number when the JSON contains only a single label | Displays null when each slice has its only expandable labels instance |
file_uri | This slice’s URI | Identifies this slice |
height | The slice’s height (in pixel) | DICOM tag value (0028,0010). More information can be found here |
width | The slice’s width (in pixel) | DICOM tag value (0028,0011). More information can be found here |
metadata
metadata
The slice metadata contains information on the DICOM study, the DICOM series, as well as the patient.
Key | Description | Notes |
---|---|---|
patient_id | The patient ID | DICOM tag value (0010,0020). More information can be found here |
study_uid | The DICOM study’s ID | DICOM tag value (0020,000D). More information can be found here |
series_uid | The DICOM series’ ID | DICOM tag value (0020,000E). More information can be found here |
object_answers
object_answers
object_answers
is a list of objects that have at least one nested attribute and contains information for all attributes. Expanding object_answers
reveals the following:
Key | Description | Notes |
---|---|---|
objectHash | The hash of the object containing the attributes | The ‘hash’ represents a unique identifier |
classifications | A list of attributes related to the object. Includes Dynamic attributes and Relation attributes. | Not to be confused with classifications as defined in our glossary, which apply to a frame |
name | The attribute name | |
value | The attribute value | Always the same as the name |
answers | The value(s) the attribute(s) were set to | If the attribute was a radio button, the answer is the option selected by the annotator |
featureHash | The attribute’s hash | The ‘hash’ represents a unique identifier |
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
classification_answers
classification_answers
classification_answers
a list of frame classifications in which each classification is represented by its hash. Expanding classification_answers
reveals the following:
Key | Description | Notes |
---|---|---|
classificationHash | The classification’s hash | The ‘hash’ represents a unique identifier |
classifications | A list of information about the classification | |
name | The classification name | As set in the ontology (Quality in the example above) |
value | The classification value | Always the same as the classification name |
answers | A list of all classification answers | ”answers” refer to the values the classification were set to. |
name | The name of the classification answer | ”out of focus” in the example above |
value | The classification answer’s value | Always the same as the classification answer’s name |
featureHash | The hash for the particular classification answer | Included in answers |
featureHash | The hash for the particular classification | |
manualAnnotation | true for all manually created labels. false for all labels created with automated labeling techniques |
export_history
export_history
The export_history
contains a list of all exports for this data unit, the first entry being the current export. Each instance contains the following:
Key | Description | Notes |
---|---|---|
export_hash | The export instance’s hash | The ‘hash’ represents a unique identifier |
exported_at | Date and time of the export | |
user_email | The email of the user that made this export |
Audio
The export contains a list of JSON objects, with each JSON object representing a single data unit and containing detailed information for all exported labels.
The example below describes all the keys for a single exported data unit.
Key | Description | Notes |
---|---|---|
label_hash | The Label Row hash | The ‘hash’ represents a unique identifier |
created_at | Time and date the label was created | |
last_edited_at | Time and date the label was last edited | |
dataset_hash | The Dataset’s hash | The ‘hash’ represents a unique identifier |
data_type | The data unit’s file format | Always “video” for videos |
is_image_sequence | ”true” when the data unit is an image sequence | Always “null” for images |
video_link | Contains a private cloud URL for videos | Always “null” for images |
data_units | List of all files the data unit is composed of | Details of the export information for `data_units“ can be found below. |
object_answers | All the attributes in this data unit | The object attributes are identified using their hash |
classification_answers | All the classifications in a particular data unit | The classification labels are identified using their hash |
object_actions | The number of states a dynamic attribute can be in. | A change in state occurs each time the attribute answer changes. The objectHash within the object_actions is the attribute answer’s ID. |
label_status | Indicates whether the data unit has been labeled. | |
export_history | Contains a record of the export history for this data unit | Exporting labels to confirm export history generates an export history entry. |
export_hash | The hash for this particular export instance | The ‘hash’ represents a unique identifier |
exported_at | The date and time when a particular export instance took place. |
classification_answers
classification_answers
classification_answers
a list of frame classifications in which each classification is represented by its hash. Expanding classification_answers
reveals the following:
Key | Description | Notes |
---|---|---|
classificationHash | The classification’s hash | The ‘hash’ represents a unique identifier |
classifications | A list of information about the classification | |
name | The classification name | As set in the ontology (Quality in the example above) |
value | The classification value | Always the same as the classification name |
answers | A list of all classification answers | ”answers” refer to the values the classification were set to. |
name | The name of the classification answer | ”out of focus” in the example above |
value | The classification answer’s value | Always the same as the classification answer’s name |
featureHash | The hash for the particular classification answer | Included in answers |
featureHash | The hash for the particular classification | |
manualAnnotation | true for all manually created labels. false for all labels created with automated labeling techniques | |
range | The time span on which the classification label is applied | Measured in milliseconds (ms) |
data_units
data_units
The data_units
key contains all files that compose the data unit. For a given image there is only ever a single element in this list. This element contains the following information.
data_units
here refer to individual files that compose a data unit, as defined in our glossary, and are not to be confused with data units elsewhere in the platform. Encord will update this nomenclature soon, but we always communicate changes to all customers first.Key | Description | Notes |
---|---|---|
data_hash | The file’s hash | The ‘hash’ represents a unique identifier |
data_title | The file’s title | |
data_type | The file type | |
data_sequence | The sequence number of this file within the data unit | Always 0 for images, as single images are composed of a single file by definition |
labels | A container for the image’s label information | This contains the label information for the image. |
data_link | A link to the file stored in your private cloud | |
width | The width of the image in pixel (px) | |
height | The height of the image in pixel (px) |
object_answers
object_answers
object_answers
contains all the object labels that have at least one nested attribute and contains information for all attributes. Expanding object_answers
reveals the following:
Key | Description | Notes |
---|---|---|
objectHash | The hash of the object containing the attributes | The ‘hash’ represents a unique identifier |
classifications | A list of attributes related to the object. | Not to be confused with classifications as defined in our glossary, which apply to a frame |
name | The attribute name | |
value | The attribute value | Always the same as the name |
answers | The value(s) the attribute(s) were set to | If the attribute was a radio button, the answer is the option selected by the annotator |
featureHash | The attribute’s hash | The ‘hash’ represents a unique identifier |
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
range | The time span on which the object label is applied | Measured in milliseconds (ms) |
Text
The export contains a list of JSON objects, with each JSON object representing a single data unit and containing detailed information for all exported labels.
The example below describes all the keys for a single exported data unit.
Key | Description | Notes |
---|---|---|
label_hash | The Label Row hash | The ‘hash’ represents a unique identifier |
created_at | Time and date the label was created | |
last_edited_at | Time and date the label was last edited | |
dataset_hash | The Dataset’s hash | The ‘hash’ represents a unique identifier |
data_type | The data unit’s file format | Always “video” for videos |
is_image_sequence | ”true” when the data unit is an image sequence | Always “null” for images |
video_link | Contains a private cloud URL for videos | Always “null” for images |
data_units | List of all files the data unit is composed of | Details of the export information for `data_units“ can be found below. |
object_answers | All the attributes in this data unit | The object attributes are identified using their hash |
classification_answers | All the classifications in a particular data unit | The classification labels are identified using their hash |
object_actions | The number of states a dynamic attribute can be in. | A change in state occurs each time the attribute answer changes. The objectHash within the object_actions is the attribute answer’s ID. |
label_status | Indicates whether the data unit has been labeled. | |
export_history | Contains a record of the export history for this data unit | Exporting labels to confirm export history generates an export history entry. |
export_hash | The hash for this particular export instance | The ‘hash’ represents a unique identifier |
exported_at | The date and time when a particular export instance took place. |
classification_answers
classification_answers
classification_answers
a list of frame classifications in which each classification is represented by its hash. Expanding classification_answers
reveals the following:
Key | Description | Notes |
---|---|---|
classificationHash | The classification’s hash | The ‘hash’ represents a unique identifier |
classifications | A list of information about the classification | |
name | The classification name | As set in the ontology (Quality in the example above) |
value | The classification value | Always the same as the classification name |
answers | A list of all classification answers | ”answers” refer to the values the classification were set to. |
name | The name of the classification answer | ”out of focus” in the example above |
value | The classification answer’s value | Always the same as the classification answer’s name |
featureHash | The hash for the particular classification answer | Included in answers |
featureHash | The hash for the particular classification | |
manualAnnotation | true for all manually created labels. false for all labels created with automated labeling techniques | |
range | The frame range on which the classification label is applied |
data_units
data_units
The data_units
key contains all files that compose the data unit. For a given image there is only ever a single element in this list. This element contains the following information.
data_units
here refer to individual files that compose a data unit, as defined in our glossary, and are not to be confused with data units elsewhere in the platform. Encord will update this nomenclature soon, but we always communicate changes to all customers first.Key | Description | Notes |
---|---|---|
data_hash | The file’s hash | The ‘hash’ represents a unique identifier |
data_title | The file’s title | |
data_type | The file type | |
data_sequence | The sequence number of this file within the data unit | Always 0 for images, as single images are composed of a single file by definition |
labels | A container for the image’s label information | This contains the label information for the image. |
data_link | A link to the file stored in your private cloud | |
width | The width of the image in pixel (px) | |
height | The height of the image in pixel (px) |
object_answers
object_answers
object_answers
contains all the object labels that have at least one nested attribute and contains information for all attributes. Expanding object_answers
reveals the following:
Key | Description | Notes |
---|---|---|
objectHash | The hash of the object containing the attributes | The ‘hash’ represents a unique identifier |
classifications | A list of attributes related to the object. | Not to be confused with classifications as defined in our glossary, which apply to a frame |
name | The attribute name | |
value | The attribute value | Always the same as the name |
answers | The value(s) the attribute(s) were set to | If the attribute was a radio button, the answer is the option selected by the annotator |
featureHash | The attribute’s hash | The ‘hash’ represents a unique identifier |
manualAnnotation | A field indicating whether the object was drawn manually or not | true means it was drawn manually, while false means it was created using a model or an automated labeling technique |
range | The frame range on which the object label is applied | |
range_html | Provides detailed information about the specific section of the text file being labeled | |
start | Start point of the label | |
end | End point of the label | |
offset | An integer that specifies the character position within the identified node | For example { "offset": 125 } means the label starts / ends at the 125th character in the node |
Ontology Shapes
Exports contain the Ontology shape coordinates used to create the label.
Bounding Box
Bounding Box
x
and y
represent coordinates of the top-left corner of the box. h
and w
respectively represent the height and width of the box.
Polygon
Polygon
This is a legacy field used by existing customers. We recommend new customers use the polygons
field below.
The polygon
list contains the x
and y
coordinates for all vertices in a simple polygon. For complex polygons, see the polygons
field below.
Polygons
Polygons
Polygons can have complex shapes, including being enclosed in one another, and encompassing separate regions. In each case the polygon’s coordinates are arranged in a different way.
Polyline
Polyline
Polylines contain the x
and y
coordinates for each vertex.
Keypoint
Keypoint
Keypoints are represented in the export using only x
and y
coordinates.
Rotatable Bounding Box
Rotatable Bounding Box
x
and y
represent the coordinates of the top-left corner of the unrotated box. h
and w
respectively represent the height and width of the box, while theta
represents the angle of clockwise rotation of the bounding box about the centre of the box.
Bitmask
Bitmask
The rleString
encodes the Bitmask label, and has to be decoded. See our SDK documentation to learn how to decode an rleString
.
Object primitive
Object primitive
Object primitives are referred to as skeleton
s in the export. Each point on the object primitive is represented in the export using x
and y
coordinates.
Below is an example of an object primitive with 3 points.
Key | Description | Notes |
---|---|---|
name | Name of this point | As set in the Ontology |
color | The hexadecimal color code used to represent this point | As set in the Ontology |
featureHash | The hash for this particular point | the ‘hash’ is a unique identifier |
occluded | This point is marked as occluded | if the point was left on the default setting (visible) this key is omitted |
invisible | This point is marked as invisible | if the point was left on the default setting (visible) this key is omitted |
Exporting Bitmasks
Bitmask labels are exported as rleString
s. See our SDK documentation to learn how to decode an rleString
.
Exporting Labels using the SDK
Go here to learn how to export labels using SDK.
Label Branches
The branch associated with the labels is specified using the branch_name
key.
The main branch is always displayed first and is identified by the following value: