Packages

c

com.johnsnowlabs.nlp.annotators.merge

ChunkMergeApproach

class ChunkMergeApproach extends AnnotatorApproach[ChunkMergeModel] with CheckLicense with HasMultipleInputAnnotationCols with MergeResourceParams with MergeCommonParams with MergePrioritizationParams with HasFeatures with FilteringParams with HandleExceptionParams with ResetSentenceIndicesParam

Merges two chunk columns coming from two annotators(NER, ContextualParser or any other annotator producing chunks). The merger of the two chunk columns is made by selecting one chunk from one of the columns according to certain criteria. The decision on which chunk to select is made according to the chunk indices in the source document. (chunks with longer lengths and highest information will be kept from each source) Labels can be changed by setReplaceDictResource.

Example

Define a pipeline with 2 different NER models with a ChunkMergeApproach at the end

val data = Seq(("A 63-year-old man presents to the hospital ...")).toDF("text")
val pipeline = new Pipeline().setStages(Array(
  new DocumentAssembler().setInputCol("text").setOutputCol("document"),
  new SentenceDetector().setInputCols("document").setOutputCol("sentence"),
  new Tokenizer().setInputCols("sentence").setOutputCol("token"),
  WordEmbeddingsModel.pretrained("embeddings_clinical", "en", "clinical/models").setOutputCol("embs"),
  MedicalNerModel.pretrained("ner_jsl", "en", "clinical/models")
    .setInputCols("sentence", "token", "embs").setOutputCol("jsl_ner"),
  new NerConverter().setInputCols("sentence", "token", "jsl_ner").setOutputCol("jsl_ner_chunk"),
  MedicalNerModel.pretrained("ner_bionlp", "en", "clinical/models")
    .setInputCols("sentence", "token", "embs").setOutputCol("bionlp_ner"),
  new NerConverter().setInputCols("sentence", "token", "bionlp_ner")
    .setOutputCol("bionlp_ner_chunk"),
  new ChunkMergeApproach().setInputCols("jsl_ner_chunk", "bionlp_ner_chunk").setOutputCol("merged_chunk")
))

Show results

val result = pipeline.fit(data).transform(data).cache()
result.selectExpr("explode(merged_chunk) as a")
  .selectExpr("a.begin","a.end","a.result as chunk","a.metadata.entity as entity")
  .show(5, false)
+-----+---+-----------+---------+
|begin|end|chunk      |entity   |
+-----+---+-----------+---------+
|5    |15 |63-year-old|Age      |
|17   |19 |man        |Gender   |
|64   |72 |recurrent  |Modifier |
|98   |107|cellulitis |Diagnosis|
|110  |119|pneumonias |Diagnosis|
+-----+---+-----------+---------+
Linear Supertypes
ResetSentenceIndicesParam, HandleExceptionParams, FilteringParams, HasFeatures, MergePrioritizationParams, MergeCommonParams, MergeResourceParams, HasMultipleInputAnnotationCols, CheckLicense, AnnotatorApproach[ChunkMergeModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[ChunkMergeModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ChunkMergeApproach
  2. ResetSentenceIndicesParam
  3. HandleExceptionParams
  4. FilteringParams
  5. HasFeatures
  6. MergePrioritizationParams
  7. MergeCommonParams
  8. MergeResourceParams
  9. HasMultipleInputAnnotationCols
  10. CheckLicense
  11. AnnotatorApproach
  12. CanBeLazy
  13. DefaultParamsWritable
  14. MLWritable
  15. HasOutputAnnotatorType
  16. HasOutputAnnotationCol
  17. HasInputAnnotationCols
  18. Estimator
  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 ChunkMergeApproach()
  2. new ChunkMergeApproach(uid: String)

    uid

    a unique identifier for the instantiated AnnotatorModel

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]): ChunkMergeModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  12. 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
  13. 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
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String]): Unit
    Definition Classes
    CheckLicense
  16. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  17. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  18. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  19. val chunkPrecedence: Param[String]

    When ChunkPrecedence ordering feature is used this param contains the comma separated metadata fields that drive prioritization of overlapping annotations.

    When ChunkPrecedence ordering feature is used this param contains the comma separated metadata fields that drive prioritization of overlapping annotations. When used by itself (empty chunkPrecedenceValuePrioritization) annotations will be prioritized based on number of metadata fields present. When used together with chunkPrecedenceValuePrioritization param it will prioritize based on the order of its values.

    Definition Classes
    MergePrioritizationParams
  20. val chunkPrecedenceValuePrioritization: StringArrayParam

    When ChunkPrecedence ordering feature is used this param contains an Array of comma separated strings representing the desired order of prioritization for the values in the metadata fields included in chunkPrecedence.

    When ChunkPrecedence ordering feature is used this param contains an Array of comma separated strings representing the desired order of prioritization for the values in the metadata fields included in chunkPrecedence.

    Definition Classes
    MergePrioritizationParams
  21. final def clear(param: Param[_]): ChunkMergeApproach.this.type
    Definition Classes
    Params
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. final def copy(extra: ParamMap): Estimator[ChunkMergeModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  24. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  25. 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
  26. val defaultConfidence: FloatParam

    When ChunkConfidence ordering feature is included and a given annotation does not have any confidence the value of this param will be used.

    When ChunkConfidence ordering feature is included and a given annotation does not have any confidence the value of this param will be used.

    Definition Classes
    MergePrioritizationParams
  27. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  28. val description: String
    Definition Classes
    ChunkMergeApproach → AnnotatorApproach
  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.

    Definition Classes
    HandleExceptionParams
  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. val entitiesConfidenceResource: ExternalResourceParam

    Path to csv with entity pairs to remove chunks based on the confidance level

    Path to csv with entity pairs to remove chunks based on the confidance level

    Definition Classes
    MergeResourceParams
  33. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  35. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  36. def explainParams(): String
    Definition Classes
    Params
  37. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  38. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  39. val falsePositivesResource: ExternalResourceParam

    Path to csv with false positive text, entity pairs to remove

    Path to csv with false positive text, entity pairs to remove

    Definition Classes
    MergeResourceParams
  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. final def fit(dataset: Dataset[_]): ChunkMergeModel
    Definition Classes
    AnnotatorApproach → Estimator
  44. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[ChunkMergeModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  45. def fit(dataset: Dataset[_], paramMap: ParamMap): ChunkMergeModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  46. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): ChunkMergeModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  47. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  48. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  49. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  50. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  51. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  52. def getBlackList: Array[String]

    Gets blackList parameter

    Gets blackList parameter

    Definition Classes
    FilteringParams
  53. def getCaseSensitive: Boolean

    Gets caseSensitive parameter

    Gets caseSensitive parameter

    Definition Classes
    FilteringParams
  54. def getChunkPrecedence: String
    Definition Classes
    MergePrioritizationParams
  55. def getChunkPrecedenceValuePrioritization: Array[String]
    Definition Classes
    MergePrioritizationParams
  56. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  57. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  58. def getDefaultConfidence: Float
    Definition Classes
    MergePrioritizationParams
  59. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  60. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  61. def getMergeOverlapping: Boolean
    Definition Classes
    MergeCommonParams
  62. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  63. def getOrderingFeatures: Array[String]
    Definition Classes
    MergePrioritizationParams
  64. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  65. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  66. def getResetSentenceIndices: Boolean

    Gets resetSentenceIndices parameter

    Gets resetSentenceIndices parameter

    Definition Classes
    ResetSentenceIndicesParam
  67. def getSelectionStrategy: String
    Definition Classes
    MergePrioritizationParams
  68. def getWhiteList: Array[String]

    Gets whiteList parameter

    Gets whiteList parameter

    Definition Classes
    FilteringParams
  69. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  70. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  71. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  72. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  73. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. val inputAnnotatorType: String

    Output annotator types: CHUNK, CHUNK

    Output annotator types: CHUNK, CHUNK

    Definition Classes
    ChunkMergeApproach → HasMultipleInputAnnotationCols
  75. lazy val inputAnnotatorTypes: Array[String]
    Definition Classes
    HasMultipleInputAnnotationCols → 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. val mergeOverlapping: BooleanParam

    whether to merge overlapping matched chunks.

    whether to merge overlapping matched chunks. Defaults to true

    Definition Classes
    MergeCommonParams
  95. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  96. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  97. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  98. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  99. def onTrained(model: ChunkMergeModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  100. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  101. val orderingFeatures: StringArrayParam

    Array of strings specifying the ordering features to use for overlapping entities.

    Array of strings specifying the ordering features to use for overlapping entities. Possible values are ChunkBegin, ChunkLength, ChunkPrecedence, ChunkConfidence.

    Definition Classes
    MergePrioritizationParams
  102. val outputAnnotatorType: AnnotatorType

    Input annotator types: CHUNK

    Input annotator types: CHUNK

    Definition Classes
    ChunkMergeApproach → HasOutputAnnotatorType
  103. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  104. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  105. def prioritize(annotations: Seq[Annotation]): Seq[Annotation]
    Attributes
    protected
    Definition Classes
    MergePrioritizationParams
  106. 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
  107. val replaceDictResource: ExternalResourceParam

    dictionary with regular expression patterns that match some protected entity TODO: is this regex?

    dictionary with regular expression patterns that match some protected entity TODO: is this regex?

    Definition Classes
    MergeResourceParams
  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. val selectionStrategy: Param[String]

    Whether to select annotations sequentially based on annotation order (Sequential) or using any other available strategy; currently only Sequential and DiverseLonger are available.

    Whether to select annotations sequentially based on annotation order (Sequential) or using any other available strategy; currently only Sequential and DiverseLonger are available.

    Definition Classes
    MergePrioritizationParams
  115. def set[T](feature: StructFeature[T], value: T): ChunkMergeApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  116. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ChunkMergeApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  117. def set[T](feature: SetFeature[T], value: Set[T]): ChunkMergeApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  118. def set[T](feature: ArrayFeature[T], value: Array[T]): ChunkMergeApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  119. final def set(paramPair: ParamPair[_]): ChunkMergeApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  120. final def set(param: String, value: Any): ChunkMergeApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  121. final def set[T](param: Param[T], value: T): ChunkMergeApproach.this.type
    Definition Classes
    Params
  122. def setAllowList(list: String*): ChunkMergeApproach.this.type
    Definition Classes
    FilteringParams
  123. def setAllowList(list: Array[String]): ChunkMergeApproach.this.type
    Definition Classes
    FilteringParams
  124. def setBlackList(list: String*): ChunkMergeApproach.this.type
    Definition Classes
    FilteringParams
  125. def setBlackList(list: Array[String]): ChunkMergeApproach.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): ChunkMergeApproach.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 setChunkPrecedence(m: String): ChunkMergeApproach.this.type
    Definition Classes
    MergePrioritizationParams
  128. def setChunkPrecedenceValuePrioritization(m: Array[String]): ChunkMergeApproach.this.type
    Definition Classes
    MergePrioritizationParams
  129. def setCriteria(s: String): ChunkMergeApproach.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
  130. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ChunkMergeApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  131. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ChunkMergeApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  132. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ChunkMergeApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  133. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ChunkMergeApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  134. final def setDefault(paramPairs: ParamPair[_]*): ChunkMergeApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  135. final def setDefault[T](param: Param[T], value: T): ChunkMergeApproach.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  136. def setDefaultConfidence(m: Float): ChunkMergeApproach.this.type
    Definition Classes
    MergePrioritizationParams
  137. def setDenyList(list: String*): ChunkMergeApproach.this.type
    Definition Classes
    FilteringParams
  138. def setDenyList(list: Array[String]): ChunkMergeApproach.this.type
    Definition Classes
    FilteringParams
  139. def setDoExceptionHandling(value: Boolean): ChunkMergeApproach.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.

    Definition Classes
    HandleExceptionParams
  140. def setEntitiesConfidence(value: HashMap[String, Double]): ChunkMergeApproach.this.type

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

  141. def setEntitiesConfidence(value: Map[String, Float]): ChunkMergeApproach.this.type
    Definition Classes
    FilteringParams
  142. def setEntitiesConfidenceResource(path: String, readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map("delimiter" -> ",")): ChunkMergeApproach.this.type
    Definition Classes
    MergeResourceParams
  143. def setFalsePositivesResource(path: String, readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map("delimiter" -> ",")): ChunkMergeApproach.this.type

    Path to csv with false positive text, entity pairs to remove

    Path to csv with false positive text, entity pairs to remove

    Definition Classes
    MergeResourceParams
  144. def setFilterEntity(v: String): ChunkMergeApproach.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
  145. def setInputCols(value: Array[String]): ChunkMergeApproach.this.type
    Definition Classes
    HasMultipleInputAnnotationCols → HasInputAnnotationCols
  146. final def setInputCols(value: String*): ChunkMergeApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  147. def setLazyAnnotator(value: Boolean): ChunkMergeApproach.this.type
    Definition Classes
    CanBeLazy
  148. def setMergeOverlapping(v: Boolean): ChunkMergeApproach.this.type

    whether to merge overlapping matched chunks.

    whether to merge overlapping matched chunks.

    Definition Classes
    MergeCommonParams
  149. def setOrderingFeatures(m: Array[String]): ChunkMergeApproach.this.type
    Definition Classes
    MergePrioritizationParams
  150. final def setOutputCol(value: String): ChunkMergeApproach.this.type
    Definition Classes
    HasOutputAnnotationCol
  151. def setRegex(list: String*): ChunkMergeApproach.this.type

    Sets the list of regexes to process the chunks.

    Sets the list of regexes to process the chunks.

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

    dictionary with regular expression patterns that match some protected entity

    dictionary with regular expression patterns that match some protected entity

    Definition Classes
    MergeResourceParams
  153. def setReplaceDictResource(path: ExternalResource): ChunkMergeApproach.this.type

    dictionary with regular expression patterns that match some protected entity

    dictionary with regular expression patterns that match some protected entity

    Definition Classes
    MergeResourceParams
  154. def setResetSentenceIndices(value: Boolean): ChunkMergeApproach.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
  155. def setSelectionStrategy(m: String): ChunkMergeApproach.this.type
    Definition Classes
    MergePrioritizationParams
  156. def setWhiteList(list: String*): ChunkMergeApproach.this.type
    Definition Classes
    FilteringParams
  157. def setWhiteList(list: Array[String]): ChunkMergeApproach.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. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  159. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  160. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): ChunkMergeModel

    Trains a model from the provided dataset.

    Trains a model from the provided dataset. Input columns should be set to output columns from e.g. a NerDLModel and a RegexMatcher.

    Definition Classes
    ChunkMergeApproach → AnnotatorApproach
  161. def transformEntitiesConfidenceResource(): Map[String, Float]
    Attributes
    protected
    Definition Classes
    MergeResourceParams
  162. def transformFalsePositivesResource(): Array[(String, String, String)]
    Attributes
    protected
    Definition Classes
    MergeResourceParams
  163. def transformReplaceDict(replaceDict: Array[(String, String)]): Map[String, String]
  164. def transformReplaceDictResource(): Array[(String, String)]
    Attributes
    protected
    Definition Classes
    MergeResourceParams
  165. final def transformSchema(schema: StructType): StructType
    Definition Classes
    AnnotatorApproach → PipelineStage
  166. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  167. val uid: String
    Definition Classes
    ChunkMergeApproach → Identifiable
  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 ResetSentenceIndicesParam

Inherited from HandleExceptionParams

Inherited from FilteringParams

Inherited from HasFeatures

Inherited from MergePrioritizationParams

Inherited from MergeCommonParams

Inherited from MergeResourceParams

Inherited from HasMultipleInputAnnotationCols

Inherited from CheckLicense

Inherited from AnnotatorApproach[ChunkMergeModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[ChunkMergeModel]

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