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

Was this helpful?

Export as PDF
  1. Entity types that Textual detects

Built-in entity types

Tonic Textual's built-in models identify a range of sensitive values, such as:

  • Locations and addresses

  • Names of people and organizations

  • Identifiers and account numbers

The built-in entity types are:

Entity type name
Identifier (for API)
Description

CC Exp

CC_EXP

The expiration date of a credit card.

Credit Card

CREDIT_CARD

A credit card number.

CVV

CVV

The card verification value for a credit card.

Date Time

DATE_TIME

A date or timestamp.

DOB

DOB

A person's date of birth.

Email Address

EMAIL_ADDRESS

An email address.

Event

EVENT

The name of an event.

Gender Identifier

GENDER_IDENTIFIER

An identifier of a person's gender.

Healthcare Identifier

HEALTHCARE_ID

An identifier associated with healthcare, such as a patient number.

IBAN Code

IBAN_CODE

An international bank account number used to identify an overseas bank account.

IP Address

IP_ADDRESS

An IP address.

Language

LANGUAGE

The name of a spoken language.

Law

LAW

A title of a law.

Location

LOCATION

A value related to a location. Can include any part of a mailing address.

Occupation

OCCUPATION

A job title or profession.

Street Address

LOCATION_ADDRESS

A street address.

City

LOCATION_CITY

The name of a city.

State

LOCATION_STATE

A state name or abbreviation.

Zip

LOCATION_ZIP

A postal code.

Country

LOCATION_COUNTRY

The name of a country.

Full Mailing Address

LOCATION_COMPLETE_ADDRESS

A full postal address. By default, the entity type handling option for this entity type is Off.

Medical License

MEDICAL_LICENSE

The identifier of a medical license.

Money

MONEY

A monetary value.

Given Name

NAME_GIVEN

A given name or first name.

Family Name

NAME_FAMILY

A family name or surname.

NRP

NRP

A nationality, religion, or political group.

Numeric Identifier

NUMERIC_PII

A numeric value that acts as an identifier.

Numeric Value

NUMERIC_VALUE

A numeric value.

Organization

ORGANIZATION

The name of an organization.

Password

PASSWORD

A password used for authentication.

Person Age

PERSON_AGE

The age of a person.

Phone Number

PHONE_NUMBER

A telephone number.

Product

PRODUCT

The name of a product.

URL

URL

A URL to a web page.

US Bank Number

US_BANK_NUMBER

The routing number of a bank in the United States.

US ITIN

US_ITIN

An Individual Taxpayer Identification Number in the United States.

US Passport

US_PASSPORT

A United States passport identifier.

US SSN

US_SSN

A United States Social Security number.

Last updated 14 days ago

Was this helpful?