class NerConverterInternal extends AnnotatorModel[NerConverterInternal] with HasSimpleAnnotate[NerConverterInternal]

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[NerConverterInternal], AnnotatorModel[NerConverterInternal], CanBeLazy, RawAnnotator[NerConverterInternal], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[NerConverterInternal], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. NerConverterInternal
  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 NerConverterInternal()
  2. new NerConverterInternal(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
    NerConverterInternal → 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. final def clear(param: Param[_]): NerConverterInternal.this.type
    Definition Classes
    Params
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  17. def copy(extra: ParamMap): NerConverterInternal
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  18. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  19. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  24. def explainParams(): String
    Definition Classes
    Params
  25. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  26. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  27. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  28. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  29. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  30. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  32. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  33. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  34. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  35. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  36. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  37. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  38. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  39. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  40. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  41. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  42. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  43. def getThreshold: Float

    Get the Confidence threshold

  44. val greedyMode: BooleanParam

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

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

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

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

    Output Annotator Type : CHUNK

    Output Annotator Type : CHUNK

    Definition Classes
    NerConverterInternal → HasOutputAnnotatorType
  77. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  78. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  79. var parent: Estimator[NerConverterInternal]
    Definition Classes
    Model
  80. val preservePosition: BooleanParam

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

  81. val replaceDictResource: ExternalResourceParam
  82. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  83. def set[T](feature: StructFeature[T], value: T): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  84. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  85. def set[T](feature: SetFeature[T], value: Set[T]): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  86. def set[T](feature: ArrayFeature[T], value: Array[T]): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  87. final def set(paramPair: ParamPair[_]): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    Params
  88. final def set(param: String, value: Any): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    Params
  89. final def set[T](param: Param[T], value: T): NerConverterInternal.this.type
    Definition Classes
    Params
  90. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  94. final def setDefault(paramPairs: ParamPair[_]*): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    Params
  95. final def setDefault[T](param: Param[T], value: T): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    Params
  96. def setGreedyMode(value: Boolean): NerConverterInternal.this.type

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

  97. final def setInputCols(value: String*): NerConverterInternal.this.type
    Definition Classes
    HasInputAnnotationCols
  98. final def setInputCols(value: Array[String]): NerConverterInternal.this.type
    Definition Classes
    HasInputAnnotationCols
  99. def setLazyAnnotator(value: Boolean): NerConverterInternal.this.type
    Definition Classes
    CanBeLazy
  100. final def setOutputCol(value: String): NerConverterInternal.this.type
    Definition Classes
    HasOutputAnnotationCol
  101. def setParent(parent: Estimator[NerConverterInternal]): NerConverterInternal
    Definition Classes
    Model
  102. def setPreservePosition(value: Boolean): NerConverterInternal.this.type

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

  103. def setReplaceDictResource(path: String, readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map("delimiter" -> ",")): NerConverterInternal.this.type
  104. def setReplaceDictResource(path: ExternalResource): NerConverterInternal.this.type
  105. def setThreshold(value: Float): NerConverterInternal.this.type

    Set the Confidence threshold

  106. def setWhiteList(list: String*): NerConverterInternal.this.type

    If defined, list of entities to process.

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

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

    Confidence threshold

  109. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  110. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  111. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  112. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  113. def transformReplaceDict(replaceDict: Array[(String, String)]): Map[String, String]
  114. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  115. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  116. val uid: String
    Definition Classes
    NerConverterInternal → Identifiable
  117. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  118. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  120. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  121. 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

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

Inherited from HasSimpleAnnotate[NerConverterInternal]

Inherited from AnnotatorModel[NerConverterInternal]

Inherited from CanBeLazy

Inherited from RawAnnotator[NerConverterInternal]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[NerConverterInternal]

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