Export v2 Glossary (beta)

Explore key terms from the exports v2 format.

Export v2 gives you more flexibility and control to retrieve the most valuable information from your projects. You can now select and export a subselection of the data rows of most interest based on your predefined or new parameters in the Data Rows tab. You can also export more detailed information from these data rows, and include or exclude relevant attributes in your export. We also simplified and standardized the annotation formats.

We encourage you to use export v2 over export v1. We are collecting feedback during this beta period. The final format of the export JSON is subject to minor changes until the end of June 2023. We will continue to support export v1 and its existing features.

For more details on how to create exports, along with complete samples, please view the following pages:

Below is a glossary of the fields that can appear in an export.

Export fields

Export v2 aligns with the data-row-centric paradigm, thus every line, regardless of the export time, will include information on each included data row.

FieldDescriptionIncluded
data_rowA dictionary containing the fields explained below.Always
media_attributesSee Media attributesOptional
attachmentsSee AttachmentsOptional
metadata_fieldsSee MetadataOptional

data_row

FieldDescriptionIncluded
idThe ID of the data row.Always
global_keyThe global key of the data row.If utilized
external_idThe external ID of the data row.If utilized
row_dataThe URL to your cloud-hosted fileAlways
detailsA dictionary containing the fields explained below.Optional

details

FieldDescriptionIncluded
dataset_idThe ID of the dataset to which the data row belongs.Always
created_atA timestamp that indicates when the data row was created.Always
updated_atA timestamp indicating when the data row was most recently updated.Always
created_byThe email address of the user that created the data row.Always

projects

The projects field contains a dictionary in which the keys are project IDs and the values consist of the fields explained below.

In a project-based export, there will only be a singular project ID in this dictionary. Yet, when exporting from the Catalog, consider that a data row may have been labeled in multiple projects, and thus the dictionary will have multiple keys.

Project IDs are used in favor of project names in order to enforce uniqueness.

FieldDescriptionIncluded
project_nameThe name of the project in which the data row was labeled.Always
labelsContains a list of dictionaries comprised of the fields explained below.Always
project_detailsA dictionary containing the fields explained below.Optional

labels

FieldDescriptionIncluded
label_kindFor labels made on assets of most media types, the value will be Default.

Alternatively, labels made on frame-based assets will have a value of either Video or DICOM, depending on the media type.
Always
versionUsed to track updates made to export formats. At present, the value will always be 1.0.0.Always
idThe ID of the label.Always
label_detailsA dictionary containing the fields explained below.Optional
performance_detailsA dictionary containing the fields explained below.Optional
annotationsSee the annotation export formats broken down by asset type, beginning here with images.Always

label_details

FieldDescriptionIncluded
created_atA timestamp indicating when the label was created.Always
updated_atA timestamp indicating when the label was most recently updated.Always
created_byThe email address of the user that created the label.Always
reviewsInformation on the reviews created on this label. Contains a list of dictionaries comprised of the fields explained below.Always

reviews

FieldDescriptionIncluded
reviewed_atA timestamp that indicates when the review was created.Situational
reviewed_byThe email address of the user that created the review.Situational
review_actionThe type of review created; either Approve or Reject.Situational

performance_details

FieldDescriptionIncluded
seconds_to_createThe number of seconds spent creating the label.Always
seconds_to_reviewThe number of seconds spent reviewing the label.Always
skippedA boolean value expressing whether or not the asset was skipped. A value of true indicates the asset was skipped.Always
benchmark_reference_labelThe ID of the "gold standard" benchmark label to which this label is compared.Situational
benchmark_scoreThe agreement score between the label and the associated benchmark label.Situational
consensus_scoreThe agreement score between the label and the associated consensus labels made on the same data row.Situational
consensus_label_countThe number of labels created on this data row in this project.Situational
consensus_labelsThe IDs of the labels created on this data row in this project.Situational

project_details

FieldDescriptionIncluded
ontology_idThe ID of the ontology connected to the project.Always
batch_idThe ID of the batch in which the data row was sent to the project.Always
priorityThe priority assigned to the batch.Always
consensus_expected_label_countThe number of labels that were expected to be created on this data row according to the consensus settings.Always
workflow_historyInformation on the progression of the labeled data row through the project's workflow. Contains a list of dictionaries comprised of the fields explained below.Always

workflow_history

FieldDescriptionIncluded
actionThe action that was performed on the data row in this specific step.Always
created_atA timestamp that indicates when this action on the data row occurred.Always
created_byThe email address of the user that performed this action.Always
previous_task_nameThe name of the workflow task in which the data row began this action.Situational
previous_task_idThe ID of the workflow task in which the data row began this action.Situational
next_task_nameThe name of the workflow task in which the data row concluded this action.Situational
next_task_idThe ID of the workflow task in which the data row concluded this action.Situational

models

The models field contains a dictionary in which the keys are model IDs and the values consist of the model_name and a dictionary of model_runs.

In a model-based export, there will only be a singular model ID in this dictionary. Yet, when exporting from the Catalog, consider that a data row may be included in multiple models, and thus the dictionary will have multiple keys.

Model IDs are used in favor of model names in order to enforce uniqueness.

FieldDescriptionIncluded
model_nameThe name of the model in which the data row appears.Always
model_runsA dictionary where the keys are the IDs of the model runs in which the data row appears.Always

model_runs

The model_runs field contains a dictionary in which the keys are model run IDs and the values consist of the fields explained below.

Model run IDs are used in favor of model run names in order to enforce uniqueness.

FieldDescriptionIncluded
model_run_nameThe name of the model run.Always
annotation_group_idA unique ID for the data row specific to the context of the model run.Always
labelsGround truth annotations can optionally be sent to a model run as labels.

If present, the labels will appear in the same format as in a project-based export described above, with the exception of the optional label_details and performance_details.
Situational
predictionsA dictionary containing the fields explained below.

predictions

FieldDescriptionIncluded
label_kindFor labels made on assets of most media types, the value will be Default.

Alternatively, labels made on frame-based assets will have a value of either Video or DICOM, depending on the media type.
Always
versionUsed to track updates made to export formats. At present, the value will always be 1.0.0.Always
idThe ID of the set of predictions.Always
annotationsSee the annotation export formats broken down by asset type, beginning here with images.Always