Taxonomy

Perform classification tasks within the context of a defined taxonomy or hierarchy of choices.

Labeling configuration

You can approach your taxonomy definitions in several ways, including:

• User-defined labels - Use the Choice tag to manually define your taxonomy. This is the default configuration in the template.
• External taxonomy - Define your taxonomy using a JSON-formatted file or API. This option provides better performance for large scale taxonomies.

In both options, the following tags are required:

• The labeling configuration must be wrapped in View tags.

• Include the data type you are working with. The example template is classifying text, but the Taxonomy tag can also be used with audio, image, HTML, paragraphs, time series, and video.

  <Text name="text" value="$text"/>

• Use the Taxonomy tag to present the user with hierarchical options.

  <Taxonomy name="taxonomy" toName="text">

Taxonomy as a labeling tool

Typically, the <Taxonomy> tag is used to perform classification tasks. However, if you set labeling="true", you can apply your taxonomy choices to regions within text. This can be especially useful for NER projects.

Note that the labeling parameter is only supported when using <Text> or <HyperText> object tags.

Taxonomies defined using nested Choice tags

Use the Choice tag to specify the taxonomy. Nest choices under Choice tags to create layers in the taxonomy.

<View>
  <Text name="text" value="$text"/>
  <Taxonomy name="taxonomy" toName="text">
    <Choice value="Archaea" />
    <Choice value="Bacteria" />
    <Choice value="Eukarya">
      <Choice value="Human" />
      <Choice value="Opossum" />
      <Choice value="Extraterrestrial" />
    </Choice>
  </Taxonomy>
</View>

Taxonomies defined using a remote source - Beta 🧪

You can modify the template to call an external taxonomy. There are two types of external taxonomies:

• Taxonomies defined in JSON file.
• Taxonomies defined in an API.

To call an external taxonomy, remove the Choice tags and specify the apiUrl parameter:

<Taxonomy name="taxonomy" toName="text" apiUrl="<YOUR_TAXONOMY_URL>" />

For example:

<View>
  <Text name="text" value="$text"/>
  <Taxonomy name="taxonomy" toName="text" apiUrl="https://cities-nu.vercel.app/full" />
</View>

The remote taxonomy must use JSON with items in the following format:

Securing the taxonomy

The apiUrl must be accessible to Label Studio. You can accomplish this in several ways:

• The URL is public.

• The URL is hosted on a local server.

• The URL includes the username and password, for example http://username:password@example.com/.

  While in this case the taxonomy itself is not publicly accessible, anyone with access to view the project’s labeling configuration would be able to see the credentials. Annotators would also be able to view the credentials through the Network tab in their browser’s developer tools.

• The URL points to your private cloud environment. This is the most secure option. See Using cloud storage with an external taxonomy below.

Using cloud storage with an external taxonomy

1. Save your taxonomy in a separate bucket from your task data.

   If you are unable to use a separate bucket for your taxonomy, see the workaround below.

2. Follow these instructions to set up cloud storage for Label Studio. This should be a separate connection from your other storage connections.

   note

   Do not sync this storage connection. If you do, you will need to delete the task that is automatically created when syncing the taxonomy.

3. When configuring your labeling interface, format your apiUrl using the appropriate URL format for your cloud service provider: gs://, s3://, azure-blob://.

Flat file format

The basic requirements are to use JSON formatting, wrap the taxonomy structure in an items object, and include value properties for every item.

In this example, you are using children to specify child nodes. All values are loaded in a single request.

{
    "items": [
        {
            "alias": "archaea01",
            "hint": "Single-celled organisms",
            "value": "Archaea"
        },
        {
            "alias": "bacteria01",
            "hint": "Prokaryotic microorganisms",
            "value": "Bacteria"
        },
        {
            "alias": "eukarya01",
            "hint": "Basically everything else",
            "value": "Eukarya",
            "children": [
                {
                    "alias": "eukarya01_b1",
                    "value": "Human"
                },
                {
                    "alias": "eukarya01_b2",
                    "value": "Opossum"
                },
                {
                    "alias": "eukarya01_b3",
                    "value": "Extraterrestrial"
                }
            ]
        }
    ]
}

API taxonomies

When using this format, child nodes are only loaded when requested. Parent nodes are specified using "isLeaf": false and child nodes are called through the path parameter.

For example, taxonomy_api_url?path=node1 where node1 is the alias (if specified) or the value (if no alias is specified). Therefore you must ensure that your API supports the path parameter.

Taxonomy API spec

GET /?[path=value1]&[path=value2]&...&[path=valueN]

Returns a JSON object with an items key, whose associated value is a list of Taxonomy items.

If path query params are provided, return the direct children of valueN. Note that for i in range 1..N-1, value[i+1] must be a child node of value[i].

{
  "items": [ <List of taxonomy values> ]
}

Taxonomy item definition:

{

  "alias": // Optional string, short name for use in output data and path values.
  "value": // Required string, the displayed text for the taxonomy value. 
           // Used same way as `alias` if alias is not specified (i.e., in output data and path values).
  "hint":  // Optional string, text displayed when user hovers over taxonomy item.
  "isLeaf": // Required boolean with default=false. Indicates whether this node has more children.
}

See the following taxonomy (https://cities-nu.vercel.app/labels2) for an example:

{
    "items": [
        {
            "alias": "AF",
            "value": "Africa",
            "hint": "AF",
            "isLeaf": false
        },
        {
            "alias": "AN",
            "value": "Antarctica",
            "hint": "AN",
            "isLeaf": false
        },
        {
            "alias": "AS",
            "value": "Asia",
            "hint": "AS",
            "isLeaf": false
        },
        {
            "alias": "EU",
            "value": "Europe",
            "hint": "EU",
            "isLeaf": false
        },
        {
            "alias": "NA",
            "value": "North America",
            "hint": "NA",
            "isLeaf": false
        },
        {
            "alias": "OC",
            "value": "Oceania",
            "hint": "OC",
            "isLeaf": false
        },
        {
            "alias": "SA",
            "value": "South America",
            "hint": "SA",
            "isLeaf": false
        }
    ]
}

When the user expands the “Africa” option, the following request is sent to retrieve the child values: https://cities-nu.vercel.app/labels2?path=AF

Related tags

• Text
• Taxonomy
• Choice