class ReIdentification extends AnnotatorModel[DeIdentificationModel] with HasSimpleAnnotate[DeIdentificationModel] with CheckLicense

Reidentifies obfuscated entities by DeIdentification. This annotator requires the outputs from the deidentification as input. Input columns need to be the deidentified document and the deidentification mappings set with DeIdentification.setMappingsColumn. To see how the entities are deidentified, please refer to the example of that class.

Example

Define the reidentification stage and transform the deidentified documents

val reideintification = new ReIdentification()
  .setInputCols("dei", "protectedEntities")
  .setOutputCol("reid")
  .transform(result)

Show results

result.select("dei.result").show(truncate = false)
+--------------------------------------------------------------------------------------------------+
|result                                                                                            |
+--------------------------------------------------------------------------------------------------+
|[# 01010101 Date : 01/18/93 PCP : Dr. Gregory House , <AGE> years-old , Record date : 2079-11-14.]|
+--------------------------------------------------------------------------------------------------+

reideintification.selectExpr("explode(reid.result)").show(false)
+-----------------------------------------------------------------------------------+
|col                                                                                |
+-----------------------------------------------------------------------------------+
|# 7194334 Date : 01/13/93 PCP : Oliveira , 25 years-old , Record date : 2079-11-09.|
+-----------------------------------------------------------------------------------+
See also

DeIdentification for deidentification of entities

Linear Supertypes
CheckLicense, HasSimpleAnnotate[DeIdentificationModel], AnnotatorModel[DeIdentificationModel], CanBeLazy, RawAnnotator[DeIdentificationModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[DeIdentificationModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ReIdentification
  2. CheckLicense
  3. HasSimpleAnnotate
  4. AnnotatorModel
  5. CanBeLazy
  6. RawAnnotator
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. HasOutputAnnotatorType
  10. ParamsAndFeaturesWritable
  11. HasFeatures
  12. DefaultParamsWritable
  13. MLWritable
  14. Model
  15. Transformer
  16. PipelineStage
  17. Logging
  18. Params
  19. Serializable
  20. Serializable
  21. Identifiable
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    a unique identifier for the instantiated AnnotatorModel

Type Members

  1. type AnnotationContent = Seq[Row]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. 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 _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]
    Definition Classes
    ReIdentification → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. def checkValidEnvironment(spark: Option[SparkContext]): Unit
    Definition Classes
    CheckLicense
  16. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  17. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkContext], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  18. final def clear(param: Param[_]): ReIdentification.this.type
    Definition Classes
    Params
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. def copy(extra: ParamMap): DeIdentificationModel
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  21. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  22. def createReidentificationSentence(reidentification: String, offset: Int): Annotation
  23. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  28. def explainParams(): String
    Definition Classes
    Params
  29. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  30. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  31. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  32. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  33. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  34. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  36. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  40. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  41. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  42. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  43. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  44. def getNerEntitiesBySentence(annotations: Seq[Annotation], sentenceCount: Int): Seq[Seq[Annotation]]

    Returns the NER Annotations for each Annotation instance in the input Sequence

    Returns the NER Annotations for each Annotation instance in the input Sequence

    annotations

    a Sequence of Annotation instances

    returns

    a Sequence of Sequence[IndexedToken], each Sequence represents tokens from each input Annotation

  45. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  46. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  47. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  48. def getSentences(annotations: Seq[Annotation]): Seq[MySentnece]
  49. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  50. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  51. def hasParent: Boolean
    Definition Classes
    Model
  52. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  53. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  54. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. val inputAnnotatorTypes: Array[String]

    Input annotator types: DOCUMENT,CHUNK

    Input annotator types: DOCUMENT,CHUNK

    Definition Classes
    ReIdentification → HasInputAnnotationCols
  56. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  57. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  58. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  59. def isLp(): Boolean
    Definition Classes
    CheckLicense
  60. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  61. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  62. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  63. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  64. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  71. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def makeSentence(chunk: Annotation, sentence: String, originalSencece: MySentnece): String
  76. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  77. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  78. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  79. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  80. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  81. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  82. val outputAnnotatorType: AnnotatorType

    Output annotator types: DOCUMENT

    Output annotator types: DOCUMENT

    Definition Classes
    ReIdentification → HasOutputAnnotatorType
  83. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  84. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  85. var parent: Estimator[DeIdentificationModel]
    Definition Classes
    Model
  86. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  87. def set[T](feature: StructFeature[T], value: T): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  88. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  89. def set[T](feature: SetFeature[T], value: Set[T]): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. def set[T](feature: ArrayFeature[T], value: Array[T]): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. final def set(paramPair: ParamPair[_]): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    Params
  92. final def set(param: String, value: Any): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    Params
  93. final def set[T](param: Param[T], value: T): ReIdentification.this.type
    Definition Classes
    Params
  94. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  95. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. final def setDefault(paramPairs: ParamPair[_]*): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    Params
  99. final def setDefault[T](param: Param[T], value: T): ReIdentification.this.type
    Attributes
    protected
    Definition Classes
    Params
  100. final def setInputCols(value: String*): ReIdentification.this.type
    Definition Classes
    HasInputAnnotationCols
  101. final def setInputCols(value: Array[String]): ReIdentification.this.type
    Definition Classes
    HasInputAnnotationCols
  102. def setLazyAnnotator(value: Boolean): ReIdentification.this.type
    Definition Classes
    CanBeLazy
  103. final def setOutputCol(value: String): ReIdentification.this.type
    Definition Classes
    HasOutputAnnotationCol
  104. def setParent(parent: Estimator[DeIdentificationModel]): DeIdentificationModel
    Definition Classes
    Model
  105. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  106. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  107. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  108. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  109. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  110. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  111. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  112. val uid: String
    Definition Classes
    ReIdentification → Identifiable
  113. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  114. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  115. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  116. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  117. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  118. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from CheckLicense

Inherited from HasSimpleAnnotate[DeIdentificationModel]

Inherited from AnnotatorModel[DeIdentificationModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[DeIdentificationModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[DeIdentificationModel]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Annotator types

Required input and expected output annotator types

Members