class NerConverterInternalModel extends AnnotatorModel[NerConverterInternalModel] with HasSimpleAnnotate[NerConverterInternalModel] with SourceTrackingMetadataParams with FilteringParams with CheckLicense

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
CheckLicense, FilteringParams, SourceTrackingMetadataParams, ResetSentenceIndicesParam, 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. CheckLicense
  3. FilteringParams
  4. SourceTrackingMetadataParams
  5. ResetSentenceIndicesParam
  6. HasSimpleAnnotate
  7. AnnotatorModel
  8. CanBeLazy
  9. RawAnnotator
  10. HasOutputAnnotationCol
  11. HasInputAnnotationCols
  12. HasOutputAnnotatorType
  13. ParamsAndFeaturesWritable
  14. HasFeatures
  15. DefaultParamsWritable
  16. MLWritable
  17. Model
  18. Transformer
  19. PipelineStage
  20. Logging
  21. Params
  22. Serializable
  23. Serializable
  24. Identifiable
  25. AnyRef
  26. 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. val allPossibleFieldsToStandardize: StringArrayParam

    array with all possible fields containing the value to write in the standard field ordered by priority

    array with all possible fields containing the value to write in the standard field ordered by priority

    Definition Classes
    SourceTrackingMetadataParams
  12. def annotate(annotations: Seq[Annotation]): Seq[Annotation]
    Definition Classes
    NerConverterInternalModel → HasSimpleAnnotate
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Definition Classes
    NerConverterInternalModel → AnnotatorModel
  15. val blackList: StringArrayParam

    If defined, list of entities to ignore.

    If defined, list of entities to ignore. The rest will be processed

    Definition Classes
    FilteringParams
  16. val caseSensitive: BooleanParam

    Determines whether the definitions of the white listed and black listed entities are case sensitive or not.

    Determines whether the definitions of the white listed and black listed entities are case sensitive or not. If the filterValue is 'entity', 'caseSensitive' is always false. The default value is true, except: com.johnsnowlabs.nlp.annotators.chunker.AssertionFilterer

    Definition Classes
    FilteringParams
  17. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  18. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String]): Unit
    Definition Classes
    CheckLicense
  19. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  20. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  21. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  22. final def clear(param: Param[_]): NerConverterInternalModel.this.type
    Definition Classes
    Params
  23. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. def copy(extra: ParamMap): NerConverterInternalModel
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  25. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  26. val criteria: Param[String]

    It is used to how to compare black and white listed values with the result of the Annotation.

    It is used to how to compare black and white listed values with the result of the Annotation. Possible values are the following: 'isin', 'regex'. Default: isin

    • isin : Filter by the chunk
    • regex : Filter by using a regex
    Definition Classes
    FilteringParams
  27. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  28. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  29. val doExceptionHandling: BooleanParam

    If true, exceptions are handled.

    If true, exceptions are handled. If exception causing data is passed to the model, a error annotation is emitted which has the exception message. Processing continues with the next one. This comes with a performance penalty.

  30. val entitiesConfidence: MapFeature[String, Float]

    Pairs (entity,confidenceThreshold).

    Pairs (entity,confidenceThreshold). Filter the chunks with entities which have confidence lower than the confidence threshold.

    Definition Classes
    FilteringParams
  31. lazy val entitiesConfidenceMap: Map[String, Float]
    Definition Classes
    FilteringParams
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  34. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  35. def explainParams(): String
    Definition Classes
    Params
  36. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  37. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  38. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  39. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  40. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  41. val filterValue: Param[String]

    Possible values are 'result' and 'entity'.

    Possible values are 'result' and 'entity'. If the value is 'entity', it filters the ner chunks by the ner label that you want to filter. If the value is 'result', it will filter chunks by the result of the Annotation.

    Definition Classes
    FilteringParams
  42. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  43. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  44. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  45. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  46. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  47. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  48. def getAllPossibleFieldsToStandardize: Array[String]
    Definition Classes
    SourceTrackingMetadataParams
  49. def getBlackList: Array[String]

    Gets blackList parameter

    Gets blackList parameter

    Definition Classes
    FilteringParams
  50. def getCaseSensitive: Boolean

    Gets caseSensitive parameter

    Gets caseSensitive parameter

    Definition Classes
    FilteringParams
  51. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  52. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  53. def getIncludeOutputColumn: Boolean
    Definition Classes
    SourceTrackingMetadataParams
  54. def getIncludeStandardField: Boolean
    Definition Classes
    SourceTrackingMetadataParams
  55. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  56. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  57. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  58. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  59. def getOutputColumnKey: String
    Definition Classes
    SourceTrackingMetadataParams
  60. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  61. def getReplaceDict: Map[String, String]

    Mapping of replacement strings for entities.

  62. def getResetSentenceIndices: Boolean

    Gets resetSentenceIndices parameter

    Gets resetSentenceIndices parameter

    Definition Classes
    ResetSentenceIndicesParam
  63. def getStandardFieldKey: String
    Definition Classes
    SourceTrackingMetadataParams
  64. def getThreshold: Float

    Get the Confidence threshold

  65. def getWhiteList: Array[String]

    Gets whiteList parameter

    Gets whiteList parameter

    Definition Classes
    FilteringParams
  66. val greedyMode: BooleanParam

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

  67. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  68. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  69. def hasParent: Boolean
    Definition Classes
    Model
  70. lazy val hasThreshold: Boolean
  71. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  72. val ignoreStopWords: StringArrayParam

    If defined, list of stop words to ignore.

  73. val includeOutputColumn: BooleanParam

    whether or not to include a metadata key/value to specify the output column name for the annotation

    whether or not to include a metadata key/value to specify the output column name for the annotation

    Definition Classes
    SourceTrackingMetadataParams
  74. val includeStandardField: BooleanParam

    whether to standardize the metadata key for entity, useful for chunk columns

    whether to standardize the metadata key for entity, useful for chunk columns

    Definition Classes
    SourceTrackingMetadataParams
  75. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  76. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. val inputAnnotatorTypes: Array[String]

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

    Definition Classes
    NerConverterInternalModel → HasInputAnnotationCols
  78. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  79. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  80. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  81. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  82. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  83. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  84. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  85. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  86. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  87. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  88. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  89. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  90. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  92. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  93. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  94. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  95. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  96. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  97. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  98. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  99. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  100. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  101. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  102. val outputAnnotatorType: AnnotatorType

    Output Annotator Type : CHUNK

    Output Annotator Type : CHUNK

    Definition Classes
    NerConverterInternalModel → HasOutputAnnotatorType
  103. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  104. val outputColumnKey: Param[String]

    key name for the source column value

    key name for the source column value

    Definition Classes
    SourceTrackingMetadataParams
  105. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  106. var parent: Estimator[NerConverterInternalModel]
    Definition Classes
    Model
  107. val preservePosition: BooleanParam

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

  108. val regex: StringArrayParam

    If defined, list of regex to process the chunks (Default: Array())

    If defined, list of regex to process the chunks (Default: Array())

    Definition Classes
    FilteringParams
  109. val replaceDict: MapFeature[String, String]
  110. lazy val replaceDictMap: Map[String, String]
  111. def resetSentenceIndices(metadata: Map[String, String]): Map[String, String]

    Reset sentence index in metadata by adding "sentence" -> "0"

    Reset sentence index in metadata by adding "sentence" -> "0"

    Attributes
    protected
    Definition Classes
    ResetSentenceIndicesParam
  112. val resetSentenceIndices: BooleanParam

    Whether to reset sentence indices to treat the entire output as if it originates from a single document.

    Whether to reset sentence indices to treat the entire output as if it originates from a single document.

    When set to true, the metadata of each entity will be updated by assigning the sentence key a value of 0, effectively treating the entire output as if it comes from a single document, regardless of the original sentence boundaries. Default: False.

    Definition Classes
    ResetSentenceIndicesParam
  113. def resolveFilter(chunkerAnnotations: Seq[Annotation]): Seq[Annotation]
    Attributes
    protected
    Definition Classes
    FilteringParams
  114. def resolveMergeFilter(a: Annotation, entityValue: String, falsePositivesArray: Array[(String, String, String)], replaceDictMap: Map[String, String] = Map.empty): Option[Annotation]
    Attributes
    protected
    Definition Classes
    FilteringParams
  115. def resolveWhiteListBlackListFilter(annotations: Seq[Annotation]): Seq[Annotation]
    Attributes
    protected
    Definition Classes
    FilteringParams
  116. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  117. def set[T](feature: StructFeature[T], value: T): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  118. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  119. def set[T](feature: SetFeature[T], value: Set[T]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  120. def set[T](feature: ArrayFeature[T], value: Array[T]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  121. final def set(paramPair: ParamPair[_]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  122. final def set(param: String, value: Any): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  123. final def set[T](param: Param[T], value: T): NerConverterInternalModel.this.type
    Definition Classes
    Params
  124. def setAllPossibleFieldsToStandardize(v: Array[String]): NerConverterInternalModel.this.type
    Definition Classes
    SourceTrackingMetadataParams
  125. def setAllowList(list: String*): NerConverterInternalModel.this.type
    Definition Classes
    FilteringParams
  126. def setAllowList(list: Array[String]): NerConverterInternalModel.this.type
    Definition Classes
    FilteringParams
  127. def setBlackList(list: String*): NerConverterInternalModel.this.type
    Definition Classes
    FilteringParams
  128. def setBlackList(list: Array[String]): NerConverterInternalModel.this.type

    If defined, list of entities to ignore.

    If defined, list of entities to ignore. The rest will be processed.

    Definition Classes
    FilteringParams
  129. def setCaseSensitive(value: Boolean): NerConverterInternalModel.this.type

    Determines whether the definitions of the white listed and black listed entities are case sensitive or not.

    Determines whether the definitions of the white listed and black listed entities are case sensitive or not. If the filterValue is 'entity', 'caseSensitive' is always False. The default value is true, except: com.johnsnowlabs.nlp.annotators.chunker.AssertionFilterer

    Definition Classes
    FilteringParams
  130. def setCriteria(s: String): NerConverterInternalModel.this.type

    Sets criteria for how to compare black and white listed values with the result of the Annotation.

    Sets criteria for how to compare black and white listed values with the result of the Annotation. Possible values are the following: 'isin', 'regex'. Default: isin.

    Definition Classes
    FilteringParams
  131. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  132. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  133. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  134. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  135. final def setDefault(paramPairs: ParamPair[_]*): NerConverterInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  136. final def setDefault[T](param: Param[T], value: T): NerConverterInternalModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  137. def setDenyList(list: String*): NerConverterInternalModel.this.type
    Definition Classes
    FilteringParams
  138. def setDenyList(list: Array[String]): NerConverterInternalModel.this.type
    Definition Classes
    FilteringParams
  139. def setDoExceptionHandling(value: Boolean): NerConverterInternalModel.this.type

    If true, exceptions are handled.

    If true, exceptions are handled. If exception causing data is passed to the model, a error annotation is emitted which has the exception message. Processing continues with the next one. This comes with a performance penalty.

  140. def setEntitiesConfidence(value: Map[String, Float]): NerConverterInternalModel.this.type
    Definition Classes
    FilteringParams
  141. def setFilterEntity(v: String): NerConverterInternalModel.this.type

    Possible values are 'result' and 'entity'.

    Possible values are 'result' and 'entity'. If the value is 'entity', it filters the ner chunks by the ner label that you want to filter. If the value is 'result', it will filter chunks by the result of the Annotation.

    Definition Classes
    FilteringParams
  142. def setGreedyMode(value: Boolean): NerConverterInternalModel.this.type

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

  143. def setIgnoreStopWords(list: String*): NerConverterInternalModel.this.type

    If defined, list of stop words to ignore.

  144. def setIncludeOutputColumn(v: Boolean): NerConverterInternalModel.this.type
    Definition Classes
    SourceTrackingMetadataParams
  145. def setIncludeStandardField(v: Boolean): NerConverterInternalModel.this.type
    Definition Classes
    SourceTrackingMetadataParams
  146. final def setInputCols(value: String*): NerConverterInternalModel.this.type
    Definition Classes
    HasInputAnnotationCols
  147. def setInputCols(value: Array[String]): NerConverterInternalModel.this.type
    Definition Classes
    HasInputAnnotationCols
  148. def setLazyAnnotator(value: Boolean): NerConverterInternalModel.this.type
    Definition Classes
    CanBeLazy
  149. final def setOutputCol(value: String): NerConverterInternalModel.this.type
    Definition Classes
    HasOutputAnnotationCol
  150. def setOutputColumnKey(v: String): NerConverterInternalModel.this.type
    Definition Classes
    SourceTrackingMetadataParams
  151. def setParent(parent: Estimator[NerConverterInternalModel]): NerConverterInternalModel
    Definition Classes
    Model
  152. 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

  153. def setRegex(list: String*): NerConverterInternalModel.this.type

    Sets the list of regexes to process the chunks.

    Sets the list of regexes to process the chunks.

    Definition Classes
    FilteringParams
  154. def setReplaceDict(value: Map[String, String]): NerConverterInternalModel.this.type

    Mapping of replacement strings for entities.

  155. def setResetSentenceIndices(value: Boolean): NerConverterInternalModel.this.type

    Set whether to reset sentence indices to treat the entire output as if it originates from a single document.

    Set whether to reset sentence indices to treat the entire output as if it originates from a single document.

    When set to true, the metadata of each entity will be updated by assigning the sentence key a value of 0, effectively treating the entire output as if it comes from a single document, regardless of the original sentence boundaries. Default: False.

    Definition Classes
    ResetSentenceIndicesParam
  156. def setStandardFieldKey(v: String): NerConverterInternalModel.this.type
    Definition Classes
    SourceTrackingMetadataParams
  157. def setThreshold(value: Float): NerConverterInternalModel.this.type

    Set the Confidence threshold

  158. def setWhiteList(list: String*): NerConverterInternalModel.this.type
    Definition Classes
    FilteringParams
  159. def setWhiteList(list: Array[String]): NerConverterInternalModel.this.type

    Sets the list of entities to process.

    Sets the list of entities to process. The rest will be ignored. Do not include IOB prefix on labels.

    Definition Classes
    FilteringParams
  160. val standardFieldKey: Param[String]

    key name for the standard homogenized field

    key name for the standard homogenized field

    Definition Classes
    SourceTrackingMetadataParams
  161. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  162. val threshold: FloatParam

    Confidence threshold

  163. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  164. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  165. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  166. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  167. def transformReplaceDict(replaceDict: Array[(String, String)]): Map[String, String]
  168. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  169. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  170. val uid: String
    Definition Classes
    NerConverterInternalModel → Identifiable
  171. def updateMetadataWithSource(metadata: Map[String, String]): Map[String, String]
    Definition Classes
    SourceTrackingMetadataParams
  172. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  173. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  174. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  175. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  176. 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 (Default: Array())

    Definition Classes
    FilteringParams
  177. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  178. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from CheckLicense

Inherited from FilteringParams

Inherited from SourceTrackingMetadataParams

Inherited from ResetSentenceIndicesParam

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

Parameter getters