Packages

class BigTextMatcher extends AnnotatorApproach[BigTextMatcherModel] with HasStorage

Annotator to match exact phrases (by token) provided in a file against a Document.

A text file of predefined phrases must be provided with setStoragePath. The text file can als be set directly as an ExternalResource.

In contrast to the normal TextMatcher, the BigTextMatcher is designed for large corpora.

For extended examples of usage, see the BigTextMatcherTestSpec.

Example

In this example, the entities file is of the form

...
dolore magna aliqua
lorem ipsum dolor. sit
laborum
...

where each line represents an entity phrase to be extracted.

import spark.implicits._
import com.johnsnowlabs.nlp.DocumentAssembler
import com.johnsnowlabs.nlp.annotator.Tokenizer
import com.johnsnowlabs.nlp.annotator.BigTextMatcher
import com.johnsnowlabs.nlp.util.io.ReadAs
import org.apache.spark.ml.Pipeline

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

val tokenizer = new Tokenizer()
  .setInputCols("document")
  .setOutputCol("token")

val data = Seq("Hello dolore magna aliqua. Lorem ipsum dolor. sit in laborum").toDF("text")
val entityExtractor = new BigTextMatcher()
  .setInputCols("document", "token")
  .setStoragePath("src/test/resources/entity-extractor/test-phrases.txt", ReadAs.TEXT)
  .setOutputCol("entity")
  .setCaseSensitive(false)

val pipeline = new Pipeline().setStages(Array(documentAssembler, tokenizer, entityExtractor))
val results = pipeline.fit(data).transform(data)
results.selectExpr("explode(entity)").show(false)
+--------------------------------------------------------------------+
|col                                                                 |
+--------------------------------------------------------------------+
|[chunk, 6, 24, dolore magna aliqua, [sentence -> 0, chunk -> 0], []]|
|[chunk, 53, 59, laborum, [sentence -> 0, chunk -> 1], []]           |
+--------------------------------------------------------------------+
Linear Supertypes
HasStorage, HasCaseSensitiveProperties, HasStorageOptions, HasStorageRef, ParamsAndFeaturesWritable, HasFeatures, AnnotatorApproach[BigTextMatcherModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[BigTextMatcherModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. BigTextMatcher
  2. HasStorage
  3. HasCaseSensitiveProperties
  4. HasStorageOptions
  5. HasStorageRef
  6. ParamsAndFeaturesWritable
  7. HasFeatures
  8. AnnotatorApproach
  9. CanBeLazy
  10. DefaultParamsWritable
  11. MLWritable
  12. HasOutputAnnotatorType
  13. HasOutputAnnotationCol
  14. HasInputAnnotationCols
  15. Estimator
  16. PipelineStage
  17. Logging
  18. Params
  19. Serializable
  20. Serializable
  21. Identifiable
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    internal uid required to generate writable annotators

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]): BigTextMatcherModel
    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 caseSensitive: BooleanParam

    Whether to ignore case in index lookups (Default depends on model)

    Whether to ignore case in index lookups (Default depends on model)

    Definition Classes
    HasCaseSensitiveProperties
  13. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  14. final def clear(param: Param[_]): BigTextMatcher.this.type
    Definition Classes
    Params
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  16. final def copy(extra: ParamMap): Estimator[BigTextMatcherModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  17. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  18. def createDatabaseConnection(database: Name): RocksDBConnection
    Definition Classes
    HasStorageRef
  19. def createWriter(database: Name, connection: RocksDBConnection): StorageWriter[_]
    Attributes
    protected
    Definition Classes
    BigTextMatcher → HasStorage
  20. val databases: Array[Name]
    Attributes
    protected
    Definition Classes
    BigTextMatcher → HasStorage
  21. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  22. val description: String
    Definition Classes
    BigTextMatcher → AnnotatorApproach
  23. val enableInMemoryStorage: BooleanParam
    Definition Classes
    HasStorageOptions
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  26. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  27. def explainParams(): String
    Definition Classes
    Params
  28. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  29. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  30. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  31. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. final def fit(dataset: Dataset[_]): BigTextMatcherModel
    Definition Classes
    AnnotatorApproach → Estimator
  33. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[BigTextMatcherModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  34. def fit(dataset: Dataset[_], paramMap: ParamMap): BigTextMatcherModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  35. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): BigTextMatcherModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  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 getCaseSensitive: Boolean

    Definition Classes
    HasCaseSensitiveProperties
  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 getEnableInMemoryStorage: Boolean
    Definition Classes
    HasStorageOptions
  45. def getIncludeStorage: Boolean
    Definition Classes
    HasStorageOptions
  46. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  47. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  48. def getMergeOverlapping: Boolean

  49. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  50. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  51. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  52. def getStoragePath: Option[ExternalResource]

    Definition Classes
    HasStorage
  53. def getStorageRef: String
    Definition Classes
    HasStorageRef
  54. def getTokenizer: TokenizerModel

  55. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  56. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  57. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. val includeStorage: BooleanParam
    Definition Classes
    HasStorageOptions
  59. def index(fitDataset: Dataset[_], storageSourcePath: Option[String], readAs: Option[util.io.ReadAs.Value], writers: Map[Name, StorageWriter[_]], readOptions: Option[Map[String, String]]): Unit
    Attributes
    protected
    Definition Classes
    BigTextMatcher → HasStorage
  60. def indexStorage(fitDataset: Dataset[_], resource: Option[ExternalResource]): Unit
    Definition Classes
    HasStorage
  61. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  62. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. val inputAnnotatorTypes: Array[String]

    Input annotator Types: DOCUMENT, TOKEN

    Input annotator Types: DOCUMENT, TOKEN

    Definition Classes
    BigTextMatcher → HasInputAnnotationCols
  64. final val inputCols: StringArrayParam

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  65. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  66. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  67. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  68. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  69. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  70. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  71. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  78. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. val mergeOverlapping: BooleanParam

    Whether to merge overlapping matched chunks (Default: false)

  83. val missingRefMsg: String
    Attributes
    protected
    Definition Classes
    HasStorage
  84. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  85. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  86. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  87. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  88. def onTrained(model: BigTextMatcherModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  89. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  90. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  91. val outputAnnotatorType: AnnotatorType

    Output annotator Types: CHUNK

    Output annotator Types: CHUNK

    Definition Classes
    BigTextMatcher → HasOutputAnnotatorType
  92. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  93. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  94. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  95. def set[T](feature: StructFeature[T], value: T): BigTextMatcher.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): BigTextMatcher.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def set[T](feature: SetFeature[T], value: Set[T]): BigTextMatcher.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def set[T](feature: ArrayFeature[T], value: Array[T]): BigTextMatcher.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. final def set(paramPair: ParamPair[_]): BigTextMatcher.this.type
    Attributes
    protected
    Definition Classes
    Params
  100. final def set(param: String, value: Any): BigTextMatcher.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. final def set[T](param: Param[T], value: T): BigTextMatcher.this.type
    Definition Classes
    Params
  102. def setCaseSensitive(value: Boolean): BigTextMatcher.this.type

    Definition Classes
    HasCaseSensitiveProperties
  103. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): BigTextMatcher.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  104. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): BigTextMatcher.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  105. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): BigTextMatcher.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  106. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): BigTextMatcher.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  107. final def setDefault(paramPairs: ParamPair[_]*): BigTextMatcher.this.type
    Attributes
    protected
    Definition Classes
    Params
  108. final def setDefault[T](param: Param[T], value: T): BigTextMatcher.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  109. def setEnableInMemoryStorage(value: Boolean): BigTextMatcher.this.type
    Definition Classes
    HasStorageOptions
  110. def setIncludeStorage(value: Boolean): BigTextMatcher.this.type
    Definition Classes
    HasStorageOptions
  111. final def setInputCols(value: String*): BigTextMatcher.this.type
    Definition Classes
    HasInputAnnotationCols
  112. def setInputCols(value: Array[String]): BigTextMatcher.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  113. def setLazyAnnotator(value: Boolean): BigTextMatcher.this.type
    Definition Classes
    CanBeLazy
  114. def setMergeOverlapping(v: Boolean): BigTextMatcher.this.type

  115. final def setOutputCol(value: String): BigTextMatcher.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  116. def setStoragePath(path: String, readAs: util.io.ReadAs.Value): BigTextMatcher.this.type

    Definition Classes
    HasStorage
  117. def setStoragePath(path: String, readAs: String): BigTextMatcher.this.type

    Definition Classes
    HasStorage
  118. def setStorageRef(value: String): BigTextMatcher.this.type
    Definition Classes
    HasStorageRef
  119. def setTokenizer(tokenizer: TokenizerModel): BigTextMatcher.this.type

  120. val storagePath: ExternalResourceParam

    Path to the external resource.

    Path to the external resource.

    Definition Classes
    HasStorage
  121. val storageRef: Param[String]

    Unique identifier for storage (Default: this.uid)

    Unique identifier for storage (Default: this.uid)

    Definition Classes
    HasStorageRef
  122. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  123. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  124. val tokenizer: StructFeature[TokenizerModel]

    The Tokenizer to perform tokenization with

  125. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): BigTextMatcherModel
    Definition Classes
    BigTextMatcher → AnnotatorApproach
  126. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

    requirement for pipeline transformation validation. It is called on fit()

    Definition Classes
    AnnotatorApproach → PipelineStage
  127. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  128. val uid: String
    Definition Classes
    BigTextMatcher → Identifiable
  129. def validate(schema: StructType): Boolean

    takes a Dataset and checks to see if all the required annotation types are present.

    takes a Dataset and checks to see if all the required annotation types are present.

    schema

    to be validated

    returns

    True if all the required types are present, else false

    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  130. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit
    Definition Classes
    HasStorageRef
  131. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  134. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasStorage

Inherited from HasCaseSensitiveProperties

Inherited from HasStorageOptions

Inherited from HasStorageRef

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from AnnotatorApproach[BigTextMatcherModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[BigTextMatcherModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Annotator types

Required input and expected output annotator types

Parameters

A list of (hyper-)parameter keys this annotator can take. Users can set and get the parameter values through setters and getters, respectively.

Parameter setters

Parameter getters

Members