For the complete documentation index, see llms.txt. This page is also available as Markdown.

Working with additional entity types

The entity types list includes the following additional entity types that you activated for the dataset:

From the Entity settings page, you can enable and disable additional types.

You can also update the configuration of a regex-based type, and go to the details page for a model-based type.

Enabling and disabling additional types

Required dataset permission: Edit dataset settings

The entity types list includes the additional entity types that are active for the dataset.

To manage the additional types that are active for the dataset:

  1. Click Custom entity types.

  2. On the Enable custom entity types panel, to search for specific entity types, begin to type text in the entity type name. As you type, Textual updates the list to only display matching entity types.

Enable custom entity types panel for a dataset
  1. To enable an additional entity type for the dataset, set its toggle to the on position.

  2. When you enable the entity type, you can also set how Textual prioritizes the entity type when a detected value matches both the additional type and a built-in type. The options are:

    • Prioritized - This is the default value. With this option, the additional type always takes precedence over the built-in type.

    • Standard - With this option, Textual uses the confidence scores to determine which type to apply.

Configuration to determine the custom type priority when a value matches both the custom type and a built-in type
  1. To disable an additional entity type for the dataset, set its toggle to the off position.

  2. To enable all of the additional entity types for the dataset, click Bulk, then:

    1. To enable all of the additinal types, and always prioritize the additional types over built-in types, select Enable (Prioritized).

    2. To enable all of the additional types, and use the confidence scores to determine which type takes precedence, select Enable (Standard).

  3. To disable all of the additional entity types for the dataset, click Bulk, then click Disable all.

Setting the confidence threshold for additional types

The Confidence Thresholds tab displays the additional entity types that are enabled for the dataset.

From the Confidence Thresholds tab, you can:

  • View the confidence score range for detected values.

  • Set a minimum confidence score threshold for detections.

Confidence Thresholds tab for a dataset showing the confidence values for detected types and the confidence thresholds for detection

View the confidence score range for detected values

For types that were detected in the dataset, the entry shows the range of confidence scores for the detected values.

Confidence range for detected values

Setting the confidence score threshold for a type

The confidence threshold is the minimum confidence score for a detected value. If the confidence score for a detected value is below the threshold, then Textual ignores that value.

To set the confidence threshold for an entity type, drag the threshold bar to the threshold. You can configure a confidence threshold for any type, even if the type was not detected in the dataset.

Threshold setting options for detected and not detected entity types

Replicating an entity type threshold across your datasets

To replicate the threshold for an entity type across all of the datasets that you have access to, click Apply to all datasets.

Updating the configuration of a regex-based custom entity type

Required global permission - either:

  • Create custom entity types

  • Edit any custom entity type

From the dataset details, you can edit the configuration of a regex-based custom entity type. To edit a regex-based custom entity type, click the settings icon for that type.

Note that any changes to the custom entity type settings affect all of the datasets that use the custom entity type.

For information on how to configure a regex-based custom entity type, go to Adding regex-based types.

Viewing the details for a model-based custom entity type

Required global permission - either:

  • Create custom entity types

  • Edit any custom entity type

For a model-based custom entity type, to display the details for the entity type, click the settings icon.

Textual displays the entity type details in a new browser tab.

Running a new scan to reflect changes to the active additional types

When you enable, disable, or edit additional entity types, the changes do not take effect until you run a new scan on each file.

Textual marks each file as requiring a rescan, and displays a prompt to rescan all of the files.

Dataset files when a rescan is required

To run a new scan for a file, click its scan option.

Rescan option for an individual dataset file

Last updated

Was this helpful?