Configuring added and excluded values for built-in entity types

Required dataset permission: Edit dataset settings

In a dataset, for each built-in entity type, you can configure additional values to detect, and values to exclude. You cannot define added and excluded values for custom entity types.

You might add values that Textual does not detect because, for example, they are specific to your organization or industry.

You might exclude a value because:

• Textual labeled the value incorrectly.

• You do not want to redact a specific value. For example, you might want to preserve known test values.

Note that you can also add manual redactions from the file preview.

Displaying the Configure Entity Detection panel

From the Configure Entity Detection panel, you configure both added and excluded values for entity types.

To display the panel, click the settings icon for the entity type.

The panel contains an Add to detection tab for added values, and an Exclude from detection tab for excluded values.

Configure Entity Detection panel to configure added and excluded entity values

Selecting the entity type to add or exclude values for

The entity type dropdown list at the top of the Configure Entity Detection panel indicates the entity type to configure added and excluded values for.

The initial selected entity type is the entity type for which you clicked the icon. To configure values for a different entity type, select the entity type from the list.

Entity type dropdown for Custom Entity Detection

Configuring added values

On the Add to detection tab, you configure the added values for the selected entity type.

Each value can be a specific word or phrase, or a regular expression to identify the values to add. Regular expressions must be C# compatible.

Configuring a new added value

To add an added value:

1. Click the empty entry.

2. Type the value into the field.

Adding an added value for an entity type

Editing an added value

To edit an added value:

1. Click the value.

2. Update the value text.

Testing an added value

For each added value, you can test whether Textual correctly detects it.

To test a value:

1. From the Test Entry dropdown list, select the number for the value to test.

2. In the text field, type or paste content that contains a value or values that Textual should detect.

The Results field displays the text and highlights matching values.

Testing an added value

Removing an added value

To remove an added value, click its delete icon.

Configuring excluded values

On the Exclude from detection tab, you configure the excluded values for the selected entity type.

Each value can be either a specific word or phrase to exclude, or a regular expression to identify the values to exclude. Regular expressions must be C# compatible, and can include context information for the values to exclude.

Specific words and phrases can also provide a context within which to ignore a value. For example, in the phrase "one moment, please", you probably do not want the word "one" to be detected as a numeric value. If you specify "one moment, please" as an excluded value for the numeric entity type, then "one" is not identified as a number when it is seen in that context.

Adding an excluded value

To add an excluded value:

1. Click the empty entry.

2. Type the value into the field.

Adding an excluded value for an entity type

Editing an excluded value

To edit an excluded value:

1. Click the value.

2. Update the value text.

Testing an excluded value

For each excluded value, you can test whether Textual correctly detects it.

To test the value that you are currently editing:

1. From the Test Entry dropdown list, select the number for the value to test.

2. In the text field, type or paste content that contains a value or values to exclude.

The Results field displays the text and highlights matching values.

Testing an excluded value

Removing an excluded value

To remove an excluded value, click its delete icon.

Saving the updated added and excluded values

New added values are not reflected in the entity types list until Textual runs a new scan.

When you save the changes, you can choose whether to immediately run a new scan on the dataset files.

Save options for Custom Entity Detection

To save the changes and also start a scan, click Save and Scan Files.

To save the changes, but not run a scan, click Save Without Scanning Files. When you do not run the scan, then on the dataset details page, Textual displays a prompt to run a scan.

Dataset files list when a rescan is required