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.
Field | Description | Included |
---|---|---|
data_row | A dictionary containing the fields explained below. | Always |
media_attributes | See Media attributes | Optional |
attachments | See Attachments | Optional |
metadata_fields | See Metadata | Optional |
data_row
data_row
Field | Description | Included |
---|---|---|
id | The ID of the data row. | Always |
global_key | The global key of the data row. | If utilized |
external_id | The external ID of the data row. | If utilized |
row_data | The URL to your cloud-hosted file | Always |
details | A dictionary containing the fields explained below. | Optional |
details
details
Field | Description | Included |
---|---|---|
dataset_id | The ID of the dataset to which the data row belongs. | Always |
created_at | A timestamp that indicates when the data row was created. | Always |
updated_at | A timestamp indicating when the data row was most recently updated. | Always |
created_by | The email address of the user that created the data row. | Always |
projects
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.
labels
labels
Field | Description | Included |
---|---|---|
label_kind | For 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 |
version | Used to track updates made to export formats. At present, the value will always be 1.0.0 . | Always |
id | The ID of the label. | Always |
label_details | A dictionary containing the fields explained below. | Optional |
performance_details | A dictionary containing the fields explained below. | Optional |
annotations | See the annotation export formats broken down by asset type, beginning here with images. | Always |
label_details
label_details
Field | Description | Included |
---|---|---|
created_at | A timestamp indicating when the label was created. | Always |
updated_at | A timestamp indicating when the label was most recently updated. | Always |
created_by | The email address of the user that created the label. | Always |
reviews | Information on the reviews created on this label. Contains a list of dictionaries comprised of the fields explained below. | Always |
reviews
reviews
Field | Description | Included |
---|---|---|
reviewed_at | A timestamp that indicates when the review was created. | Situational |
reviewed_by | The email address of the user that created the review. | Situational |
review_action | The type of review created; either Approve or Reject . | Situational |
performance_details
performance_details
Field | Description | Included |
---|---|---|
seconds_to_create | The number of seconds spent creating the label. | Always |
seconds_to_review | The number of seconds spent reviewing the label. | Always |
skipped | A boolean value expressing whether or not the asset was skipped. A value of true indicates the asset was skipped. | Always |
benchmark_reference_label | The ID of the "gold standard" benchmark label to which this label is compared. | Situational |
benchmark_score | The agreement score between the label and the associated benchmark label. | Situational |
consensus_score | The agreement score between the label and the associated consensus labels made on the same data row. | Situational |
consensus_label_count | The number of labels created on this data row in this project. | Situational |
consensus_labels | The IDs of the labels created on this data row in this project. | Situational |
project_details
project_details
Field | Description | Included |
---|---|---|
ontology_id | The ID of the ontology connected to the project. | Always |
batch_id | The ID of the batch in which the data row was sent to the project. | Always |
priority | The priority assigned to the batch. | Always |
consensus_expected_label_count | The number of labels that were expected to be created on this data row according to the consensus settings. | Always |
workflow_history | Information 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
workflow_history
Field | Description | Included |
---|---|---|
action | The action that was performed on the data row in this specific step. | Always |
created_at | A timestamp that indicates when this action on the data row occurred. | Always |
created_by | The email address of the user that performed this action. | Always |
previous_task_name | The name of the workflow task in which the data row began this action. | Situational |
previous_task_id | The ID of the workflow task in which the data row began this action. | Situational |
next_task_name | The name of the workflow task in which the data row concluded this action. | Situational |
next_task_id | The ID of the workflow task in which the data row concluded this action. | Situational |
models
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.
Field | Description | Included |
---|---|---|
model_name | The name of the model in which the data row appears. | Always |
model_runs | A dictionary where the keys are the IDs of the model runs in which the data row appears. | Always |
model_runs
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.
Field | Description | Included |
---|---|---|
model_run_name | The name of the model run. | Always |
annotation_group_id | A unique ID for the data row specific to the context of the model run. | Always |
labels | Ground 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 |
predictions | A dictionary containing the fields explained below. |
predictions
predictions
Field | Description | Included |
---|---|---|
label_kind | For 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 |
version | Used to track updates made to export formats. At present, the value will always be 1.0.0 . | Always |
id | The ID of the set of predictions. | Always |
annotations | See the annotation export formats broken down by asset type, beginning here with images. | Always |
Updated 19 days ago