Packages

class ChunkMergeModel extends AnnotatorModel[ChunkMergeModel] with CheckLicense with HasMultipleInputAnnotationCols with HasSimpleAnnotate[ChunkMergeModel] with MergeCommonParams with MergeFeatureParams with MergePrioritizationParams with HandleExceptionParams with HasSafeAnnotate[ChunkMergeModel] with HasFeatures with FilteringParams with ResetSentenceIndicesParam

Merges entities coming from different CHUNK annotations

Linear Supertypes
ResetSentenceIndicesParam, FilteringParams, HasSafeAnnotate[ChunkMergeModel], HandleExceptionParams, MergePrioritizationParams, MergeFeatureParams, MergeCommonParams, HasSimpleAnnotate[ChunkMergeModel], HasMultipleInputAnnotationCols, CheckLicense, AnnotatorModel[ChunkMergeModel], CanBeLazy, RawAnnotator[ChunkMergeModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[ChunkMergeModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ChunkMergeModel
  2. ResetSentenceIndicesParam
  3. FilteringParams
  4. HasSafeAnnotate
  5. HandleExceptionParams
  6. MergePrioritizationParams
  7. MergeFeatureParams
  8. MergeCommonParams
  9. HasSimpleAnnotate
  10. HasMultipleInputAnnotationCols
  11. CheckLicense
  12. AnnotatorModel
  13. CanBeLazy
  14. RawAnnotator
  15. HasOutputAnnotationCol
  16. HasInputAnnotationCols
  17. HasOutputAnnotatorType
  18. ParamsAndFeaturesWritable
  19. HasFeatures
  20. DefaultParamsWritable
  21. MLWritable
  22. Model
  23. Transformer
  24. PipelineStage
  25. Logging
  26. Params
  27. Serializable
  28. Serializable
  29. Identifiable
  30. AnyRef
  31. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    a unique identifier for the instantiated AnnotatorModel

Type Members

  1. type AnnotationContent = Seq[Row]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. type AnnotatorType = String
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    Merges columns of chunk Annotations while considering false positives and replacements.

    Merges columns of chunk Annotations while considering false positives and replacements.

    annotations

    a Sequence of chunks to merge

    returns

    a Sequence of Merged CHUNK Annotations

    Definition Classes
    ChunkMergeModel → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Definition Classes
    ChunkMergeModel → AnnotatorModel
  14. 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
  15. 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
  16. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  17. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String]): Unit
    Definition Classes
    CheckLicense
  18. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  19. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  20. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  21. 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
  22. 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
  23. final def clear(param: Param[_]): ChunkMergeModel.this.type
    Definition Classes
    Params
  24. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  25. def copy(extra: ParamMap): ChunkMergeModel
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  26. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  27. 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
  28. 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
  29. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  30. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  31. 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
  32. 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
  33. lazy val entitiesConfidenceMap: Map[String, Float]
    Definition Classes
    FilteringParams
  34. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  36. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  37. def explainParams(): String
    Definition Classes
    Params
  38. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  39. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  40. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  41. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  42. val falsePositives: ArrayFeature[(String, String, String)]

    Array of entity pairs that are false positives.

    Array of entity pairs that are false positives. If a third value is defined, the pair will be replaced by that value.

    Definition Classes
    MergeFeatureParams
  43. lazy val falsePositivesArray: Array[(String, String, String)]
  44. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  45. 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
  46. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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 getFalsePositives: Array[(String, String, String)]

    Array of entity pairs that are false positives.

    Array of entity pairs that are false positives. If a third value is defined, the pair will be replaced by that value.

    Definition Classes
    MergeFeatureParams
  60. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  61. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  62. def getMergeOverlapping: Boolean
    Definition Classes
    MergeCommonParams
  63. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  64. def getOrderingFeatures: Array[String]
    Definition Classes
    MergePrioritizationParams
  65. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  66. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  67. def getReplaceDict: Map[String, String]

    Mapping of replacement strings for entities.

    Mapping of replacement strings for entities.

    Definition Classes
    MergeFeatureParams
  68. def getReplaceDictStr: String

    Get the replacement strings for entities

    Get the replacement strings for entities

    Definition Classes
    MergeFeatureParams
  69. def getResetSentenceIndices: Boolean

    Gets resetSentenceIndices parameter

    Gets resetSentenceIndices parameter

    Definition Classes
    ResetSentenceIndicesParam
  70. def getSelectionStrategy: String
    Definition Classes
    MergePrioritizationParams
  71. def getWhiteList: Array[String]

    Gets whiteList parameter

    Gets whiteList parameter

    Definition Classes
    FilteringParams
  72. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  73. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  74. def hasParent: Boolean
    Definition Classes
    Model
  75. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  76. val inExceptionMode: Boolean
    Attributes
    protected
    Definition Classes
    HasSafeAnnotate
  77. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  78. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. val inputAnnotatorType: String

    Output annotator types: CHUNK, CHUNK

    Output annotator types: CHUNK, CHUNK

    Definition Classes
    ChunkMergeModel → HasMultipleInputAnnotationCols
  80. lazy val inputAnnotatorTypes: Array[String]
    Definition Classes
    HasMultipleInputAnnotationCols → HasInputAnnotationCols
  81. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  82. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  83. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  84. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  85. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  86. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  87. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  88. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  89. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  90. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  92. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  93. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  94. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  95. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  96. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  97. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  98. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  99. val mergeOverlapping: BooleanParam

    whether to merge overlapping matched chunks.

    whether to merge overlapping matched chunks. Defaults to true

    Definition Classes
    MergeCommonParams
  100. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  101. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  102. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  103. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  104. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  105. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  106. 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
  107. val outputAnnotatorType: AnnotatorType

    Input annotator types: CHUNK

    Input annotator types: CHUNK

    Definition Classes
    ChunkMergeModel → HasOutputAnnotatorType
  108. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  109. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  110. var parent: Estimator[ChunkMergeModel]
    Definition Classes
    Model
  111. def prioritize(annotations: Seq[Annotation]): Seq[Annotation]
    Attributes
    protected
    Definition Classes
    MergePrioritizationParams
  112. 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
  113. val replaceDict: MapFeature[String, String]

    Mapping of replacement strings for entities.

    Mapping of replacement strings for entities.

    Definition Classes
    MergeFeatureParams
  114. lazy val replaceDictMap: Map[String, String]
  115. 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
  116. 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
  117. def resolveFilter(chunkerAnnotations: Seq[Annotation]): Seq[Annotation]
    Attributes
    protected
    Definition Classes
    FilteringParams
  118. def resolveMergeFilter(a: Annotation, entityValue: String, falsePositivesArray: Array[(String, String, String)], replaceDictMap: Map[String, String] = Map.empty): Option[Annotation]
    Attributes
    protected
    Definition Classes
    FilteringParams
  119. def resolveWhiteListBlackListFilter(annotations: Seq[Annotation]): Seq[Annotation]
    Attributes
    protected
    Definition Classes
    FilteringParams
  120. def safeAnnotate(annotations: Seq[Annotation]): Seq[Annotation]

    A protected method designed to safely annotate a sequence of Annotation objects by handling exceptions.

    A protected method designed to safely annotate a sequence of Annotation objects by handling exceptions.

    annotations

    A sequence of Annotation.

    returns

    A sequence of Annotation objects after processing, potentially containing error annotations.

    Attributes
    protected
    Definition Classes
    HasSafeAnnotate
  121. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  122. 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
  123. def set[T](feature: StructFeature[T], value: T): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  124. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  125. def set[T](feature: SetFeature[T], value: Set[T]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  126. def set[T](feature: ArrayFeature[T], value: Array[T]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  127. final def set(paramPair: ParamPair[_]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  128. final def set(param: String, value: Any): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  129. final def set[T](param: Param[T], value: T): ChunkMergeModel.this.type
    Definition Classes
    Params
  130. def setAllowList(list: String*): ChunkMergeModel.this.type
    Definition Classes
    FilteringParams
  131. def setAllowList(list: Array[String]): ChunkMergeModel.this.type
    Definition Classes
    FilteringParams
  132. def setBlackList(list: String*): ChunkMergeModel.this.type
    Definition Classes
    FilteringParams
  133. def setBlackList(list: Array[String]): ChunkMergeModel.this.type

    If defined, list of entities to ignore.

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

    Definition Classes
    FilteringParams
  134. def setCaseSensitive(value: Boolean): ChunkMergeModel.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
  135. def setChunkPrecedence(m: String): ChunkMergeModel.this.type
    Definition Classes
    MergePrioritizationParams
  136. def setChunkPrecedenceValuePrioritization(m: Array[String]): ChunkMergeModel.this.type
    Definition Classes
    MergePrioritizationParams
  137. def setCriteria(s: String): ChunkMergeModel.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
  138. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  139. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  140. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  141. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  142. final def setDefault(paramPairs: ParamPair[_]*): ChunkMergeModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  143. final def setDefault[T](param: Param[T], value: T): ChunkMergeModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  144. def setDefaultConfidence(m: Float): ChunkMergeModel.this.type
    Definition Classes
    MergePrioritizationParams
  145. def setDenyList(list: String*): ChunkMergeModel.this.type
    Definition Classes
    FilteringParams
  146. def setDenyList(list: Array[String]): ChunkMergeModel.this.type
    Definition Classes
    FilteringParams
  147. def setDoExceptionHandling(value: Boolean): ChunkMergeModel.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
  148. def setEntitiesConfidence(value: Map[String, Float]): ChunkMergeModel.this.type
    Definition Classes
    FilteringParams
  149. def setFalsePositives(value: List[List[String]]): ChunkMergeModel.this.type

    Array of entity pairs that are false positives.

    Array of entity pairs that are false positives. If a third value is defined, the pair will be replaced by that value.

    Definition Classes
    MergeFeatureParams
  150. def setFalsePositives(value: Array[(String, String, String)]): ChunkMergeModel.this.type

    Array of entity pairs that are false positives.

    Array of entity pairs that are false positives. If a third value is defined, the pair will be replaced by that value.

    Definition Classes
    MergeFeatureParams
  151. def setFilterEntity(v: String): ChunkMergeModel.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
  152. def setInputCols(value: Array[String]): ChunkMergeModel.this.type
    Definition Classes
    HasMultipleInputAnnotationCols → HasInputAnnotationCols
  153. final def setInputCols(value: String*): ChunkMergeModel.this.type
    Definition Classes
    HasInputAnnotationCols
  154. def setLazyAnnotator(value: Boolean): ChunkMergeModel.this.type
    Definition Classes
    CanBeLazy
  155. def setMergeOverlapping(v: Boolean): ChunkMergeModel.this.type

    whether to merge overlapping matched chunks.

    whether to merge overlapping matched chunks.

    Definition Classes
    MergeCommonParams
  156. def setOrderingFeatures(m: Array[String]): ChunkMergeModel.this.type
    Definition Classes
    MergePrioritizationParams
  157. final def setOutputCol(value: String): ChunkMergeModel.this.type
    Definition Classes
    HasOutputAnnotationCol
  158. def setParent(parent: Estimator[ChunkMergeModel]): ChunkMergeModel
    Definition Classes
    Model
  159. def setRegex(list: String*): ChunkMergeModel.this.type

    Sets the list of regexes to process the chunks.

    Sets the list of regexes to process the chunks.

    Definition Classes
    FilteringParams
  160. def setReplaceDict(replaceDict: HashMap[String, String]): ChunkMergeModel.this.type

    Set the lists of entity pairs allowed for a given relation

    Set the lists of entity pairs allowed for a given relation

    Definition Classes
    MergeFeatureParams
  161. def setReplaceDict(value: Map[String, String]): ChunkMergeModel.this.type

    Mapping of replacement strings for entities.

    Mapping of replacement strings for entities.

    Definition Classes
    MergeFeatureParams
  162. def setResetSentenceIndices(value: Boolean): ChunkMergeModel.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
  163. def setSelectionStrategy(m: String): ChunkMergeModel.this.type
    Definition Classes
    MergePrioritizationParams
  164. def setWhiteList(list: String*): ChunkMergeModel.this.type
    Definition Classes
    FilteringParams
  165. def setWhiteList(list: Array[String]): ChunkMergeModel.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
  166. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  167. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  168. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  169. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  170. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  171. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  172. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  173. val uid: String
    Definition Classes
    ChunkMergeModel → Identifiable
  174. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  175. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  176. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  177. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  178. 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
  179. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  180. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from ResetSentenceIndicesParam

Inherited from FilteringParams

Inherited from HasSafeAnnotate[ChunkMergeModel]

Inherited from HandleExceptionParams

Inherited from MergePrioritizationParams

Inherited from MergeFeatureParams

Inherited from MergeCommonParams

Inherited from HasSimpleAnnotate[ChunkMergeModel]

Inherited from HasMultipleInputAnnotationCols

Inherited from CheckLicense

Inherited from AnnotatorModel[ChunkMergeModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[ChunkMergeModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[ChunkMergeModel]

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