Checklist

Checklist classifications can be applied at the global level and can be nested within an object-type annotation.

Import

When you import Checklist classifications via the Model-assisted labeling workflow, your JSON file must contain the following information for each Checklist.

Parameter

Asset type

Required

Description

uuid

Image
Video
Text
Audio
Tiled imagery

Yes

A user-generated UUID for each annotation. If you import an annotation to a Data Row and there is already an imported annotation with the same uuid on that Data Row, the latest import will override the previous one. The uuid must be 128 bits (32 characters). The following formats are supported:

  • A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11

  • {a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11}

  • a0eebc999c0b4ef8bb6d6bb9bd380a11

  • a0ee-bc99-9c0b-4ef8-bb6d-6bb9-bd38-0a11

  • {a0eebc99-9c0b4ef8-bb6d6bb9-bd380a11}

schemaId

Image
Video
Text
Audio
Tiled imagery

Yes

The ID of the schema that contains all of the information needed for rendering your annotation.

dataRow.id

Image
Video
Text
Audio
Tiled imagery

Yes

The ID of the Data Row where you want to attach the imported annotations.

answers.schemaId

Image
Video
Text
Audio
Tiled imagery

Yes

The ID of the Checklist answer schema. Checklist can have multiple correct answers so "answers" is plural.

frames.start

Video

Yes

The first frame you wish to include in the checklist classification.

frames.end

Video

Yes

The last frame you wish to include in the checklist classification.

// Global classification
{
    "uuid": "fb72782d-f6ed-43ba-8677-77b03197392d",
    "dataRow": {
        "id": "ckd1299m8cqbs0cq43mju1bvp"
    },
    "schemaId": "ckd1295hc00640z0uapvm1xbd", // Checklist question
    "answers": [
        {
            "schemaId": "ckd1295jn00760z0u01hw4yz5" // Checklist answer
        },
        {
            "schemaId": "ckd1295hh006g0z0ucbxgfgec" // Checklist answer
        }
    ]
}

// Nested classification
{
    "uuid": "532953e6-746f-4d74-945d-b4a9c2786479",
    "schemaId": "ckshluz7h7d9b0yb60biaasya",
    "dataRow": {
        "id": "ckshkj1vj4rsq0yvubkoe76vi"
    },
    "bbox": {
        "top": 57,
        "left": 209,
        "height": 216,
        "width": 152
    },
    "classifications": [
        {
            "schemaId": "ckshluz847d9d0yb65oqhfg65", // Nested checklist question
            "answers": [
                    {
                        "schemaId": "ckshluz8r7d9j0yb6d9l45o1b" // Nested checklist answer
                    },
                    {
                        "schemaId": "ckshluz8r7d9j0yb6d9l45opl" // Nested checklist answer
                    },                  
            ]
        }
    ]
}
// Global classification only
{
    "schemaId": "ckd1295hc00640z0uapvm1xbd",  // question schema id
    "uuid": "fb72782d-f6ed-43ba-8677-77b03197392d",
    "dataRow": {
    "id": "ckd1299m8cqbs0cq43mju1bvp"
    },
    "answers": [
        {
            "schemaId": "ckd1295jn00760z0u01hw4yz5" // answer schema id
        }, {
            "schemaId": "ckd1295hh006g0z0ucbxgfgec" // answer schema id
        }
    ],
    "frames": [
        {
            "start": 7,
            "end": 13,
        },
        {
            "start": 18,
            "end": 19,
        }
    ]
}
// Global classification
{
    "uuid": "fb72782d-f6ed-43ba-8677-77b03197392d",
    "dataRow": {
        "id": "ckd1299m8cqbs0cq43mju1bvp"
    },
    "schemaId": "ckd1295hc00640z0uapvm1xbd", // Checklist question
    "answers": [
        {
            "schemaId": "ckd1295jn00760z0u01hw4yz5" // Checklist answer
        },
        {
            "schemaId": "ckd1295hh006g0z0ucbxgfgec" // Checklist answer
        }
    ]
}

// Nested classification
{ 
    "uuid": "9fd9a92e-2560-4e77-81d4-b2e955800092", 
    "schemaId": "ck8kukafkqx1a0880iczbrqym",
    "dataRow": { 
        "id": "ck1s02fqxm8fi0757f0e6qtdc" 
    }, 
    "location": { 
        "start": 67, 
        "end": 128 
    },
    "classifications": [
        {
            "schemaId": "ckshluz847d9d0yb65oqhfg65", // Nested checklist question
                        "answers": [
                        {
                            "schemaId": "ckd1295jn00760z0u01hw4yz5" // Checklist answer
                        },
                        {
                            "schemaId": "ckd1295hh006g0z0ucbxgfgec" // Checklist answer
                        }
                    ]
        }
    ]
}
// Global classification
{
    "uuid": "fb72782d-f6ed-43ba-8677-77b03197392d",
    "dataRow": {
        "id": "ckd1299m8cqbs0cq43mju1bvp"
    },
    "schemaId": "ckd1295hc00640z0uapvm1xbd", // Checklist question
    "answers": [
        {
            "schemaId": "ckd1295jn00760z0u01hw4yz5" // Checklist answer
        },
        {
            "schemaId": "ckd1295hh006g0z0ucbxgfgec" // Checklist answer
        }
    ]
}

// Nested classification
{
    "uuid": "532953e6-746f-4d74-945d-b4a9c2786479",
    "schemaId": "ckshluz7h7d9b0yb60biaasya",
    "dataRow": {
        "id": "ckshkj1vj4rsq0yvubkoe76vi"
    },
    "bbox": {
        "top": 57,
        "left": 209,
        "height": 216,
        "width": 152
    },
    "classifications": [
        {
            "schemaId": "ckshluz847d9d0yb65oqhfg65", // Nested checklist question
            "answers": [
                    {
                        "schemaId": "ckshluz8r7d9j0yb6d9l45o1b" // Nested checklist answer
                    },
                    {
                        "schemaId": "ckshluz8r7d9j0yb6d9l45opl" // Nested checklist answer
                    },                  
            ]
        }
    ]
}
// Global classification
{
    "uuid": "fb72782d-f6ed-43ba-8677-77b03197392d",
    "dataRow": {
        "id": "ckd1299m8cqbs0cq43mju1bvp"
    },
    "schemaId": "ckd1295hc00640z0uapvm1xbd", // Checklist question
    "answers": [
        {
            "schemaId": "ckd1295jn00760z0u01hw4yz5" // Checklist answer
        },
        {
            "schemaId": "ckd1295hh006g0z0ucbxgfgec" // Checklist answer
        }
    ]
}

// Nested classification
{
    "uuid": "532953e6-746f-4d74-945d-b4a9c2786479",
    "schemaId": "ckshluz7h7d9b0yb60biaasya",
    "dataRow": {
        "id": "ckshkj1vj4rsq0yvubkoe76vi"
    },
    "bbox": {
        "top": 57,
        "left": 209,
        "height": 216,
        "width": 152
    },
    "classifications": [
        {
            "schemaId": "ckshluz847d9d0yb65oqhfg65", // Nested checklist question
            "answers": [
                    {
                        "schemaId": "ckshluz8r7d9j0yb6d9l45o1b" // Nested checklist answer
                    },
                    {
                        "schemaId": "ckshluz8r7d9j0yb6d9l45opl" // Nested checklist answer
                    },                  
            ]
        }
    ]
}

Export

When you export your Checklist classifications from Labelbox, the export file will contain the following information for each Checklist.

Parameter

Asset type

Description

featureId

Image
Video
Text
Audio
Tiled imagery

ID of the classification question in the ontology.

schemaId

Image
Video
Text
Audio
Tiled imagery

ID of the schema that contains all of the structural information for the classification question.

title

Image
Video
Text
Audio
Tiled imagery

Text that appears as the classification question.

value

Image
Video
Text
Audio
Tiled imagery

Name of the classification question in the Labelbox database.

answers.featureId

Image
Video
Text
Audio
Tiled imagery

ID of the classification answer in the ontology.

answers.schemaId

Image
Video
Text
Audio
Tiled imagery

ID of the schema that contains the structural information for the classification answer.

answers.title

Image
Video
Text
Audio
Tiled imagery

Text that appears as the classification answer.

answers.value

Image
Video
Text
Audio
Tiled imagery

Name of the classification answer in the Labelbox database.

answers.keyframe

Video

When keyframe is true, it means that a labeler created or made an adjustment to the annotation on that frame. When keyframe is false, it means the annotation was auto-populated or interpolated on that frame.

{
    "featureId": "ckmuzkagt00033g68c164geo8",
    "schemaId": "ckmuzjtfa64bo0y831j83ep9p",
    "title": "Checklist question",
    "value": "checklist_question",
    "answers": [
        {
            "featureId": "ckmuzkagt00023g68jomt0767",
            "schemaId": "ckmuzjtlr64c10y83gazv0v13",
            "title": "Correct checklist answer",
            "value": "correct_checklist_answer"
        }
    ]
}
{
    "featureId": "cknp36ay800003g68b908p4ah",
    "schemaId": "cknp35stw05w90yct45j4c7h6",
    "title": "Checklist question",
    "value": "checklist_question",
    "answers": [
        {
            "featureId": "cknp36ay800013g685e5ztvmp",
            "schemaId": "cknp35svp05x10yct13lv37rl",
            "title": "Correct checklist answer",
            "value": "correct_checklist_answer",
            "keyframe": true
        },
        {
            "featureId": "cknp36bdt00023g68zylk8kwx",
            "schemaId": "cknp35svp05x30yct898ga2pq",
            "title": "Correct checklist answer",
            "value": "correct_checklist_answer",
            "keyframe": false
        }
    ]
}
{
    "featureId": "ckmuzkagt00033g68c164geo8",
    "schemaId": "ckmuzjtfa64bo0y831j83ep9p",
    "title": "Checklist question",
    "value": "checklist_question",
    "answers": [
        {
            "featureId": "ckmuzkagt00023g68jomt0767",
            "schemaId": "ckmuzjtlr64c10y83gazv0v13",
            "title": "Correct checklist answer",
            "value": "correct_checklist_answer"
        }
    ]
}
{
    "featureId": "ckmuzkagt00033g68c164geo8",
    "schemaId": "ckmuzjtfa64bo0y831j83ep9p",
    "title": "Checklist question",
    "value": "checklist_question",
    "answers": [
        {
            "featureId": "ckmuzkagt00023g68jomt0767",
            "schemaId": "ckmuzjtlr64c10y83gazv0v13",
            "title": "Correct checklist answer",
            "value": "correct_checklist_answer"
        }
    ]
}
{
    "featureId": "ckmuzkagt00033g68c164geo8",
    "schemaId": "ckmuzjtfa64bo0y831j83ep9p",
    "title": "Checklist question",
    "value": "checklist_question",
    "answers": [
        {
            "featureId": "ckmuzkagt00023g68jomt0767",
            "schemaId": "ckmuzjtlr64c10y83gazv0v13",
            "title": "Correct checklist answer",
            "value": "correct_checklist_answer"
        }
    ]
}

Did this page help you?