class ObfuscatorAnnotatorApproach extends AnnotatorApproach[ObfuscatorAnnotatorModel] with DeidApproachParams with ObfuscatorParams

Linear Supertypes
ObfuscatorParams, BaseDeidParams, HasFeatures, DeidApproachParams, AnnotatorApproach[ObfuscatorAnnotatorModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[ObfuscatorAnnotatorModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ObfuscatorAnnotatorApproach
  2. ObfuscatorParams
  3. BaseDeidParams
  4. HasFeatures
  5. DeidApproachParams
  6. AnnotatorApproach
  7. CanBeLazy
  8. DefaultParamsWritable
  9. MLWritable
  10. HasOutputAnnotatorType
  11. HasOutputAnnotationCol
  12. HasInputAnnotationCols
  13. Estimator
  14. PipelineStage
  15. Logging
  16. Params
  17. Serializable
  18. Serializable
  19. Identifiable
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ObfuscatorAnnotatorApproach()
  2. new ObfuscatorAnnotatorApproach(uid: String)

Type Members

  1. type AnnotatorType = String
    Definition Classes
    HasOutputAnnotatorType

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. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): ObfuscatorAnnotatorModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  10. 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
  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. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. final def clear(param: Param[_]): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    Params
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. lazy val combinedDateFormats: Array[String]
    Attributes
    protected
    Definition Classes
    BaseDeidParams
  19. 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
  20. final def copy(extra: ParamMap): Estimator[ObfuscatorAnnotatorModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  21. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  22. 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
  23. val dateEntities: StringArrayParam

    List of date entities.

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

    Definition Classes
    BaseDeidParams
  24. val dateFormats: StringArrayParam

    Format of dates to displace

    Format of dates to displace

    Definition Classes
    BaseDeidParams
  25. 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
  26. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  27. val description: String
    Definition Classes
    ObfuscatorAnnotatorApproach → AnnotatorApproach
  28. val entity: Param[String]
    Definition Classes
    ObfuscatorParams
  29. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  31. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  32. def explainParams(): String
    Definition Classes
    Params
  33. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  34. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  35. 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
  36. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  37. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. final def fit(dataset: Dataset[_]): ObfuscatorAnnotatorModel
    Definition Classes
    AnnotatorApproach → Estimator
  39. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[ObfuscatorAnnotatorModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  40. def fit(dataset: Dataset[_], paramMap: ParamMap): ObfuscatorAnnotatorModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  41. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): ObfuscatorAnnotatorModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  42. 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
  43. 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
  44. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  45. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  46. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  47. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  48. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  49. def getAdditionalDateFormats: Array[String]

    Gets the value of additionalDateFormats

    Gets the value of additionalDateFormats

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

    Gets ageRanges param.

    Gets ageRanges param.

    Definition Classes
    BaseDeidParams
  51. def getAgeRangesByHipaa: Boolean

    Gets the value of ageRangesByHipaa.

    Gets the value of ageRangesByHipaa.

    Definition Classes
    BaseDeidParams
  52. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  53. def getConsistentAcrossNameParts: Boolean

    Gets the value of consistentAcrossNameParts.

    Gets the value of consistentAcrossNameParts.

    Definition Classes
    BaseDeidParams
  54. def getCountryObfuscation: Boolean

    Gets the value of countryObfuscation.

    Gets the value of countryObfuscation.

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

    Gets dateEntities param.

    Gets dateEntities param.

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

    Gets the value of dateFormats

    Gets the value of dateFormats

    Definition Classes
    BaseDeidParams
  57. def getDays: Int

    Gets days param

    Gets days param

    Definition Classes
    BaseDeidParams
  58. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  59. def getEntity: String
    Definition Classes
    ObfuscatorParams
  60. def getEntityBasedObfuscationRefSource(entityClass: String): String
    Attributes
    protected
    Definition Classes
    BaseDeidParams
  61. def getFakerLengthOffset: Int

    Gets fakerLengthOffset param

    Gets fakerLengthOffset param

    Definition Classes
    BaseDeidParams
  62. def getGenderAwareness: Boolean

    Gets genderAwareness param.

    Gets genderAwareness param.

    Definition Classes
    BaseDeidParams
  63. def getGeoConsistency: Boolean

    Gets the value of geoConsistency.

    Gets the value of geoConsistency.

    Definition Classes
    BaseDeidParams
  64. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  65. def getKeepMonth: Boolean

    Gets keepMonth param

    Gets keepMonth param

    Definition Classes
    BaseDeidParams
  66. def getKeepTextSizeForObfuscation: Boolean

    Gets keepTextSizeForObfuscation param

    Gets keepTextSizeForObfuscation param

    Definition Classes
    BaseDeidParams
  67. def getKeepYear: Boolean

    Gets keepYear param

    Gets keepYear param

    Definition Classes
    BaseDeidParams
  68. def getLanguage: String

    Gets language param.

    Gets language param.

    Definition Classes
    BaseDeidParams
  69. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  70. def getMode: String

    Gets mode param.

    Gets mode param.

    Definition Classes
    BaseDeidParams
  71. def getObfuscateDate: Boolean

    Gets obfuscateDate param

    Gets obfuscateDate param

    Definition Classes
    BaseDeidParams
  72. def getObfuscateRefSource: String

    Gets obfuscateRefSource param.

    Gets obfuscateRefSource param.

    Definition Classes
    BaseDeidParams
  73. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  74. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  75. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  76. def getRegion: String

    Gets region param.

    Gets region param.

    Definition Classes
    BaseDeidParams
  77. def getSameLengthFormattedEntities(): Array[String]
    Definition Classes
    BaseDeidParams
  78. def getSeed(): Int
    Definition Classes
    BaseDeidParams
  79. def getSelectiveObfuscateRefSource: Map[String, String]

    Gets selectiveObfuscateRefSource param.

    Gets selectiveObfuscateRefSource param.

    Definition Classes
    BaseDeidParams
  80. def getSelectiveObfuscateRefSourceAsStr: String
    Definition Classes
    BaseDeidParams
  81. def getStaticObfuscationPairs: Option[Array[StaticObfuscationEntity]]
    Definition Classes
    BaseDeidParams
  82. def getStaticObfuscationPairsResource: ExternalResource
    Definition Classes
    DeidApproachParams
  83. def getUnnormalizedDateMode: String

    Gets unnormalizedDateMode param.

    Gets unnormalizedDateMode param.

    Definition Classes
    BaseDeidParams
  84. def getUseShiftDays: Boolean

    Gets useShiftDays param.

    Gets useShiftDays param.

    Definition Classes
    BaseDeidParams
  85. 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
  86. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  87. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  88. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  89. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  90. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. val inputAnnotatorTypes: Array[AnnotatorType]
    Definition Classes
    ObfuscatorAnnotatorApproach → HasInputAnnotationCols
  92. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  93. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  94. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  95. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  96. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  97. 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
  98. 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
  99. 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
  100. 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
  101. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  102. def loadStaticObfuscationPairsResource(): Array[StaticObfuscationEntity]
    Attributes
    protected
    Definition Classes
    DeidApproachParams
  103. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  104. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  105. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  106. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  107. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  108. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  109. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  110. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  111. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  112. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  113. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  114. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  115. 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"
  116. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  117. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  118. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  119. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  120. 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
  121. val obfuscateRefFile: Param[String]

    File with the terms to be used for Obfuscation

    File with the terms to be used for Obfuscation

    Definition Classes
    DeidApproachParams
  122. 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
  123. def onTrained(model: ObfuscatorAnnotatorModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  124. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  125. val outputAnnotatorType: AnnotatorType
    Definition Classes
    ObfuscatorAnnotatorApproach → HasOutputAnnotatorType
  126. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  127. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  128. lazy val randomDateFormat: String
    Attributes
    protected
    Definition Classes
    BaseDeidParams
  129. val refFileFormat: Param[String]

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

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

    Definition Classes
    DeidApproachParams
  130. val refSep: Param[String]

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

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

    Definition Classes
    DeidApproachParams
  131. 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
  132. 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
  133. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  134. 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
  135. 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"
 )
  136. def set[T](feature: StructFeature[T], value: T): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  137. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  138. def set[T](feature: SetFeature[T], value: Set[T]): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  139. def set[T](feature: ArrayFeature[T], value: Array[T]): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  140. final def set(paramPair: ParamPair[_]): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  141. final def set(param: String, value: Any): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  142. final def set[T](param: Param[T], value: T): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    Params
  143. def setAdditionalDateFormats(formats: Array[String]): ObfuscatorAnnotatorApproach.this.type

    Sets additionalDateFormats param

    Sets additionalDateFormats param

    Definition Classes
    BaseDeidParams
  144. def setAgeRanges(mode: Array[Int]): ObfuscatorAnnotatorApproach.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
  145. def setAgeRangesByHipaa(value: Boolean): ObfuscatorAnnotatorApproach.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
  146. def setConsistentAcrossNameParts(value: Boolean): ObfuscatorAnnotatorApproach.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
  147. def setCountryObfuscation(value: Boolean): ObfuscatorAnnotatorApproach.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
  148. def setDateEntities(value: Array[String]): ObfuscatorAnnotatorApproach.this.type

    Sets the value of dateEntities.

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

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

    Format of dates to displace

    Format of dates to displace

    Definition Classes
    BaseDeidParams
  150. def setDays(k: Int): ObfuscatorAnnotatorApproach.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
  151. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  152. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  153. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  154. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  155. final def setDefault(paramPairs: ParamPair[_]*): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  156. final def setDefault[T](param: Param[T], value: T): ObfuscatorAnnotatorApproach.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  157. def setEntity(e: String): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    ObfuscatorParams
  158. def setFakerLengthOffset(value: Int): ObfuscatorAnnotatorApproach.this.type

    Sets fakerLengthOffset param

    Sets fakerLengthOffset param

    Definition Classes
    BaseDeidParams
  159. def setGenderAwareness(value: Boolean): ObfuscatorAnnotatorApproach.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
  160. def setGeoConsistency(value: Boolean): ObfuscatorAnnotatorApproach.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
  161. final def setInputCols(value: String*): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  162. def setInputCols(value: Array[String]): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  163. def setKeepMonth(value: Boolean): ObfuscatorAnnotatorApproach.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
  164. def setKeepTextSizeForObfuscation(value: Boolean): ObfuscatorAnnotatorApproach.this.type

    Sets keepTextSizeForObfuscation param

    Sets keepTextSizeForObfuscation param

    Definition Classes
    BaseDeidParams
  165. def setKeepYear(value: Boolean): ObfuscatorAnnotatorApproach.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
  166. def setLanguage(s: String): ObfuscatorAnnotatorApproach.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
  167. def setLazyAnnotator(value: Boolean): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    CanBeLazy
  168. def setMode(m: String): ObfuscatorAnnotatorApproach.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
    ObfuscatorParams → 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"
  169. def setObfuscateDate(s: Boolean): ObfuscatorAnnotatorApproach.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
  170. def setObfuscateRefFile(f: String): ObfuscatorAnnotatorApproach.this.type

    File with the terms to be used for Obfuscation

    File with the terms to be used for Obfuscation

    Definition Classes
    DeidApproachParams
  171. def setObfuscateRefSource(s: String): ObfuscatorAnnotatorApproach.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
  172. final def setOutputCol(value: String): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    HasOutputAnnotationCol
  173. def setRefFileFormat(f: String): ObfuscatorAnnotatorApproach.this.type

    File with the terms to be used for Obfuscation

    File with the terms to be used for Obfuscation

    Definition Classes
    DeidApproachParams
  174. def setRefSep(f: String): ObfuscatorAnnotatorApproach.this.type

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

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

    Definition Classes
    DeidApproachParams
  175. def setRegion(s: String): ObfuscatorAnnotatorApproach.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
  176. def setSameLengthFormattedEntities(entities: Array[String]): ObfuscatorAnnotatorApproach.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
  177. def setSeed(s: Int): ObfuscatorAnnotatorApproach.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
  178. def setSelectiveObfuscateRefSource(value: HashMap[String, String]): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    BaseDeidParams
  179. def setSelectiveObfuscateRefSource(value: Map[String, String]): ObfuscatorAnnotatorApproach.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"
 )
  180. def setStaticObfuscationPairs(pairs: ArrayList[ArrayList[String]]): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    BaseDeidParams
  181. def setStaticObfuscationPairs(pairs: Array[StaticObfuscationEntity]): ObfuscatorAnnotatorApproach.this.type
    Definition Classes
    BaseDeidParams
  182. def setStaticObfuscationPairs(pairs: Array[Array[String]]): ObfuscatorAnnotatorApproach.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
  183. def setStaticObfuscationPairsResource(path: String, readAs: Format, options: Map[String, String] = ...): ObfuscatorAnnotatorApproach.this.type

    Sets the static obfuscation pairs resource using a path and readAs format.

    Sets the static obfuscation pairs resource using a path and readAs format. The resource should contain three columns: original, entity, and fake. The delimiter for the columns can be specified in the options.

    path

    The path to the resource.

    readAs

    The format to read the resource (e.g., TEXT, SPARK).

    options

    Additional options for reading the resource, such as "format" and "delimiter". 'delimiter' and 'format' are required options.

    Definition Classes
    DeidApproachParams
  184. def setStaticObfuscationPairsResource(value: ExternalResource): ObfuscatorAnnotatorApproach.this.type

    Sets the static obfuscation pairs resource.

    Sets the static obfuscation pairs resource. The resource should contain three columns: original, entity, and fake. The delimiter for the columns can be specified in the options. The options must include a 'delimiter' key.

    Definition Classes
    DeidApproachParams
  185. def setUnnormalizedDateMode(mode: String): ObfuscatorAnnotatorApproach.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
  186. def setUseRandomDateDisplacement(s: Boolean): ObfuscatorAnnotatorApproach.this.type

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

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

    Definition Classes
    ObfuscatorParams
  187. def setUseShiftDays(s: Boolean): ObfuscatorAnnotatorApproach.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
    BaseDeidParams
  188. 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
  189. val staticObfuscationPairsResource: ExternalResourceParam

    Resource containing static obfuscation pairs.

    Resource containing static obfuscation pairs. The resource should contain three columns: original, entity, and fake. The delimiter for the columns can be specified in the options.

    Definition Classes
    DeidApproachParams
  190. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  191. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  192. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): ObfuscatorAnnotatorModel
    Definition Classes
    ObfuscatorAnnotatorApproach → AnnotatorApproach
  193. final def transformSchema(schema: StructType): StructType
    Definition Classes
    AnnotatorApproach → PipelineStage
  194. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  195. val uid: String
    Definition Classes
    ObfuscatorAnnotatorApproach → Identifiable
  196. 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
  197. val useRandomDateDisplacement: BooleanParam

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

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

    Definition Classes
    ObfuscatorParams
  198. 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
  199. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  200. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  201. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  202. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  203. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from ObfuscatorParams

Inherited from BaseDeidParams

Inherited from HasFeatures

Inherited from DeidApproachParams

Inherited from AnnotatorApproach[ObfuscatorAnnotatorModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[ObfuscatorAnnotatorModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

Parameters

Parameter setters

Ungrouped