A structured and hierarchical representation of a set of Annotation schemas used for one or more projects.

📘

Ontology annotation limit

Maximum of 1,000 annotation schemas per ontology.

Parameter

Description

tools

Category that represents the Object-type annotations (Bounding box, Segmentation mask, Polygon, Point, Polyline, Entity).

classifications

Category that represents the Classification-type annotations (Radio, Checklist, Free-form text, Dropdown).

tools.schemaNodeId / classifications.schemaNodeId

The schema node contains information such as the annotation's place in the ontology hierarchy, which ontology the annotation belongs to, and which feature schema (AKA annotation schema) it references. See Ontology management to learn more.

tools.featureSchemaId / classifications.featureSchemaId

The feature schema (AKA annotation schema) holds information like name, kind, and color. See Ontology management to learn more.

tools.required / classifications.required

Indicates whether the annotation is required in order for the labeler to submit the Label.

tools.name

Text that appears as the name of the Object-type annotation.

tools.tool

Tool used to create the Object-type annotation (`rectangle, superpixel, point, line, or polygon).

tools.color

Color of the Object-type annotation.

classifications.instructions

Text that appears as the Classification question.

classifications.name

Labelbox internal name of the Classification question.

classifications.type

Classification type (radio, checklist, dropdown, or `text``).

classifications.options.label

Text that appears as a Classification answer option.

classifications.options.value

Labelbox internal name of the Classification answer option.

{
    "ontology": {
        "normalized": {
            "tools": [
                {
                    "schemaNodeId": "ckn94hhay0ops0y69hb9ghaxt",
                    "featureSchemaId": "ckn94hhay0opt0y6993fb64bl",
                    "required": false,
                    "name": "Sample object 1",
                    "tool": "rectangle",
                    "color": "#ffb31c",
                    "classifications": []
                },
                {
                    "schemaNodeId": "ckn94hhay0opu0y69dfgo25ab",
                    "featureSchemaId": "ckn94hhay0opv0y69fbpg76bs",
                    "required": false,
                    "name": "Sample object 2",
                    "tool": "superpixel",
                    "color": "#FF34FF",
                    "classifications": []
                }
            ],
            "classifications": [
                {
                    "schemaNodeId": "ckn94hhax0opq0y6967ygglnq",
                    "featureSchemaId": "ckn94hhax0opr0y6936u2db78",
                    "required": true,
                    "instructions": "Is it daytime?",
                    "name": "is_it_daytime?",
                    "type": "radio",
                    "options": [
                        {
                            "schemaNodeId": "ckn94hhbn0opw0y6950qq18yo",
                            "featureSchemaId": "ckn94hhbn0opx0y69bwh6b3je",
                            "label": "yes",
                            "value": "yes"
                        },
                        {
                            "schemaNodeId": "ckn94hhbo0opy0y698o9kb178",
                            "featureSchemaId": "ckn94hhbo0opz0y69d5uv16fn",
                            "label": "no",
                            "value": "no"
                        }
                    ]
                }
            ]
        }
    }
}
{
    "ontology": {
        "normalized": {
            "tools": [
                {
                    "schemaNodeId": "ckkojo9m907330yca3ed5ge6m",
                    "featureSchemaId": "ckkojo9m907340ycaeny0dsvi",
                    "required": false,
                    "name": "Bounding box",
                    "tool": "rectangle",
                    "color": "#1CE6FF",
                    "classifications": [
                        {
                            "schemaNodeId": "cklmow53001ac0ycu0zy24atw",
                            "featureSchemaId": "cklmow53001ad0ycu2i6l75jc",
                            "required": false,
                            "instructions": "Visibility",
                            "name": "visibility",
                            "type": "radio",
                            "options": [
                                {
                                    "schemaNodeId": "cklmow54a01aj0ycudrzm7lh8",
                                    "featureSchemaId": "cklmow54a01ak0ycuhm2p474y",
                                    "label": "0",
                                    "value": "0"
                                },
                                {
                                    "schemaNodeId": "cklmow54b01al0ycu7fhn2zlo",
                                    "featureSchemaId": "cklmow54b01am0ycu3t6p311r",
                                    "label": "1",
                                    "value": "1"
                                }
                            ]
                        }
                    ]
                }
            ],
            "classifications": [
                {
                    "schemaNodeId": "ckkojo9m8072z0yca7rlth7xq",
                    "featureSchemaId": "ckkojo9m807300ycaglf19mj4",
                    "required": false,
                    "instructions": "Sample radio question",
                    "name": "sample_radio_question",
                    "type": "radio",
                    "options": [
                        {
                            "schemaNodeId": "ckkojo9o6073d0yca8nai9gz4",
                            "featureSchemaId": "ckkojo9o6073e0yca451e7ach",
                            "label": "Option 1",
                            "value": "option_1",
                            "options": [
                                {
                                    "schemaNodeId": "cklmtbyuj11q90yao3ko3h8lk",
                                    "featureSchemaId": "cklmtbyuj11qa0yao0zn2d9sg",
                                    "required": false,
                                    "instructions": "Nested radio classification",
                                    "name": "nested_radio_classification",
                                    "type": "radio",
                                    "options": [
                                        {
                                            "schemaNodeId": "cklmtbyv711qj0yao2yhlh4tg",
                                            "featureSchemaId": "cklmtbyv711qk0yaogyhsddok",
                                            "label": "Option 1a",
                                            "value": "option_1a"
                                        },
                                        {
                                            "schemaNodeId": "cklmtbyv711ql0yao3x718wp9",
                                            "featureSchemaId": "cklmtbyv711qm0yaoe0vo0kul",
                                            "label": "Option 1b",
                                            "value": "option_1b"
                                        }
                                    ]
                                }
                            ]
                        },
                        {
                            "schemaNodeId": "ckkojo9o6073f0ycae6kudlj9",
                            "featureSchemaId": "ckkojo9o6073g0ycafpjw964n",
                            "label": "Option 2",
                            "value": "option_2"
                        }
                    ]
                },
                {
                    "schemaNodeId": "ckkojo9m807310yca76dt4bz7",
                    "featureSchemaId": "cklmtbytx11q50yao4vzo4v4d",
                    "required": false,
                    "instructions": "Checklist question",
                    "name": "checklist_question",
                    "type": "checklist",
                    "options": [
                        {
                            "schemaNodeId": "ckkojo9o507370ycagr048zxk",
                            "featureSchemaId": "cklmtbyur11qg0yaobj0n8yky",
                            "label": "Option 1",
                            "value": "option_1"
                        },
                        {
                            "schemaNodeId": "ckkojo9o507390yca5wncesjj",
                            "featureSchemaId": "cklmtbyus11qh0yaodc8gb9s9",
                            "label": "Option 2",
                            "value": "option_2"
                        },
                        {
                            "schemaNodeId": "ckkojo9o5073b0yca2usxgag6",
                            "featureSchemaId": "cklmtbyus11qi0yao94m1cm32",
                            "label": "Option 3",
                            "value": "option_3"
                        }
                    ]
                }
            ]
        }
    }
}
{
    "ontology": {
        "normalized": {
            "tools": [
                {
                    "schemaNodeId": "ckkd4yl0e0le20ycl6l2d6s8p",
                    "featureSchemaId": "ckkd4yl0e0le30ycl7i4944l5",
                    "required": false,
                    "name": "A",
                    "tool": "named-entity",
                    "color": "#1CE6FF",
                    "classifications": []
                }
            ],
            "classifications": [
                {
                    "schemaNodeId": "cknp3ctst06np0yct5jev4ore",
                    "featureSchemaId": "cknp3ctst06nq0ycte8icc2l3",
                    "required": false,
                    "instructions": "Radio",
                    "name": "radio",
                    "type": "radio",
                    "options": [
                        {
                            "schemaNodeId": "cknp3cttx06od0yctg909cae2",
                            "featureSchemaId": "cknp3cttx06oe0yct3f0d6pmz",
                            "label": "Yes",
                            "value": "yes"
                        },
                        {
                            "schemaNodeId": "cknp3ctty06of0yctf5qlbjqa",
                            "featureSchemaId": "cknp3ctty06og0yct8xl6ekgm",
                            "label": "No",
                            "value": "no"
                        }
                    ]
                },
                {
                    "schemaNodeId": "cknp3ctsu06nr0yct077z4b1k",
                    "featureSchemaId": "cknp3dfo51h900y9y5j10g7hg",
                    "required": false,
                    "instructions": "Checklist",
                    "name": "checklist",
                    "type": "checklist",
                    "options": [
                        {
                            "schemaNodeId": "cknp3cttq06ny0yct6ox0hy4g",
                            "featureSchemaId": "cknp3dfv21h9a0y9yagz41wtq",
                            "label": "1",
                            "value": "1"
                        },
                        {
                            "schemaNodeId": "cknp3cttr06o00yct90l6fnyq",
                            "featureSchemaId": "cknp3dfv21h9b0y9yg34i8xru",
                            "label": "2",
                            "value": "2"
                        },
                        {
                            "schemaNodeId": "cknp3cttr06o20yct49c75ezo",
                            "featureSchemaId": "cknp3dfv31h9c0y9y6rzcctxa",
                            "label": "3",
                            "value": "3"
                        }
                    ]
                },
                {
                    "schemaNodeId": "cknp3ctsu06nt0yct3x9icvyf",
                    "featureSchemaId": "cknp3ctsu06nu0yctf0v5gzij",
                    "required": false,
                    "instructions": "Free-form text",
                    "name": "free-form_text",
                    "type": "text",
                    "options": []
                }
            ],
            "projectInstructions": "https://storage.labelbox.com/ck52rvx0mpw4g0766wgqvjtl9%2Fd1bc1a95-66d6-0738-0827-6b9ca0ff6554-labelbox-python-reference.pdf?Expires=1611792936339&KeyName=labelbox-assets-key-1&Signature=OPUcrEiPLjbYIGnhRy71j-E_7Mo"
        }
    }
}