JSON Name/Value Pairs for Importing a Custom Entity

entity_regex

The Python regular expression syntax that defines the new type of personally identifiable information (PII) in the content.

For example, to add an entity type for a custom ID number comprised of two upper-case alphabet characters followed by four digits (as in AB1234), enter [A-Z]{2}[0-9]{4}.

For information about non-capturing groups and backslash characters, see Python Regular Expressions for Custom Entities. For more information about Python regular expressions, go to the Python documentation.

keywords

Keywords that must appear within close proximity to the entity. To define multiple keywords, separate the keywords with a comma:

"entityXML":{"keywords":"employment,start"},

flags

The sensitivity level for the custom entity.

Valid values are:

• 5, critical

• 3, high

• 1, moderate

parentEntityName

An existing entity type to base the custom entity on. For a list of entity types that you can use, see Personally Identifiable Information.

For example, to create an entity for employment start date, select the Date entity and add keywords such as "employment" and "start". Only dates that have those keywords in close proximity in the content are identified as potential matches.

{
"regularExpression":{},
"entityXML":{"keywords":"employment,start"},
"flags":1,
"parentEntityName":"Date",
"entityName":"Employment Start Date"
}

entityName

The name of the custom entity.