c

com.johnsnowlabs.nlp.annotators.ner

NerConverterInternal

class NerConverterInternal extends AnnotatorApproach[NerConverterInternalModel] with SourceTrackingMetadataParams with HasFeatures with FilteringParams with CheckLicense

Converts IOB or IOB2 representations of entities to a user-friendly one.

This is the AnnotatorApproach version of the NerConverterInternalModel annotator.

Chunks with no associated entity (tagged "O") are filtered.

This licensed annotator adds extra functionality to the open-source version by adding the following parameters: blackList, greedyMode, threshold, and ignoreStopWords that are not available in the open-source annotator.

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, HasFeatures, SourceTrackingMetadataParams, ResetSentenceIndicesParam, AnnotatorApproach[NerConverterInternalModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[NerConverterInternalModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. NerConverterInternal
  2. CheckLicense
  3. FilteringParams
  4. HasFeatures
  5. SourceTrackingMetadataParams
  6. ResetSentenceIndicesParam
  7. AnnotatorApproach
  8. CanBeLazy
  9. DefaultParamsWritable
  10. MLWritable
  11. HasOutputAnnotatorType
  12. HasOutputAnnotationCol
  13. HasInputAnnotationCols
  14. Estimator
  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 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]): NerConverterInternalModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  10. 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
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  13. 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
  14. 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
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String]): Unit
    Definition Classes
    CheckLicense
  17. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  18. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  19. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  20. final def clear(param: Param[_]): NerConverterInternal.this.type
    Definition Classes
    Params
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. final def copy(extra: ParamMap): Estimator[NerConverterInternalModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  23. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. 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
  25. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  26. val description: String
    Definition Classes
    NerConverterInternal → AnnotatorApproach
  27. 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.

  28. 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
  29. lazy val entitiesConfidenceMap: Map[String, Float]
    Definition Classes
    FilteringParams
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  32. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  33. def explainParams(): String
    Definition Classes
    Params
  34. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  35. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  36. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  37. 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
  38. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. final def fit(dataset: Dataset[_]): NerConverterInternalModel
    Definition Classes
    AnnotatorApproach → Estimator
  40. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[NerConverterInternalModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  41. def fit(dataset: Dataset[_], paramMap: ParamMap): NerConverterInternalModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  42. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): NerConverterInternalModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  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 getResetSentenceIndices: Boolean

    Gets resetSentenceIndices parameter

    Gets resetSentenceIndices parameter

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

    Gets the confidence threshold

  64. def getWhiteList: Array[String]

    Gets whiteList parameter

    Gets whiteList parameter

    Definition Classes
    FilteringParams
  65. val greedyMode: BooleanParam

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

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

    If defined, list of stop words to ignore.

  71. 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
  72. 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
  73. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  74. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. val inputAnnotatorTypes: Array[String]

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

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

    Output Annotator Type : CHUNK

    Output Annotator Type : CHUNK

    Definition Classes
    NerConverterInternal → HasOutputAnnotatorType
  101. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  102. val outputColumnKey: Param[String]

    key name for the source column value

    key name for the source column value

    Definition Classes
    SourceTrackingMetadataParams
  103. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  104. val preservePosition: BooleanParam

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

  105. 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
  106. val replaceDictResource: ExternalResourceParam

    If defined, path to the file containing a dictionary for entity replacement

  107. val replaceLabels: CustomLabels

    If defined, contains a dictionary for entity replacement

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

    If defined, list of entities to ignore.

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

    Definition Classes
    FilteringParams
  126. def setCaseSensitive(value: Boolean): NerConverterInternal.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
  127. def setCriteria(s: String): NerConverterInternal.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
  128. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  129. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  130. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  131. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  132. final def setDefault(paramPairs: ParamPair[_]*): NerConverterInternal.this.type
    Attributes
    protected
    Definition Classes
    Params
  133. final def setDefault[T](param: Param[T], value: T): NerConverterInternal.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  134. def setDenyList(list: String*): NerConverterInternal.this.type
    Definition Classes
    FilteringParams
  135. def setDenyList(list: Array[String]): NerConverterInternal.this.type
    Definition Classes
    FilteringParams
  136. def setDoExceptionHandling(value: Boolean): NerConverterInternal.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.

  137. def setEntitiesConfidence(value: Map[String, Float]): NerConverterInternal.this.type
    Definition Classes
    FilteringParams
  138. def setFilterEntity(v: String): NerConverterInternal.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
  139. def setGreedyMode(value: Boolean): NerConverterInternal.this.type

    Sets the bool value for parameter greedyMode

  140. def setIgnoreStopWords(list: String*): NerConverterInternal.this.type

    Sets list of stopwords to ignore

  141. def setIncludeOutputColumn(v: Boolean): NerConverterInternal.this.type
    Definition Classes
    SourceTrackingMetadataParams
  142. def setIncludeStandardField(v: Boolean): NerConverterInternal.this.type
    Definition Classes
    SourceTrackingMetadataParams
  143. final def setInputCols(value: String*): NerConverterInternal.this.type
    Definition Classes
    HasInputAnnotationCols
  144. def setInputCols(value: Array[String]): NerConverterInternal.this.type
    Definition Classes
    HasInputAnnotationCols
  145. def setLazyAnnotator(value: Boolean): NerConverterInternal.this.type
    Definition Classes
    CanBeLazy
  146. final def setOutputCol(value: String): NerConverterInternal.this.type
    Definition Classes
    HasOutputAnnotationCol
  147. def setOutputColumnKey(v: String): NerConverterInternal.this.type
    Definition Classes
    SourceTrackingMetadataParams
  148. def setPreservePosition(value: Boolean): NerConverterInternal.this.type

    Sets the bool value for parameter preservePosition

  149. def setRegex(list: String*): NerConverterInternal.this.type

    Sets the list of regexes to process the chunks.

    Sets the list of regexes to process the chunks.

    Definition Classes
    FilteringParams
  150. def setReplaceDictResource(path: String, readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map("delimiter" -> ",")): NerConverterInternal.this.type

    Sets the external dictionary resource path with options

  151. def setReplaceDictResource(path: ExternalResource): NerConverterInternal.this.type

    Sets the external dictionary resource path

  152. def setReplaceLabels(labels: Map[String, String]): NerConverterInternal.this.type

    Sets the dictionary for entity replacement

  153. def setResetSentenceIndices(value: Boolean): NerConverterInternal.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
  154. def setStandardFieldKey(v: String): NerConverterInternal.this.type
    Definition Classes
    SourceTrackingMetadataParams
  155. def setThreshold(value: Float): NerConverterInternal.this.type

    Sets the confidence threshold

  156. def setWhiteList(list: String*): NerConverterInternal.this.type
    Definition Classes
    FilteringParams
  157. def setWhiteList(list: Array[String]): NerConverterInternal.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
  158. val standardFieldKey: Param[String]

    key name for the standard homogenized field

    key name for the standard homogenized field

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

    Confidence threshold

  161. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  162. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): NerConverterInternalModel
    Definition Classes
    NerConverterInternal → AnnotatorApproach
  163. def transformReplaceDict(replaceDict: Array[(String, String)]): Map[String, String]
  164. final def transformSchema(schema: StructType): StructType
    Definition Classes
    AnnotatorApproach → PipelineStage
  165. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  166. val uid: String
    Definition Classes
    NerConverterInternal → Identifiable
  167. def updateMetadataWithSource(metadata: Map[String, String]): Map[String, String]
    Definition Classes
    SourceTrackingMetadataParams
  168. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  169. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  170. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  171. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  172. 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
  173. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from CheckLicense

Inherited from FilteringParams

Inherited from HasFeatures

Inherited from SourceTrackingMetadataParams

Inherited from ResetSentenceIndicesParam

Inherited from AnnotatorApproach[NerConverterInternalModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[NerConverterInternalModel]

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