An Object-type annotation used for labeling characters in unstructured text files.

Import

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

Parameter

Asset type

Required

Description

uuid

Text

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

Text

Yes

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

dataRow.id

Text

Yes

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

location.start

Text

Yes

The index of the first character in the Entity annotation. Assumes start-index inclusion.

location.end

Text

Yes

The index of the last character in the Entity annotation. Assumes end-index exclusion (character 128 in the example below would be excluded from the Entity annotation).

{ 
    "uuid": "9fd9a92e-2560-4e77-81d4-b2e955800092", 
    "schemaId": "ck8kukafkqx1a0880iczbrqym",
    "dataRow": { 
        "id": "ck1s02fqxm8fi0757f0e6qtdc" 
    }, 
    "location": { 
        "start": 67, 
        "end": 128 
    }
}

Export

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

Parameter

Asset type

Description

schemaId

Text

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

featureId

Text

ID of the annotation.

title

Text

Name of the annotation in the ontology.

color

Text

Color of the annotation in the ontology.

version

Text

Export format version.

format

Text

Export format specification.

data.location.start

Text

The index of the first character in the Entity annotation. Assumes start-index inclusion.

data.location.end

Text

The index of the last character in the Entity annotation. Assumes end-index exclusion.

{
    "featureId": "ck8kulppv000x0yf8pqpqqin4",
    "schemaId": "ck8kukafkqx1a0880iczbrqym",
    "title": "Entity type A",
    "value": "entity_type_a",
    "color": "#8000FF",
    "version": 1,
    "format": "text.location",
    "data": {
        "location": {
            "start": 67,
            "end": 128
        }
    }
}