A map of age groups to obfuscate ages. For this parameter to be active, the obfuscateByAgeGroups parameter must be true. If the given ageGroups do not fully contain the ages, the ages continue to be obfuscated according to the ageRanges. The map should contain the age group name as the key and an array of two integers as the value. The first integer is the lower bound of the age group, and the second integer is the upper bound of the age group. Default age groups are as follows in the English language:

Map(
"baby" -> Array(0, 1),
"toddler" -> Array(1, 4),
"child" -> Array(4, 13),
"teenager" -> Array(13, 20),
"adult" -> Array(20, 65),
"senior" -> Array(65, 200)
)

List of integers specifying limits of the age groups to preserve during obfuscation

A Boolean variable indicating whether to obfuscate ages based on HIPAA (Health Insurance Portability and Accountability Act) Privacy Rule.

The HIPAA Privacy Rule mandates that ages from patients older than 90 years must be obfuscated, while age for patients 90 years or younger can remain unchanged.

When true, age entities larger than 90 will be obfuscated as per HIPAA Privacy Rule, the others will remain unchanged. When false, ageRanges parameter is valid.

List of entities that will be ignored in the regex file. The rest will be processed. The default values are "IBAN","ZIP","NPI","DLN","PASSPORT","C_CARD","DEA","SSN", "IP", "DEA".

List of entities coming from NER or regex rules that will be ignored for masking or obfuscation. The rest entities will be processed. Defaults to an empty array.

If the value is true both loaded regex file and default regex file are used together; if the value is false, either loaded regex file or default regex file is used. The default value is false If the value is true, it uses the default regex file regardless of the value of the regexOverride.

Whether to replace very similar entities in a document with the same randomized term (default: true) The similarity is based on the Levenshtein Distance between the words.

Format of dates to displace

Tag representing what are the NER entity (default: DATE)

true if dates must be converted to years, false otherwise

Number of days to obfuscate the dates by displacement. If not provided a random integer between 1 and 60 will be used

If true, exceptions are handled. If exception causing data is passed to the model, a error annotation is emitted which has the exception message. Processing continues with the next one. This comes with a performance penalty.

Dictionary path where is the json that contains the entity casing modes. 'lowercase': Converts all characters to lower case using the rules of the default locale. 'uppercase': Converts all characters to upper case using the rules of the default locale. 'capitalize': Converts the first character to upper case and converts others to lower case. 'titlecase': Converts the first character in every token to upper case and converts others to lower case.

Select the fixed mask length: this is the length of the masking sequence that will be used when the 'fixed_length_chars' masking policy is selected.

Whether to use gender-aware names or not during obfuscation. This param effects only names. If value is true, it might decrease performance. Default: False

Gets blackListEntities param

Gets keepYear param

Gets metadataMaskingPolicy param

Gets obfuscateByAgeGroups param

Getter method of useShiftDays

Select if you want to use regex file loaded in the model. If true the default regex file will be not used The default value is false.

Input annotator type: DOCUMENT, TOKEN, CHUNK

Use a random displacement days in dates entities,that random number is based on the DeIdentificationParams.seed If true use random displacement days in dates entities,if false use the DeIdentificationParams.days The default value is false.

Whether to keep the year intact when obfuscating date entities. If true, the year will remain unchanged during the obfuscation process. If false, the year will be modified along with the month and day. Default: false.

The language used to select the regex file and some faker entities. 'en'(English),'de'(German), 'es'(Spanish), 'fr'(French), 'ar'(Arabic) or 'ro'(Romanian) Default:'en'

This is the mapping column that will return the Annotations chunks with the fake entities

Select the masking policy:

• 'entity_labels': Replace the values with the entity value.
• 'same_length_chars': Replace the name with the asterix with same length minus two plus brackets on both end.If the entity is less than 3 chars (like Jo, or 5), we can just use asterix without brackets.
• 'fixed_length_chars': Replace the obfuscated entity with a masking sequence composed of a fixed number of asterisk.
• Default: 'entity_labels'

If specified, the metadata includes the masked form of the document. Select the following masking policy if you want to return mask form in the metadata:

• 'entity_labels': Replace the values with the entity value.
• 'same_length_chars': Replace the name with the asterix with same length minus two plus brackets on both end.If the entity is less than 3 chars (like Jo, or 5), we can just use asterix without brackets.
• 'fixed_length_chars': Replace the obfuscated entity with a masking sequence composed of a fixed number of asterisk.
• Default: ""

Minimum year to use when converting date to year

Mode for Anonymizer ['mask'|'obfuscate']. Default: 'mask'

• Mask mode: The entities will be replaced by their entity types.
• Obfuscate mode: The entity is replaced by an obfuscator's term.

Whether to obfuscate ages based on age groups.

When true, the age groups specified in the ageGroups parameter will be used to obfuscate ages. When false, the age ranges specified in the ageRanges parameter will be used to obfuscate ages. Default: false.

When mode=="obfuscate" whether to obfuscate dates or not. This param helps in consistency to make dateFormats more visible. When setting to true, make sure dateFormats param fits the needs. If the value is true and obfuscation is failed, then DeIdentificationParams.unnormalizedDateMode will be activated. When setting to 'false', then the date will be masked to <DATE> Default: false

File with the terms to be used for Obfuscation

The source of obfuscation to obfuscate the entities. The values ar the following: 'file': Takes the entities from the obfuscatorRefFile 'faker': Takes the entities from the Faker module 'both': Takes the entities from the obfuscatorRefFile and the faker module randomly.

The obfuscation strategy to be applied when an exception occurs.

The obfuscation strategy determines how obfuscation is handled in case of an exception. Four possible values are supported:

• "mask": The original chunk is replaced with a masking pattern.
• "default": The original chunk is replaced with a default faker.
• "skip": The original chunk is not replaced with any faker.
• "exception": Throws the exception.

The default obfuscation strategy is "default".

Output annotator types: DOCUMENT

Whether to return all sentences joined into a single document

Format of the reference file for Obfuscation the default value for that is "csv"

Separator character for the csv reference file for Obfuscation de default value is "#"

If the value is true, prioritize the regex entities; if the value is false, prioritize the ner. The default value is false. If DeIdentification.combineRegexPatterns is true, this value will be invalid.

With this property, you can select particular dateFormats. This property is especially used when obfuscating dates. You can decide whether the first part of 11/11/2023 is a day or the second part is a day when obfuscating dates. The values are following: 'eu' for European Union 'us' for USA Default: 'eu'

With this property, you can select if you want to return mapping column.

Similarity threshold [0.0-1.0] to consider two appearances of an entity as the same (default: 0.9) For date entities this method doesn't apply.

List of formatted entities to generate the same length outputs as original ones during obfuscation. The supported and default formatted entities are: "phone", "fax", "contact," "id", "idnum", "bioid", "medicalrecord", "zip", "vin", "ssn", "dln", "plate", "license", "IRS", "CFN", "account".

It is the seed to select the entities on obfuscate mode. With the seed, you can reply to an execution several times with the same output.

Sets the age groups to obfuscate ages. For this parameter to be active, the obfuscateByAgeGroups parameter must be true. If the given ageGroups do not fully contain the ages, the ages continue to be obfuscated according to the ageRanges. The map should contain the age group name as the key and an array of two integers as the value. The first integer is the lower bound of the age group, and the second integer is the upper bound of the age group. Default age groups are as follows in the English language:

Map(
"baby" -> Array(0, 1),
"toddler" -> Array(1, 3),
"child" -> Array(3, 12),
"teenager" -> Array(12, 20),
"adult" -> Array(20, 65),
"senior" -> Array(65, 200)
)

List of integers specifying limits of the age groups to preserve during obfuscation

Sets whether to obfuscate ages based on HIPAA (Health Insurance Portability and Accountability Act) Privacy Rule.

The HIPAA Privacy Rule mandates that ages from patients older than 90 years must be obfuscated, while age for patients 90 years or younger can remain unchanged.

List of entities that will be ignored to in the regex file. The rest will be processed. The default values are "IBAN","ZIP","NPI","DLN","PASSPORT","C_CARD","DEA","SSN", "IP", "DEA".

Sets the list of entities coming from NER or regex rules that will be ignored for masking or obfuscation. The rest entities will be processed. Defaults to an empty array.

If the value is true both loaded regex file and default regex file are used together; if the value is false, either loaded regex file or default regex file is used. The default value is false If the value is true, it uses the default regex file regardless of the value of the regexOverride.

Whether to replace very similar entities in a document with the same randomized term (default: true) The similarity is based on the Levenshtein Distance between the words.

Format of dates to displace

Tag representing what are the NER entity (default: DATE)

true if dates must be converted to years, false otherwise

Number of days to obfuscate the dates by displacement. If not provided a random integer between 1 and 60 will be used

If true, exceptions are handled. If exception causing data is passed to the model, a error annotation is emitted which has the exception message. Processing continues with the next one. This comes with a performance penalty.

Dictionary path where is the json that contains the entity casing modes. 'lowercase': Converts all characters to lower case using the rules of the default locale. 'uppercase': Converts all characters to upper case using the rules of the default locale. 'capitalize': Converts the first character to upper case and converts others to lower case. 'titlecase': Converts the first character in every token to upper case and converts others to lower case.

fixed mask length: this is the length of the masking sequence that will be used when the 'fixed_length_chars' masking policy is selected.

Whether to use gender-aware names or not during obfuscation. This param effects only names. If value is true, it might decrease performance. Default: False

Select if you want to use regex file loaded in the model. If true the default regex file will be not used The default value is false.

Use a random displacement days in dates entities,that random number is based on the DeIdentificationParams.seed If true use random displacement days in dates entities, if false use the DeIdentificationParams.days The default value is false.

Sets whether to keep the year intact when obfuscating date entities. If true, the year will remain unchanged during the obfuscation process. If false, the year will be modified along with the month and day. Default: false.

The language used to select the regex file and some faker entities. 'en'(English),'de'(German), 'es'(Spanish), 'fr'(French), 'ar'(Arabic) or 'ro'(Romanian). Default:'en'

This is the mapping column that will return the Annotations chunks with the fake entities

Select the masking policy:

• 'entity_labels': Replace the values with the entity value.
• 'same_length_chars': Replace the name with the asterix with same length minus two plus brackets on both end.If the entity is less than 3 chars (like Jo, or 5), we can just use asterix without brackets.
• 'fixed_length_chars': Replace the obfuscated entity with a masking sequence composed of a fixed number of asterisk.
• Default: 'entity_labels'

If specified, the metadata includes the masked form of the document. Select the following masking policy if you want to return mask form in the metadata:

• 'entity_labels': Replace the values with the entity value.
• 'same_length_chars': Replace the name with the asterix with same length minus two plus brackets on both end.If the entity is less than 3 chars (like Jo, or 5), we can just use asterix without brackets.
• 'fixed_length_chars': Replace the obfuscated entity with a masking sequence composed of a fixed number of asterisk.
• Default: ""

Minimum year to use when converting date to year

Mode for Anonymizer ['mask'|'obfuscate']. Default: 'mask'

• Mask mode: The entities will be replaced by their entity types.
• Obfuscate mode: The entity is replaced by an obfuscator's term.

Sets whether to obfuscate ages based on age groups.

When true, the age groups specified in the ageGroups parameter will be used to obfuscate ages. When false, the age ranges specified in the ageRanges parameter will be used to obfuscate ages. Default: false.

When mode=="obfuscate" whether to obfuscate dates or not. This param helps in consistency to make dateFormats more visible. When setting to true, make sure dateFormats param fits the needs. If the value is true and obfuscation is failed, then DeIdentificationParams.unnormalizedDateMode will be activated. When setting to 'false' then the date will be masked to <DATE> Default: false

File with the terms to be used for Obfuscation

The source of obfuscation to obfuscate the entities. The values are the following: 'file': Takes the entities from the obfuscatorRefFile 'faker': Takes the entities from the Faker module 'both': Takes the entities from the obfuscatorRefFile and the faker module randomly.

Sets the obfuscation strategy to be applied when an exception occurs.

The obfuscation strategy determines how obfuscation is handled in case of an exception. Four possible values are supported:

• "mask": The original chunk is replaced with a masking pattern.
• "default": The original chunk is replaced with a default faker.
• "skip": The original chunk is not replaced with any faker.
• "exception": Throws the exception.

The default obfuscation strategy is "default".

Whether to return all sentences joined into a single document

File with the terms to be used for Obfuscation

Separator character for the csv reference file for Obfuscation de default value is "#"

If the value is true, prioritize the regex entities; if the value is false, prioritize the ner. The default value is false. If DeIdentification.combineRegexPatterns is true, this value will be invalid.

dictionary with regular expression patterns that match some protected entity.When the field is not set then a default regex file will be used.

dictionary with regular expression patterns that match some protected entity.When the field is not set then a default regex file will be used.

dictionary with regular expression patterns given as JSON that match some protected entity.When the field is not set then a default regex file will be used.

With this property, you can select particular dateFormats. This property is especially used when obfuscating dates. You can decide whether the first part of 11/11/2023 is a day or the second part is a day when obfuscating dates. The values are following: 'eu' for European Union 'us' for USA Default: 'eu'

With this property, you can select if you want to return mapping column.

Similarity threshold [0.0-1.0] to consider two appearances of an entity as the same (default: 0.9) For date entities this method doesn't apply.

List of formatted entities to generate the same length outputs as original ones during obfuscation. The supported and default formatted entities are: PHONE, FAX, CONTACT, ID, IDNUM, BIOID, MEDICALRECORD, ZIP, VIN, SSN, DLN, LICENSE, PLATE, IRS, CFN, ACCOUNT.

It is the seed to select the entities on obfuscate mode. With the seed, you can reply to an execution several times with the same output.

The mode to use if the date is not formatted. [mask, obfuscate, skip] Default: obfuscate

Returns the DeIdentificationModel Transformer, that can be used to transform input datasets

The dataset provided to the fit method should have one chunk per row and contain the following columns: Document, Tokens, Chunks

This method is called inside the AnnotatorApproach's fit method

The mode to use if the date is not formatted. [mask, obfuscate, skip] Default: obfuscate

Use shift days : Whether to use the random shift day when the document has this in its metadata. Default: False