t

com.johnsnowlabs.nlp.annotators.deid

DeIdentificationParams

trait DeIdentificationParams extends BaseDeidParams with MaskingParams with HasFeatures

A trait that contains all the params that are common between DeIdentificationModel and DeIdentification annotators.

See also

DeIdentification

DeIdentificationModel

BaseDeidParams

Linear Supertypes
MaskingParams, BaseDeidParams, HasFeatures, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DeIdentificationParams
  2. MaskingParams
  3. BaseDeidParams
  4. HasFeatures
  5. Params
  6. Serializable
  7. Serializable
  8. Identifiable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params
    Definition Classes
    Params
  2. abstract val uid: String
    Definition Classes
    Identifiable

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. val additionalDateFormats: StringArrayParam

    Additional date formats to be considered during date obfuscation.

    Additional date formats to be considered during date obfuscation. This allows users to specify custom date formats in addition to the default dateFormats.

    Definition Classes
    BaseDeidParams
  10. val ageGroups: StructFeature[Map[String, Array[Int]]]

    A map of age groups to obfuscate ages.

    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)
    )
  11. val ageRanges: IntArrayParam

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

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

    Definition Classes
    BaseDeidParams
  12. val ageRangesByHipaa: BooleanParam

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

    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.

    Definition Classes
    BaseDeidParams
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. val blackList: StringArrayParam

    List of entities that will be ignored in the regex file.

    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".

  15. val blackListEntities: StringArrayParam

    List of entities coming from NER or regex rules that will be ignored for masking or obfuscation.

    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.

  16. val chunkMatching: MapFeature[String, Double]

    Performs entity chunk matching across rows or within groups in a DataFrame.

    Performs entity chunk matching across rows or within groups in a DataFrame. Useful in de-identification pipelines where certain entity labels like "NAME" or "DATE" may be missing in some rows and need to be filled from other rows in the same group.

    Note

    When applying the method across multiple rows, the usage of groupByCol parameter is required.

  17. final def clear(param: Param[_]): DeIdentificationParams.this.type
    Definition Classes
    Params
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. lazy val combinedDateFormats: Array[String]
    Attributes
    protected
    Definition Classes
    BaseDeidParams
  20. val consistentAcrossNameParts: BooleanParam

    Param that indicates whether consistency should be enforced across different parts of a name (e.g., first name, middle name, last name).

    Param that indicates whether consistency should be enforced across different parts of a name (e.g., first name, middle name, last name). When set to true, the same transformation or obfuscation will be applied consistently to all parts of the same name entity, even if those parts appear separately.

    For example, if "John Smith" is obfuscated as "Liam Brown", then:

    • When the full name "John Smith" appears, it will be replaced with "Liam Brown"
    • When "John" or "Smith" appear individually, they will still be obfuscated as "Liam" and "Brown" respectively, ensuring consistency in name transformation.

    Default: true

    Definition Classes
    BaseDeidParams
  21. val consistentObfuscation: BooleanParam

    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.

  22. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  23. val countryObfuscation: BooleanParam

    Whether to obfuscate country entities or not.

    Whether to obfuscate country entities or not. If true, country entities will be obfuscated using the Faker module. If false, country entities will be skipped during obfuscation. Default: false

    Definition Classes
    BaseDeidParams
  24. val dateEntities: StringArrayParam

    List of date entities.

    List of date entities. Default: Array("DATE", "DOB", "DOD", "EFFDATE", "FISCAL_YEAR")

    Definition Classes
    BaseDeidParams
  25. val dateFormats: StringArrayParam

    Format of dates to displace

    Format of dates to displace

    Definition Classes
    BaseDeidParams
  26. val dateTag: Param[String]

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

  27. val dateToYear: BooleanParam

    true if dates must be converted to years, false otherwise

  28. val days: IntParam

    Number of days to obfuscate the dates by displacement.

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

    Definition Classes
    BaseDeidParams
  29. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  32. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  33. def explainParams(): String
    Definition Classes
    Params
  34. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  35. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  36. val fakerLengthOffset: IntParam

    It specifies how much length deviation is accepted in obfuscation, with keepTextSizeForObfuscation enabled.

    It specifies how much length deviation is accepted in obfuscation, with keepTextSizeForObfuscation enabled. Value must be greater than 0. Default is 3.

    Definition Classes
    BaseDeidParams
  37. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  38. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. val fixedMaskLength: IntParam

    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.

    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.

    Definition Classes
    MaskingParams
  40. val genderAwareness: BooleanParam

    Whether to use gender-aware names or not during obfuscation.

    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

    Definition Classes
    BaseDeidParams
  41. val geoConsistency: BooleanParam

    Whether to enforce consistent obfuscation across geographical entities: state, city, street, zip and phone.

    Whether to enforce consistent obfuscation across geographical entities: state, city, street, zip and phone.

    ## Functionality Overview This parameter enables intelligent geographical entity obfuscation that maintains realistic relationships between different geographic components. When enabled, the system ensures that obfuscated addresses form coherent, valid combinations rather than random replacements.

    ## Supported Entity Types The following geographical entities are processed with priority order: - **state** (Priority: 0) - US state names - **city** (Priority: 1) - City names - **zip** (Priority: 2) - Zip codes - **street** (Priority: 3) - Street addresses - **phone** (Priority: 4) - Phone numbers

    ## Language Requirement **IMPORTANT**: Geographic consistency is only applied when: - geoConsistency parameter is set to true AND - language parameter is set to en

    For non-English configurations, this feature is automatically disabled regardless of the parameter setting.

    ## Consistency Algorithm When geographical entities comes from the chunk columns:

    1. **Entity Grouping**: All geographic entities are identified and grouped by type 2. **Fake Address Selection**: A consistent set of fake US addresses is selected using hash-based deterministic selection to ensure reproducibility 3. **Priority-Based Mapping**: Entities are mapped to fake addresses following the priority order (state → city → zip → street → phone) 4. **Consistent Replacement**: All entities of the same type within a document use the same fake address pool, maintaining geographical coherence

    ## Parameter Interactions **IMPORTANT**: Enabling this parameter automatically disables: - keepTextSizeForObfuscation - Text size preservation is not maintained - consistentObfuscation - Standard consistency rules are overridden - file-based fakers

    This is necessary because geographic consistency requires specific fake address selection that may not preserve original text lengths or follow standard obfuscation patterns.

    default: false

    Definition Classes
    BaseDeidParams
  42. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  43. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  44. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  45. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  46. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  47. def getAdditionalDateFormats: Array[String]

    Gets the value of additionalDateFormats

    Gets the value of additionalDateFormats

    Definition Classes
    BaseDeidParams
  48. def getAgeRanges: Array[Int]

    Gets ageRanges param.

    Gets ageRanges param.

    Definition Classes
    BaseDeidParams
  49. def getAgeRangesByHipaa: Boolean

    Gets the value of ageRangesByHipaa.

    Gets the value of ageRangesByHipaa.

    Definition Classes
    BaseDeidParams
  50. def getBlackListEntities: Array[String]

    Gets blackListEntities param

  51. def getChunkMatching: Map[String, Double]
  52. def getChunkMatchingAsStr: String
  53. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  54. def getConsistentAcrossNameParts: Boolean

    Gets the value of consistentAcrossNameParts.

    Gets the value of consistentAcrossNameParts.

    Definition Classes
    BaseDeidParams
  55. def getConsistentObfuscation: Boolean
  56. def getCountryObfuscation: Boolean

    Gets the value of countryObfuscation.

    Gets the value of countryObfuscation.

    Definition Classes
    BaseDeidParams
  57. def getDateEntities: Array[String]

    Gets dateEntities param.

    Gets dateEntities param.

    Definition Classes
    BaseDeidParams
  58. def getDateFormats: Array[String]

    Gets the value of dateFormats

    Gets the value of dateFormats

    Definition Classes
    BaseDeidParams
  59. def getDateTag: String
  60. def getDateToYear: Boolean
  61. def getDays: Int

    Gets days param

    Gets days param

    Definition Classes
    BaseDeidParams
  62. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  63. def getEntityBasedObfuscationRefSource(entityClass: String): String
    Attributes
    protected
    Definition Classes
    BaseDeidParams
  64. def getFakerLengthOffset: Int

    Gets fakerLengthOffset param

    Gets fakerLengthOffset param

    Definition Classes
    BaseDeidParams
  65. def getFixedMaskLength: Int

    Gets fixedMaskLength param.

    Gets fixedMaskLength param.

    Definition Classes
    MaskingParams
  66. def getGenderAwareness: Boolean

    Gets genderAwareness param.

    Gets genderAwareness param.

    Definition Classes
    BaseDeidParams
  67. def getGeoConsistency: Boolean

    Gets the value of geoConsistency.

    Gets the value of geoConsistency.

    Definition Classes
    BaseDeidParams
  68. def getGroupByCol: String

    Gets groupByCol param

  69. def getIgnoreRegex: Boolean
  70. def getKeepMonth: Boolean

    Gets keepMonth param

    Gets keepMonth param

    Definition Classes
    BaseDeidParams
  71. def getKeepTextSizeForObfuscation: Boolean

    Gets keepTextSizeForObfuscation param

    Definition Classes
    BaseDeidParams
  72. def getKeepYear: Boolean

    Gets keepYear param

    Gets keepYear param

    Definition Classes
    BaseDeidParams
  73. def getLanguage: String

    Gets language param.

    Gets language param.

    Definition Classes
    BaseDeidParams
  74. def getMappingsColumn: String
  75. def getMaskStatus(entityClass: String): String
    Attributes
    protected
    Definition Classes
    MaskingParams
  76. def getMaskingPolicy: String

    Gets maskingPolicy param.

    Gets maskingPolicy param.

    Definition Classes
    MaskingParams
  77. def getMetadataMaskingPolicy: String

    Gets metadataMaskingPolicy param

  78. def getMinYear: Int
  79. def getMode: String

    Gets mode param.

    Gets mode param.

    Definition Classes
    BaseDeidParams
  80. def getObfuscateByAgeGroups: Boolean

    Gets obfuscateByAgeGroups param

  81. def getObfuscateDate: Boolean

    Gets obfuscateDate param

    Gets obfuscateDate param

    Definition Classes
    BaseDeidParams
  82. def getObfuscateRefSource: String

    Gets obfuscateRefSource param.

    Gets obfuscateRefSource param.

    Definition Classes
    BaseDeidParams
  83. def getObfuscationStrategyOnException: String
  84. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  85. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  86. def getRegexOverride: Boolean
  87. def getRegion: String

    Gets region param.

    Gets region param.

    Definition Classes
    BaseDeidParams
  88. def getReturnEntityMappings: Boolean
  89. def getSameEntityThreshold: Double
  90. def getSameLengthFormattedEntities(): Array[String]
    Definition Classes
    BaseDeidParams
  91. def getSeed(): Int
    Definition Classes
    BaseDeidParams
  92. def getSelectiveObfuscateRefSource: Map[String, String]

    Gets selectiveObfuscateRefSource param.

    Definition Classes
    BaseDeidParams
  93. def getSelectiveObfuscateRefSourceAsStr: String
    Definition Classes
    BaseDeidParams
  94. def getStaticObfuscationPairs: Option[Array[StaticObfuscationEntity]]
    Definition Classes
    BaseDeidParams
  95. def getUnnormalizedDateMode: String

    Gets unnormalizedDateMode param.

    Definition Classes
    BaseDeidParams
  96. def getUseShiftDays: Boolean

    Getter method of useShiftDays

    Getter method of useShiftDays

    Definition Classes
    DeIdentificationParamsBaseDeidParams
  97. def getValidAgeRanges: Array[Int]

    Gets valid ageRanges whether ageRangesByHipaa is true or not.

    Gets valid ageRanges whether ageRangesByHipaa is true or not.

    Attributes
    protected
    Definition Classes
    BaseDeidParams
  98. def getZipCodeTag: String
  99. val groupByCol: Param[String]

    The column name used to group the dataset.

    The column name used to group the dataset. This parameter is used in conjunction with consistentObfuscation to ensure consistent obfuscation within each group. When groupByCol is set, the dataset is partitioned into groups based on the values of the specified column.

    Default: "" (empty string, meaning no grouping)

    • The column name must be a valid string in the input dataset.
    • The column must be of StringType.
    Note

    This functionality can change order of the dataset, so it is recommended to use it with caution.

    ,

    This functionality cannot be supported by LightPipeline.

  100. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  101. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  102. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  103. val ignoreRegex: BooleanParam

    Select if you want to use regex file loaded in the model.

    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.

  104. def isArabic: Boolean
    Attributes
    protected
    Definition Classes
    MaskingParams
  105. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  106. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  107. val isRandomDateDisplacement: BooleanParam

    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.

  108. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  109. val keepMonth: BooleanParam

    Whether to keep the month intact when obfuscating date entities.

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

    Definition Classes
    BaseDeidParams
  110. val keepTextSizeForObfuscation: BooleanParam

    It specifies whether the output should maintain the same character length as the input text.

    It specifies whether the output should maintain the same character length as the input text. the output text will remain the same if same length is available, else length might vary.

    Definition Classes
    BaseDeidParams
  111. val keepYear: BooleanParam

    Whether to keep the year intact when obfuscating date entities.

    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.

    Definition Classes
    BaseDeidParams
  112. val language: Param[String]

    The language used to select the regex file and some faker entities.

    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'

    Definition Classes
    BaseDeidParams
  113. val mappingsColumn: Param[String]

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

  114. def maskEntity(wordToReplace: String, entityClass: String): String
    Attributes
    protected
    Definition Classes
    MaskingParams
  115. def maskEntity(annotation: Annotation, entityClass: String): String
    Attributes
    protected
    Definition Classes
    MaskingParams
  116. def maskEntityWithPolicy(wordToReplace: String, maskingPolicy: String, entityClass: String): String
    Attributes
    protected
    Definition Classes
    MaskingParams
  117. def maskEntityWithPolicy(annotation: Annotation, maskingPolicy: String, entityClass: String): String
    Attributes
    protected
    Definition Classes
    MaskingParams
  118. val maskingPolicy: Param[String]

    Select the masking policy:

    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.
    • 'entity_labels_without_brackets': Replace the values with the entity value without brackets.
    • 'same_length_chars_without_brackets': Replace the name with the asterix with same length without brackets.
    • Default: 'entity_labels'
    Definition Classes
    MaskingParams
  119. val metadataMaskingPolicy: Param[String]

    If specified, the metadata includes the masked form of the document.

    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.
    • 'entity_labels_without_brackets': Replace the values with the entity value without brackets.
    • 'same_length_chars_without_brackets': Replace the name with the asterix with same length without brackets.
    • Default: ""
  120. val minYear: IntParam

    Minimum year to use when converting date to year

  121. val mode: Param[String]

    Mode for Anonymizer ['mask' or 'obfuscate'].

    Mode for Anonymizer ['mask' or '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.
    Definition Classes
    BaseDeidParams
    Example:
    1. Given the following text: "David Hale visited EEUU a couple of years ago"

      • Mask mode: "<PERSON> visited <COUNTRY> a couple of years ago"
      • Obfuscate mode: "Bryan Johnson visited Japan a couple of years ago"
  122. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  123. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  124. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  125. val obfuscateByAgeGroups: BooleanParam

    Whether to obfuscate ages based on age groups.

    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.

  126. val obfuscateDate: BooleanParam

    When mode=="obfuscate" whether to obfuscate dates or not.

    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 unnormalizedDateMode will be activated. When setting to 'false', then the date will be masked to <DATE>. Default: false

    Definition Classes
    BaseDeidParams
  127. val obfuscateRefSource: Param[String]

    The source of obfuscation to obfuscate the entities.

    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.

    Definition Classes
    BaseDeidParams
  128. val obfuscationStrategyOnException: Param[String]

    The obfuscation strategy to be applied when an exception occurs.

    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".

  129. val outputAsDocument: BooleanParam

    Whether to return all sentences joined into a single document

  130. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  131. lazy val randomDateFormat: String
    Attributes
    protected
    Definition Classes
    BaseDeidParams
  132. val regexOverride: BooleanParam

    If the value is true, prioritize the regex entities; if the value is false, prioritize the ner.

    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.

  133. val region: Param[String]

    With this property, you can select particular dateFormats.

    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
    Definition Classes
    BaseDeidParams
  134. val returnEntityMappings: BooleanParam

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

  135. val sameEntityThreshold: DoubleParam

    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.

  136. val sameLengthFormattedEntities: StringArrayParam

    List of formatted entities to generate the same length outputs as original ones during obfuscation.

    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".

    Definition Classes
    BaseDeidParams
  137. val seed: IntParam

    It is the seed to select the entities on obfuscate mode.

    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.

    Definition Classes
    BaseDeidParams
  138. val selectiveObfuscateRefSource: MapFeature[String, String]

    A map of entity names to their obfuscation modes.

    A map of entity names to their obfuscation modes. This is used to selectively apply different obfuscation methods to specific entities. The keys are entity names and the values are the obfuscation sources. If an entity is not specified in this map, the obfuscateRefSource param is used to determine the obfuscation source.

    Definition Classes
    BaseDeidParams
    Example:
    1. val selectiveSources = Map(
       "PHONE" -> "file",
       "EMAIL" -> "faker",
       "NAME" -> "faker",
       "ADDRESS" -> "both"
       )
  139. def set[T](feature: StructFeature[T], value: T): DeIdentificationParams.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  140. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): DeIdentificationParams.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  141. def set[T](feature: SetFeature[T], value: Set[T]): DeIdentificationParams.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  142. def set[T](feature: ArrayFeature[T], value: Array[T]): DeIdentificationParams.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  143. final def set(paramPair: ParamPair[_]): DeIdentificationParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  144. final def set(param: String, value: Any): DeIdentificationParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  145. final def set[T](param: Param[T], value: T): DeIdentificationParams.this.type
    Definition Classes
    Params
  146. def setAdditionalDateFormats(formats: Array[String]): DeIdentificationParams.this.type

    Sets additionalDateFormats param

    Definition Classes
    BaseDeidParams
  147. def setAgeGroups(value: Map[String, Array[Int]]): DeIdentificationParams.this.type

    Sets the age groups to obfuscate ages.

    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)
    )
    Exceptions thrown

    IllegalArgumentException if the value is empty, contains negative values, or is not a pair of integers

  148. def setAgeGroups(value: HashMap[String, ArrayList[Int]]): DeIdentificationParams.this.type
  149. def setAgeRanges(mode: Array[Int]): DeIdentificationParams.this.type

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

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

    Definition Classes
    BaseDeidParams
  150. def setAgeRangesByHipaa(value: Boolean): DeIdentificationParams.this.type

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

    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.

    value

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

    Definition Classes
    BaseDeidParams
  151. def setBlackList(list: Array[String]): DeIdentificationParams.this.type

    List of entities that will be ignored to in the regex file.

    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".

  152. def setBlackListEntities(value: Array[String]): DeIdentificationParams.this.type

    Sets the list of entities coming from NER or regex rules that will be ignored for masking or obfuscation.

    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.

  153. def setChunkMatching(categories: HashMap[String, Double]): DeIdentificationParams.this.type
  154. def setChunkMatching(value: Map[String, Double]): DeIdentificationParams.this.type

    Performs entity chunk matching across rows or within groups in a DataFrame.

    Performs entity chunk matching across rows or within groups in a DataFrame. Useful in de-identification pipelines where certain entity labels like "NAME" or "DATE" may be missing in some rows and need to be filled from other rows in the same group.

    Notes:

    • When applying the method across multiple rows, the usage of groupByCol parameter is required.
  155. def setConsistentAcrossNameParts(value: Boolean): DeIdentificationParams.this.type

    Sets the value of consistentAcrossNameParts.

    Sets the value of consistentAcrossNameParts.

    value

    Boolean flag to enforce consistency across name parts

    returns

    this instance

    Definition Classes
    BaseDeidParams
  156. def setConsistentObfuscation(s: Boolean): DeIdentificationParams.this.type

    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.

  157. def setCountryObfuscation(value: Boolean): DeIdentificationParams.this.type

    Sets whether to obfuscate country entities or not.

    Sets whether to obfuscate country entities or not. If true, country entities will be obfuscated using the Faker module. If false, country entities will be skipped during obfuscation. Default: false

    Definition Classes
    BaseDeidParams
  158. def setDateEntities(value: Array[String]): DeIdentificationParams.this.type

    Sets the value of dateEntities.

    Sets the value of dateEntities. Default: Array("DATE", "DOB", "DOD", "EFFDATE", "FISCAL_YEAR")

    Definition Classes
    BaseDeidParams
  159. def setDateFormats(s: Array[String]): DeIdentificationParams.this.type

    Format of dates to displace

    Format of dates to displace

    Definition Classes
    BaseDeidParams
  160. def setDateTag(s: String): DeIdentificationParams.this.type

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

  161. def setDateToYear(s: Boolean): DeIdentificationParams.this.type

    true if dates must be converted to years, false otherwise

  162. def setDays(k: Int): DeIdentificationParams.this.type

    Number of days to obfuscate the dates by displacement.

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

    Definition Classes
    BaseDeidParams
  163. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): DeIdentificationParams.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  164. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): DeIdentificationParams.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  165. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): DeIdentificationParams.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  166. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): DeIdentificationParams.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  167. final def setDefault(paramPairs: ParamPair[_]*): DeIdentificationParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  168. final def setDefault[T](param: Param[T], value: T): DeIdentificationParams.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  169. def setFakerLengthOffset(value: Int): DeIdentificationParams.this.type

    Sets fakerLengthOffset param

    Sets fakerLengthOffset param

    Definition Classes
    BaseDeidParams
  170. def setFixedMaskLength(value: Int): DeIdentificationParams.this.type

    Sets the value of fixedMaskLength.

    Sets the value of fixedMaskLength. This is the length of the masking sequence that will be used when the 'fixed_length_chars' masking policy is selected.

    Definition Classes
    MaskingParams
  171. def setGenderAwareness(value: Boolean): DeIdentificationParams.this.type

    Whether to use gender-aware names or not during obfuscation.

    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

    Definition Classes
    BaseDeidParams
  172. def setGeoConsistency(value: Boolean): DeIdentificationParams.this.type

    Sets the value of geoConsistency.

    Sets the value of geoConsistency. When set to true, it enables consistent obfuscation across geographical entities such as state, city, street, zip, and phone.

    Definition Classes
    BaseDeidParams
  173. def setGroupByCol(value: String): DeIdentificationParams.this.type

    Sets groupByCol param to group the dataset.

    Sets groupByCol param to group the dataset. This parameter is used in conjunction with consistentObfuscation to ensure consistent obfuscation within each group.

    Note

    This functionality can change order of the dataset, so it is recommended to use it with caution.

    ,

    This functionality cannot be supported by LightPipeline.

  174. def setIgnoreRegex(s: Boolean): DeIdentificationParams.this.type

    Select if you want to use regex file loaded in the model.

    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.

  175. def setIsRandomDateDisplacement(s: Boolean): DeIdentificationParams.this.type

    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.

  176. def setKeepMonth(value: Boolean): DeIdentificationParams.this.type

    Sets whether to keep the month intact when obfuscating date entities.

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

    Definition Classes
    BaseDeidParams
  177. def setKeepTextSizeForObfuscation(value: Boolean): DeIdentificationParams.this.type

    Sets keepTextSizeForObfuscation param

    Definition Classes
    BaseDeidParams
  178. def setKeepYear(value: Boolean): DeIdentificationParams.this.type

    Sets whether to keep the year intact when obfuscating date entities.

    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.

    Definition Classes
    BaseDeidParams
  179. def setLanguage(s: String): DeIdentificationParams.this.type

    The language used to select the regex file and some faker entities.

    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'

    Definition Classes
    BaseDeidParams
  180. def setMappingsColumn(s: String): DeIdentificationParams.this.type

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

  181. def setMaskingPolicy(value: String): DeIdentificationParams.this.type

    Select the masking policy:

    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.
    • 'entity_labels_without_brackets': Replace the values with the entity value without brackets.
    • 'same_length_chars_without_brackets': Replace the name with the asterix with same length without brackets.
    • Default: 'entity_labels'
    Definition Classes
    MaskingParams
  182. def setMetadataMaskingPolicy(value: String): DeIdentificationParams.this.type

    If specified, the metadata includes the masked form of the document.

    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.
    • 'entity_labels_without_brackets': Replace the values with the entity value without brackets.
    • 'same_length_chars_without_brackets': Replace the name with the asterix with same length without brackets.
    • Default: ""
  183. def setMinYear(s: Int): DeIdentificationParams.this.type

    Minimum year to use when converting date to year

  184. def setMode(m: String): DeIdentificationParams.this.type

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

    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.
    Definition Classes
    BaseDeidParams
    Example:
    1. Given the following text: "David Hale visited EEUU a couple of years ago"

      • Mask mode: "<PERSON> visited <COUNTRY> a couple of years ago"
      • Obfuscate mode: "Bryan Johnson visited Japan a couple of years ago"
  185. def setObfuscateByAgeGroups(value: Boolean): DeIdentificationParams.this.type

    Sets whether to obfuscate ages based on age groups.

    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.

  186. def setObfuscateDate(s: Boolean): DeIdentificationParams.this.type

    When mode=="obfuscate" whether to obfuscate dates or not.

    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 unnormalizedDateMode will be activated. When setting to 'false' then the date will be masked to <DATE> . Default: false

    Definition Classes
    BaseDeidParams
  187. def setObfuscateRefSource(s: String): DeIdentificationParams.this.type

    The source of obfuscation to obfuscate the entities.

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

    Definition Classes
    BaseDeidParams
  188. def setObfuscationStrategyOnException(value: String): DeIdentificationParams.this.type

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

    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".

  189. def setOutputAsDocument(mode: Boolean): DeIdentificationParams.this.type

    Whether to return all sentences joined into a single document

  190. def setRegexOverride(s: Boolean): DeIdentificationParams.this.type

    If the value is true, prioritize the regex entities; if the value is false, prioritize the ner.

    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.

  191. def setRegion(s: String): DeIdentificationParams.this.type

    With this property, you can select particular dateFormats.

    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
    Definition Classes
    BaseDeidParams
  192. def setReturnEntityMappings(s: Boolean): DeIdentificationParams.this.type

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

  193. def setSameEntityThreshold(s: Double): DeIdentificationParams.this.type

    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.

  194. def setSameLengthFormattedEntities(entities: Array[String]): DeIdentificationParams.this.type

    List of formatted entities to generate the same length outputs as original ones during obfuscation.

    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.

    Definition Classes
    BaseDeidParams
  195. def setSeed(s: Int): DeIdentificationParams.this.type

    It is the seed to select the entities on obfuscate mode.

    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.

    Definition Classes
    BaseDeidParams
  196. def setSelectiveObfuscateRefSource(value: HashMap[String, String]): DeIdentificationParams.this.type
    Definition Classes
    BaseDeidParams
  197. def setSelectiveObfuscateRefSource(value: Map[String, String]): DeIdentificationParams.this.type

    Sets the value of selectiveObfuscateRefSource.

    Sets the value of selectiveObfuscateRefSource. This is used to selectively apply different obfuscation methods to specific entities. The keys are entity names and the values are the obfuscation sources. If an entity is not specified in this map, the obfuscateRefSource param is used to determine the obfuscation method. The values can be: - 'file': Takes the fakes from the file. - 'faker': Takes the fakes from the embedded faker module. - 'both': Takes the fakes from the file and the faker module.

    Definition Classes
    BaseDeidParams
    Example:
    1. val modes = Map(
       "PHONE" -> "file",
       "EMAIL" -> "faker",
       "NAME" -> "faker",
       "ADDRESS" -> "both"
       )
  198. def setStaticObfuscationPairs(pairs: ArrayList[ArrayList[String]]): DeIdentificationParams.this.type
    Definition Classes
    BaseDeidParams
  199. def setStaticObfuscationPairs(pairs: Array[StaticObfuscationEntity]): DeIdentificationParams.this.type
    Definition Classes
    BaseDeidParams
  200. def setStaticObfuscationPairs(pairs: Array[Array[String]]): DeIdentificationParams.this.type

    Sets the static obfuscation pairs.

    Sets the static obfuscation pairs. Each pair should contain three elements: original, entity type, and fake. The pairs must have exactly 3 elements: [original, entityType, fake].

    pairs

    An array of arrays containing the static obfuscation pairs.

    Definition Classes
    BaseDeidParams
  201. def setUnnormalizedDateMode(mode: String): DeIdentificationParams.this.type

    The mode to use if the date is not formatted.

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

    Definition Classes
    BaseDeidParams
  202. def setUseShiftDays(s: Boolean): DeIdentificationParams.this.type

    Sets the value of useShiftDays.

    Sets the value of useShiftDays. Whether to use the random shift day when the document has this in its metadata. DocumentHashCoder can create 'dateshift' based on the document. Default: false

    Definition Classes
    DeIdentificationParamsBaseDeidParams
  203. def setZipCodeTag(s: String): DeIdentificationParams.this.type
  204. val staticObfuscationPairs: StructFeature[Array[StaticObfuscationEntity]]

    A resource containing static obfuscation pairs.

    A resource containing static obfuscation pairs. Each pair should contain three elements: original, entity type, and fake.

    Definition Classes
    BaseDeidParams
  205. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  206. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  207. val unnormalizedDateMode: Param[String]

    The mode to use if the date is not formatted.

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

    Definition Classes
    BaseDeidParams
  208. val useShifDays: BooleanParam

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

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

  209. val useShiftDays: BooleanParam

    Whether to use the random shift day when the document has this in its metadata.

    Whether to use the random shift day when the document has this in its metadata. DocumentHashCoder can create 'dateshift' based on the document. Default: false

    Definition Classes
    BaseDeidParams
  210. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  211. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  212. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  213. val zipCodeTag: Param[String]

Deprecated Value Members

  1. def setUseShiftDayse(s: Boolean): DeIdentificationParams.this.type
    Annotations
    @deprecated
    Deprecated

    deprecated because of typo

Inherited from MaskingParams

Inherited from BaseDeidParams

Inherited from HasFeatures

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

Parameters

Parameter setters

Ungrouped