Taxonomy
The Taxonomy tag is used to create one or more hierarchical classifications, storing both choice selections and their ancestors in the results. Use for nested classification tasks with the Choice tag.
Use with the following data types: audio, image, HTML, paragraphs, text, time series, video.
Parameters
| Param | Type | Default | Description |
|---|---|---|---|
| name | string |
Name of the element | |
| toName | string |
Name of the element that you want to classify | |
| [apiUrl] | string |
URL to fetch taxonomy from remote source; API should accept optional array path param: apiUrl?path[]=root&path[]=child1 to return only nested children of child1 node2 |
|
| [leafsOnly] | boolean |
false |
Allow annotators to select only leaf nodes of taxonomy |
| [showFullPath] | boolean |
false |
Whether to show the full path of selected items |
| [pathSeparator] | string |
"/" |
Separator to show in the full path (default is “ / “) |
| [maxUsages] | number |
Maximum number of times a choice can be selected per task | |
| [maxWidth] | number |
Maximum width for dropdown | |
| [minWidth] | number |
Minimum width for dropdown | |
| [required] | boolean |
false |
Whether taxonomy validation is required |
| [requiredMessage] | string |
Message to show if validation fails | |
| [placeholder=] | string |
What to display as prompt on the input | |
| [perRegion] | boolean |
Use this tag to classify specific regions instead of the whole object | |
| [perItem] | boolean |
Use this tag to classify specific items inside the object instead of the whole object1 |
Example
Labeling configuration for providing a taxonomy of choices in response to a passage of text
<View>
<Taxonomy name="media" toName="text">
<Choice value="Online">
<Choice value="UGC" />
<Choice value="Free" />
<Choice value="Paywall">
<Choice value="NY Times" />
<Choice value="The Wall Street Journal" />
</Choice>
</Choice>
<Choice value="Offline" />
</Taxonomy>
<Text name="text" value="You'd never believe what he did to the country" />
</View>