class ChunkConverter extends AnnotatorModel[ChunkConverter] with HasSimpleAnnotate[ChunkConverter] with SourceTrackingMetadataParams with CheckLicense

Convert chunks from regexMatcher to chunks with a entity in the metadata. Use the identifier or field as a entity.

Example

  val sampleDataset = ResourceHelper.spark.createDataFrame(Seq(
    (1, "My first sentence with the first rule. This is my second sentence with ceremonies rule.")
  )).toDF("id", "text")

  val documentAssembler = new DocumentAssembler().setInputCol("text").setOutputCol("document")

  val sentence = new SentenceDetector().setInputCols("document").setOutputCol("sentence")

  val regexMatcher = new RegexMatcher()
    .setExternalRules(ExternalResource("src/test/resources/regex-matcher/rules.txt", ReadAs.TEXT, Map("delimiter" -> ",")))
    .setInputCols(Array("sentence"))
    .setOutputCol("regex")
    .setStrategy(strategy)

  val chunkConverter = new ChunkConverter().setInputCols("regex").setOutputCol("chunk")

  val pipeline = new Pipeline().setStages(Array(documentAssembler, sentence, regexMatcher,chunkConverter))

  val results = pipeline.fit(sampleDataset).transform(sampleDataset)
  results.select("chunk").show(truncate = false)
+------------------------------------------------------------------------------------------------+
|col                                                                                             |
+------------------------------------------------------------------------------------------------+
|[chunk, 23, 31, the first, [identifier -> NAME, sentence -> 0, chunk -> 0, entity -> NAME], []] |
|[chunk, 71, 80, ceremonies, [identifier -> NAME, sentence -> 1, chunk -> 0, entity -> NAME], []]|
+------------------------------------------------------------------------------------------------+
Linear Supertypes
CheckLicense, SourceTrackingMetadataParams, ResetSentenceIndicesParam, HasSimpleAnnotate[ChunkConverter], AnnotatorModel[ChunkConverter], CanBeLazy, RawAnnotator[ChunkConverter], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[ChunkConverter], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ChunkConverter
  2. CheckLicense
  3. SourceTrackingMetadataParams
  4. ResetSentenceIndicesParam
  5. HasSimpleAnnotate
  6. AnnotatorModel
  7. CanBeLazy
  8. RawAnnotator
  9. HasOutputAnnotationCol
  10. HasInputAnnotationCols
  11. HasOutputAnnotatorType
  12. ParamsAndFeaturesWritable
  13. HasFeatures
  14. DefaultParamsWritable
  15. MLWritable
  16. Model
  17. Transformer
  18. PipelineStage
  19. Logging
  20. Params
  21. Serializable
  22. Serializable
  23. Identifiable
  24. AnyRef
  25. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ChunkConverter()
  2. new ChunkConverter(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. val allPossibleFieldsToStandardize: StringArrayParam

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

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

    Definition Classes
    SourceTrackingMetadataParams
  12. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    annotations

    a Sequence of chunks to transform

    returns

    a Sequence of Merged CHUNK Annotations

    Definition Classes
    ChunkConverter → HasSimpleAnnotate
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  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[_]): ChunkConverter.this.type
    Definition Classes
    Params
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. def copy(extra: ParamMap): ChunkConverter
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  23. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  25. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  28. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  29. def explainParams(): String
    Definition Classes
    Params
  30. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  31. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  32. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  33. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  34. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  35. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  41. def getAllPossibleFieldsToStandardize: Array[String]
    Definition Classes
    SourceTrackingMetadataParams
  42. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. def getIncludeOutputColumn: Boolean
    Definition Classes
    SourceTrackingMetadataParams
  45. def getIncludeStandardField: Boolean
    Definition Classes
    SourceTrackingMetadataParams
  46. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  47. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  48. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  49. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  50. def getOutputColumnKey: String
    Definition Classes
    SourceTrackingMetadataParams
  51. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  52. def getResetSentenceIndices: Boolean

    Gets resetSentenceIndices parameter

    Gets resetSentenceIndices parameter

    Definition Classes
    ResetSentenceIndicesParam
  53. def getStandardFieldKey: String
    Definition Classes
    SourceTrackingMetadataParams
  54. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  55. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  56. def hasParent: Boolean
    Definition Classes
    Model
  57. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. 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
  59. 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
  60. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  61. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator types: DOCUMENT,CHUNK

    Input annotator types: DOCUMENT,CHUNK

    Definition Classes
    ChunkConverter → HasInputAnnotationCols
  63. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  64. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  65. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  66. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  67. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  68. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  69. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  70. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  77. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  82. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  83. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  84. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  85. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  86. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  87. val outputAnnotatorType: AnnotatorType

    Output annotator types: CHUNK

    Output annotator types: CHUNK

    Definition Classes
    ChunkConverter → HasOutputAnnotatorType
  88. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  89. val outputColumnKey: Param[String]

    key name for the source column value

    key name for the source column value

    Definition Classes
    SourceTrackingMetadataParams
  90. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  91. var parent: Estimator[ChunkConverter]
    Definition Classes
    Model
  92. 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
  93. 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
  94. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  95. def set[T](feature: StructFeature[T], value: T): ChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def set[T](feature: SetFeature[T], value: Set[T]): ChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def set[T](feature: ArrayFeature[T], value: Array[T]): ChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. final def set(paramPair: ParamPair[_]): ChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    Params
  100. final def set(param: String, value: Any): ChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. final def set[T](param: Param[T], value: T): ChunkConverter.this.type
    Definition Classes
    Params
  102. def setAllPossibleFieldsToStandardize(v: Array[String]): ChunkConverter.this.type
    Definition Classes
    SourceTrackingMetadataParams
  103. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  104. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  105. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  106. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  107. final def setDefault(paramPairs: ParamPair[_]*): ChunkConverter.this.type
    Attributes
    protected
    Definition Classes
    Params
  108. final def setDefault[T](param: Param[T], value: T): ChunkConverter.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  109. def setIncludeOutputColumn(v: Boolean): ChunkConverter.this.type
    Definition Classes
    SourceTrackingMetadataParams
  110. def setIncludeStandardField(v: Boolean): ChunkConverter.this.type
    Definition Classes
    SourceTrackingMetadataParams
  111. final def setInputCols(value: String*): ChunkConverter.this.type
    Definition Classes
    HasInputAnnotationCols
  112. def setInputCols(value: Array[String]): ChunkConverter.this.type
    Definition Classes
    HasInputAnnotationCols
  113. def setLazyAnnotator(value: Boolean): ChunkConverter.this.type
    Definition Classes
    CanBeLazy
  114. final def setOutputCol(value: String): ChunkConverter.this.type
    Definition Classes
    HasOutputAnnotationCol
  115. def setOutputColumnKey(v: String): ChunkConverter.this.type
    Definition Classes
    SourceTrackingMetadataParams
  116. def setParent(parent: Estimator[ChunkConverter]): ChunkConverter
    Definition Classes
    Model
  117. def setResetSentenceIndices(value: Boolean): ChunkConverter.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
  118. def setStandardFieldKey(v: String): ChunkConverter.this.type
    Definition Classes
    SourceTrackingMetadataParams
  119. val standardFieldKey: Param[String]

    key name for the standard homogenized field

    key name for the standard homogenized field

    Definition Classes
    SourceTrackingMetadataParams
  120. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  121. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  122. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  123. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  124. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  125. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  126. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  127. val uid: String
    Definition Classes
    ChunkConverter → Identifiable
  128. def updateMetadataWithSource(metadata: Map[String, String]): Map[String, String]
    Definition Classes
    SourceTrackingMetadataParams
  129. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  130. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  133. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  134. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from CheckLicense

Inherited from SourceTrackingMetadataParams

Inherited from ResetSentenceIndicesParam

Inherited from HasSimpleAnnotate[ChunkConverter]

Inherited from AnnotatorModel[ChunkConverter]

Inherited from CanBeLazy

Inherited from RawAnnotator[ChunkConverter]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[ChunkConverter]

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