class NerConverterInternalModel extends AnnotatorModel[NerConverterInternalModel] with HasSimpleAnnotate[NerConverterInternalModel]

Converts a IOB or IOB2 representation of NER to a user-friendly one, by associating the tokens of recognized entities and their label. Chunks with no associated entity (tagged "O") are filtered. See also Inside–outside–beginning (tagging) for more information.

Example

The output of a MedicalNerModel follows the Annotator schema and looks like this after the transformation.

result.selectExpr("explode(ner_result)").show(5, false)
+--------------------------------------------------------------------------+
|col                                                                       |
+--------------------------------------------------------------------------+
|{named_entity, 3, 3, O, {word -> A, confidence -> 0.994}, []}             |
|{named_entity, 5, 15, B-Age, {word -> 63-year-old, confidence -> 1.0}, []}|
|{named_entity, 17, 19, B-Gender, {word -> man, confidence -> 0.9858}, []} |
|{named_entity, 21, 28, O, {word -> presents, confidence -> 0.9952}, []}   |
|{named_entity, 30, 31, O, {word -> to, confidence -> 0.7063}, []}         |
+--------------------------------------------------------------------------+

After the converter is used:

result.selectExpr("explode(ner_converter_result)").show(5, false)
+-----------------------------------------------------------------------------------+
|col                                                                                |
+-----------------------------------------------------------------------------------+
|{chunk, 5, 15, 63-year-old, {entity -> Age, sentence -> 0, chunk -> 0}, []}        |
|{chunk, 17, 19, man, {entity -> Gender, sentence -> 0, chunk -> 1}, []}            |
|{chunk, 64, 72, recurrent, {entity -> Modifier, sentence -> 0, chunk -> 2}, []}    |
|{chunk, 98, 107, cellulitis, {entity -> Diagnosis, sentence -> 0, chunk -> 3}, []} |
|{chunk, 110, 119, pneumonias, {entity -> Diagnosis, sentence -> 0, chunk -> 4}, []}|
+-----------------------------------------------------------------------------------+
See also

MedicalNerModel

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

Instance Constructors

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

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
    NerConverterInternalModel → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Definition Classes
    NerConverterInternalModel → AnnotatorModel
  14. val blackList: StringArrayParam
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. final def clear(param: Param[_]): NerConverterInternalModel.this.type
    Definition Classes
    Params
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. def copy(extra: ParamMap): NerConverterInternalModel
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  19. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  21. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  24. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  25. def explainParams(): String
    Definition Classes
    Params
  26. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  27. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  28. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  29. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  30. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  31. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  33. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  34. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  35. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  36. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  38. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  39. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  40. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  41. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  42. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  43. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  44. def getReplaceDict: Map[String, String]

    Mapping of replacement strings for entities.

  45. def getThreshold: Float

    Get the Confidence threshold

  46. val greedyMode: BooleanParam

    Whether to ignore B tags for contiguous tokens of same entity same

  47. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  48. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  49. def hasParent: Boolean
    Definition Classes
    Model
  50. lazy val hasThreshold: Boolean
  51. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  52. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  53. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. val inputAnnotatorTypes: Array[String]

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

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

    Output Annotator Type : CHUNK

    Output Annotator Type : CHUNK

    Definition Classes
    NerConverterInternalModel → HasOutputAnnotatorType
  80. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  81. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  82. var parent: Estimator[NerConverterInternalModel]
    Definition Classes
    Model
  83. val preservePosition: BooleanParam

    Whether to preserve the original position of the tokens in the original document or use the modified tokens

  84. val replaceDict: MapFeature[String, String]
  85. lazy val replaceDictMap: Map[String, String]
  86. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  87. def set[T](feature: StructFeature[T], value: T): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  88. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  89. def set[T](feature: SetFeature[T], value: Set[T]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. def set[T](feature: ArrayFeature[T], value: Array[T]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. final def set(paramPair: ParamPair[_]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  92. final def set(param: String, value: Any): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  93. final def set[T](param: Param[T], value: T): NerConverterInternalModel.this.type
    Definition Classes
    Params
  94. def setBlackList(list: String*): NerConverterInternalModel.this.type

    If defined, list of entities to ignore.

    If defined, list of entities to ignore. The rest will be processed. Do not include IOB prefix on labels

  95. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. final def setDefault(paramPairs: ParamPair[_]*): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  100. final def setDefault[T](param: Param[T], value: T): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. def setGreedyMode(value: Boolean): NerConverterInternalModel.this.type

    Whether to ignore B tags for contiguous tokens of same entity same

  102. final def setInputCols(value: String*): NerConverterInternalModel.this.type
    Definition Classes
    HasInputAnnotationCols
  103. def setInputCols(value: Array[String]): NerConverterInternalModel.this.type
    Definition Classes
    HasInputAnnotationCols
  104. def setLazyAnnotator(value: Boolean): NerConverterInternalModel.this.type
    Definition Classes
    CanBeLazy
  105. final def setOutputCol(value: String): NerConverterInternalModel.this.type
    Definition Classes
    HasOutputAnnotationCol
  106. def setParent(parent: Estimator[NerConverterInternalModel]): NerConverterInternalModel
    Definition Classes
    Model
  107. def setPreservePosition(value: Boolean): NerConverterInternalModel.this.type

    Whether to preserve the original position of the tokens in the original document or use the modified tokens

  108. def setReplaceDict(value: Map[String, String]): NerConverterInternalModel.this.type

    Mapping of replacement strings for entities.

  109. def setThreshold(value: Float): NerConverterInternalModel.this.type

    Set the Confidence threshold

  110. def setWhiteList(list: String*): NerConverterInternalModel.this.type

    If defined, list of entities to ignore.

    If defined, list of entities to ignore. The rest will be processed. Do not include IOB prefix on labels

  111. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  112. val threshold: FloatParam

    Confidence threshold

  113. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  114. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  115. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  116. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  117. def transformReplaceDict(replaceDict: Array[(String, String)]): Map[String, String]
  118. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  119. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  120. val uid: String
    Definition Classes
    NerConverterInternalModel → Identifiable
  121. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  122. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  123. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  124. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  125. val whiteList: StringArrayParam

    If defined, list of entities to process.

    If defined, list of entities to process. The rest will be ignored. Does not include IOB prefix on labels

  126. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  127. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasSimpleAnnotate[NerConverterInternalModel]

Inherited from AnnotatorModel[NerConverterInternalModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[NerConverterInternalModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[NerConverterInternalModel]

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

Parameters

Annotator types

Required input and expected output annotator types

Members

Parameter setters