LogoLogo
Release notesPython SDK docsDocs homeTextual CloudTonic.ai
  • Tonic Textual guide
  • Getting started with Textual
  • Previewing Textual detection and redaction
  • Entity types that Textual detects
    • Built-in entity types
    • Managing custom entity types
  • Language support in Textual
  • Datasets - Create redacted files
    • Datasets workflow for text redaction
    • Creating and managing datasets
    • Assigning tags to datasets
    • Displaying the file manager
    • Adding and removing dataset files
    • Reviewing the sensitivity detection results
    • Configuring the redaction
      • Configuring added and excluded values for built-in entity types
      • Working with custom entity types
      • Selecting the handling option for entity types
      • Configuring synthesis options
      • Configuring handling of file components
    • Adding manual overrides to PDF files
      • Editing an individual PDF file
      • Creating templates to apply to PDF files
    • Sharing dataset access
    • Previewing the original and redacted data in a file
    • Downloading redacted data
  • Pipelines - Prepare LLM content
    • Pipelines workflow for LLM preparation
    • Viewing pipeline lists and details
    • Assigning tags to pipelines
    • Setting up pipelines
      • Creating and editing pipelines
      • Supported file types for pipelines
      • Creating custom entity types from a pipeline
      • Configuring file synthesis for a pipeline
      • Configuring an Amazon S3 pipeline
      • Configuring a Databricks pipeline
      • Configuring an Azure pipeline
      • Configuring a Sharepoint pipeline
      • Selecting files for an uploaded file pipeline
    • Starting a pipeline run
    • Sharing pipeline access
    • Viewing pipeline results
      • Viewing pipeline files, runs, and statistics
      • Displaying details for a processed file
      • Structure of the pipeline output file JSON
    • Downloading and using pipeline output
  • Textual Python SDK
    • Installing the Textual SDK
    • Creating and revoking Textual API keys
    • Obtaining JWT tokens for authentication
    • Instantiating the SDK client
    • Datasets and redaction
      • Create and manage datasets
      • Redact individual strings
      • Redact individual files
      • Transcribe and redact an audio file
      • Configure entity type handling for redaction
      • Record and review redaction requests
    • Pipelines and parsing
      • Create and manage pipelines
      • Parse individual files
  • Textual REST API
    • About the Textual REST API
    • REST API authentication
    • Redaction
      • Redact text strings
  • Datasets
    • Manage datasets
    • Manage dataset files
  • Snowflake Native App and SPCS
    • About the Snowflake Native App
    • Setting up the app
    • Using the app
    • Using Textual with Snowpark Container Services directly
  • Install and administer Textual
    • Textual architecture
    • Setting up and managing a Textual Cloud pay-as-you-go subscription
    • Deploying a self-hosted instance
      • System requirements
      • Deploying with Docker Compose
      • Deploying on Kubernetes with Helm
    • Configuring Textual
      • How to configure Textual environment variables
      • Configuring the number of textual-ml workers
      • Configuring the number of jobs to run concurrently
      • Configuring the format of Textual logs
      • Setting a custom certificate
      • Configuring endpoint URLs for calls to AWS
      • Enabling PDF and image processing
      • Setting the S3 bucket for file uploads and redactions
      • Required IAM role permissions for Amazon S3
      • Configuring model preferences
    • Viewing model specifications
    • Managing user access to Textual
      • Textual organizations
      • Creating a new account in an existing organization
      • Single sign-on (SSO)
        • Viewing the list of SSO groups in Textual
        • Azure
        • GitHub
        • Google
        • Keycloak
        • Okta
      • Managing Textual users
      • Managing permissions
        • About permissions and permission sets
        • Built-in permission sets and available permissions
        • Viewing the lists of permission sets
        • Configuring custom permission sets
        • Configuring access to global permission sets
        • Setting initial access to all global permissions
    • Textual monitoring
      • Downloading a usage report
      • Tracking user access to Textual
Powered by GitBook
On this page
  • Viewing whether an entity type has added or excluded values
  • Displaying the Configure Entity Detection panel
  • Selecting the entity type to add or exclude values for
  • Configuring added values
  • Configuring a new added value
  • Editing an added value
  • Testing an added value
  • Removing an added value
  • Configuring excluded values
  • Adding an excluded value
  • Editing an excluded value
  • Testing an excluded value
  • Removing an excluded value
  • Saving the updated added and excluded values

Was this helpful?

Export as PDF
  1. Datasets - Create redacted files
  2. Configuring the redaction

Configuring added and excluded values for built-in entity types

Last updated 4 days ago

Was this helpful?

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 for a pipeline that redacts files, you cannot add or exclude specific values.

Viewing whether an entity type has added or excluded values

In the entity types list, the add values and exclude values icons indicate whether there are configured added and excluded values for the entity type.

When added or excluded values are configured, the corresponding icon is green.

When there are no configured values, the corresponding icon is black.

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 add values or exclude values icon for an entity type.

The panel contains an Add to detection tab for added values, and an Exclude from detection tab for excluded 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.

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.

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.

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. The regular expression must be C# compatible.

You can also provide a specific 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.

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.

Removing an excluded value

To remove an excluded value, click its delete icon.

Saving the updated added and excluded values

The new added and excluded 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.

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.

Entity types showing the configured and not configured versions of the added and excluded values icons
Configure Entity Detection panel to configure added and excluded entity values
Entity type dropdown for Custom Entity Detection
Adding an added value for an entity type
Testing an added value
Adding an excluded value for an entity type
Testing an excluded value
Save options for Custom Entity Detection
Dataset prompt to scan the files to reflect new added and excluded values