NamedEntityRecognitionLabel

NamedEntityRecognitionLabel objects define the taxonomy of labels to use to annotate spans of text.

Parameter

Type

Default

Description

name*

string

A unique identifier for this label.

display_name

string

name

An alias for this label to display to taskers.

description

string

undefined

A description of what this label should represent. Displayed to taskers to improve quality.

children

array_object

undefined

An array of NamedEntityRecognitionLabel objects to group underneath this label. Specifying this field causes this label itself to no longer be used for labeling text spans.

attributes (optional)

object

undefined

NamedEntityRecognitionAttribute objects define form fields for individual annotations.

Parameter

Type

Description

type

string

Only 'select' for now.

options

array_object

List of select option objects.

display_name

string

Optional display name.

description

string

Optional description.

AttributeSelectOption objects define possible values for select attributes.

Parameter

Type

Description

value

string

The value that will show up in the response if this option is selected.

display_name

string

Optional display name if different from the value.