Packages

class RegexMatcher extends AnnotatorApproach[RegexMatcherModel]

Uses rules to match a set of regular expressions and associate them with a provided identifier.

A rule consists of a regex pattern and an identifier, delimited by a character of choice. An example could be \d{4}\/\d\d\/\d\d,date which will match strings like "1970/01/01" to the identifier "date".

Rules must be provided by either setRules (followed by setDelimiter) or an external file.

To use an external file, a dictionary of predefined regular expressions must be provided with setExternalRules. The dictionary can be set in either in the form of a delimited text file or directly as an ExternalResource.

Pretrained pipelines are available for this module, see Pipelines.

For extended examples of usage, see the Examples and the RegexMatcherTestSpec.

Example

In this example, the rules.txt has the form of

the\s\w+, followed by 'the'
ceremonies, ceremony

where each regex is separated by the identifier by ","

import ResourceHelper.spark.implicits._
import com.johnsnowlabs.nlp.base.DocumentAssembler
import com.johnsnowlabs.nlp.annotator.SentenceDetector
import com.johnsnowlabs.nlp.annotators.RegexMatcher
import org.apache.spark.ml.Pipeline

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

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

val regexMatcher = new RegexMatcher()
  .setExternalRules("src/test/resources/regex-matcher/rules.txt",  ",")
  .setInputCols(Array("sentence"))
  .setOutputCol("regex")
  .setStrategy("MATCH_ALL")

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

val data = Seq(
  "My first sentence with the first rule. This is my second sentence with ceremonies rule."
).toDF("text")
val results = pipeline.fit(data).transform(data)

results.selectExpr("explode(regex) as result").show(false)
+--------------------------------------------------------------------------------------------+
|result                                                                                      |
+--------------------------------------------------------------------------------------------+
|[chunk, 23, 31, the first, [identifier -> followed by 'the', sentence -> 0, chunk -> 0], []]|
|[chunk, 71, 80, ceremonies, [identifier -> ceremony, sentence -> 1, chunk -> 0], []]        |
+--------------------------------------------------------------------------------------------+
Linear Supertypes
AnnotatorApproach[RegexMatcherModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[RegexMatcherModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. RegexMatcher
  2. AnnotatorApproach
  3. CanBeLazy
  4. DefaultParamsWritable
  5. MLWritable
  6. HasOutputAnnotatorType
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. Estimator
  10. PipelineStage
  11. Logging
  12. Params
  13. Serializable
  14. Serializable
  15. Identifiable
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    internal element required for storing annotator to disk

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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): RegexMatcherModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  8. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  9. final def clear(param: Param[_]): RegexMatcher.this.type
    Definition Classes
    Params
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. final def copy(extra: ParamMap): Estimator[RegexMatcherModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  12. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  13. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  14. val delimiter: Param[String]

    Delimiter for rules provided with setRules

  15. val description: String

    Matches described regex rules that come in tuples in a text file

    Matches described regex rules that come in tuples in a text file

    Definition Classes
    RegexMatcher → AnnotatorApproach
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  19. def explainParams(): String
    Definition Classes
    Params
  20. val externalRules: ExternalResourceParam

    External resource to rules, needs 'delimiter' in options

  21. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  22. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def fit(dataset: Dataset[_]): RegexMatcherModel
    Definition Classes
    AnnotatorApproach → Estimator
  25. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[RegexMatcherModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  26. def fit(dataset: Dataset[_], paramMap: ParamMap): RegexMatcherModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  27. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): RegexMatcherModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  28. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  29. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  31. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  32. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  33. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  34. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  35. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  36. def getStrategy: String

    Strategy for which to match the expressions (Default: "MATCH_ALL")

  37. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  38. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  39. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  40. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  41. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator type: DOCUMENT

    Input annotator type: DOCUMENT

    Definition Classes
    RegexMatcher → HasInputAnnotationCols
  43. 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
  44. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  47. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  48. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  49. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  50. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  57. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  62. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  63. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  64. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  65. def onTrained(model: RegexMatcherModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  66. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  67. val outputAnnotatorType: AnnotatorType

    Input annotator type: CHUNK

    Input annotator type: CHUNK

    Definition Classes
    RegexMatcher → HasOutputAnnotatorType
  68. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  69. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  70. val rules: StringArrayParam

    Rules with regex pattern and identifiers for matching

  71. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  72. final def set(paramPair: ParamPair[_]): RegexMatcher.this.type
    Attributes
    protected
    Definition Classes
    Params
  73. final def set(param: String, value: Any): RegexMatcher.this.type
    Attributes
    protected
    Definition Classes
    Params
  74. final def set[T](param: Param[T], value: T): RegexMatcher.this.type
    Definition Classes
    Params
  75. final def setDefault(paramPairs: ParamPair[_]*): RegexMatcher.this.type
    Attributes
    protected
    Definition Classes
    Params
  76. final def setDefault[T](param: Param[T], value: T): RegexMatcher.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  77. def setDelimiter(value: String): RegexMatcher.this.type

    Sets the regex rules to match the identifier with.

    Sets the regex rules to match the identifier with.

    Note that only either externalRules or rules can be set at once.

    value

    Array of rules and identifiers as tuples

  78. def setExternalRules(path: String, delimiter: String, readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map("format" -> "text")): RegexMatcher.this.type

    External dictionary to be used by the lemmatizer, which needs delimiter set for parsing the resource.

    External dictionary to be used by the lemmatizer, which needs delimiter set for parsing the resource.

    Note that only either externalRules or rules can be set at once.

  79. def setExternalRules(value: ExternalResource): RegexMatcher.this.type

    External dictionary already in the form of ExternalResource, for which the Map member options has "delimiter" defined.

    External dictionary already in the form of ExternalResource, for which the Map member options has "delimiter" defined.

    Note that only either externalRules or rules can be set at once.

    Example

    val regexMatcher = new RegexMatcher()
  .setExternalRules(ExternalResource(
    "src/test/resources/regex-matcher/rules.txt",
    ReadAs.TEXT,
    Map("delimiter" -> ",")
  ))
  .setInputCols("sentence")
  .setOutputCol("regex")
  .setStrategy(strategy)
  80. final def setInputCols(value: String*): RegexMatcher.this.type
    Definition Classes
    HasInputAnnotationCols
  81. def setInputCols(value: Array[String]): RegexMatcher.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  82. def setLazyAnnotator(value: Boolean): RegexMatcher.this.type
    Definition Classes
    CanBeLazy
  83. final def setOutputCol(value: String): RegexMatcher.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  84. def setRules(value: Array[String]): RegexMatcher.this.type

    Sets the regex rules to match the identifier with.

    Sets the regex rules to match the identifier with.

    The rules must consist of a regex pattern and an identifier for that pattern. The regex pattern and the identifier must be delimited by a character that will also have to set with setDelimiter.

    Only one of either parameter rules or externalRules must be set.

    Example

    val regexMatcher = new RegexMatcher()
  .setRules(Array("\d{4}\/\d\d\/\d\d,date", "\d{2}\/\d\d\/\d\d,date_short")
  .setDelimiter(",")
  .setInputCols("sentence")
  .setOutputCol("regex")
  .setStrategy("MATCH_ALL")
    value

    Array of rules

  85. def setStrategy(value: String): RegexMatcher.this.type

    Strategy for which to match the expressions (Default: "MATCH_ALL")

  86. val strategy: Param[String]

    Strategy for which to match the expressions (Default: "MATCH_ALL").

    Strategy for which to match the expressions (Default: "MATCH_ALL"). Possible values are:

    • MATCH_ALL brings one-to-many results
    • MATCH_FIRST catches only first match
    • MATCH_COMPLETE returns only if match is entire target.
  87. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  88. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  89. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): RegexMatcherModel
    Definition Classes
    RegexMatcher → AnnotatorApproach
  90. 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
  91. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  92. val uid: String
    Definition Classes
    RegexMatcher → Identifiable
  93. 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
  94. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  95. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  96. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  97. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from AnnotatorApproach[RegexMatcherModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[RegexMatcherModel]

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