class ContextualParserModel extends AnnotatorModel[ContextualParserModel] with HasSimpleAnnotate[ContextualParserModel] with HandleExceptionParams with HasSafeAnnotate[ContextualParserModel] with CheckLicense

Extracts entity from a document based on user defined rules. Rule matching is based on a RegexMatcher defined in a JSON file. In this file, regex is defined that you want to match along with the information that will output on metadata field. To instantiate a model, see ContextualParserApproach and its accompanied example.

See also

ContextualParserApproach to create your own model

Linear Supertypes
CheckLicense, HasSafeAnnotate[ContextualParserModel], HandleExceptionParams, HasSimpleAnnotate[ContextualParserModel], AnnotatorModel[ContextualParserModel], CanBeLazy, RawAnnotator[ContextualParserModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[ContextualParserModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ContextualParserModel
  2. CheckLicense
  3. HasSafeAnnotate
  4. HandleExceptionParams
  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 ContextualParserModel()
  2. new ContextualParserModel(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]
    Definition Classes
    ContextualParserModel → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Definition Classes
    ContextualParserModel → AnnotatorModel
  14. val caseSensitive: BooleanParam

    Whether to use case sensitive when matching values

  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String], metadata: Option[Map[String, Value]]): Unit
    Definition Classes
    CheckLicense
  17. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  18. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean, metadata: Option[Map[String, Value]]): Unit
    Definition Classes
    CheckLicense
  19. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean, metadata: Option[Map[String, Value]]): Unit
    Definition Classes
    CheckLicense
  20. final def clear(param: Param[_]): ContextualParserModel.this.type
    Definition Classes
    Params
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. def copy(extra: ParamMap): ContextualParserModel
    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. val dictionary: StructFeature[Dictionary]
  27. 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
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  30. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  31. def explainParams(): String
    Definition Classes
    Params
  32. final val extraInputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  33. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  34. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  35. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  36. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  37. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  38. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  42. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  43. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. def getCaseSensitive: Boolean
  45. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  46. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  47. def getDictionary: Dictionary
  48. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  49. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  50. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  51. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  52. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  53. def getPrefixAndSuffixMatch: Boolean
  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 inExceptionMode: Boolean
    Attributes
    protected
    Definition Classes
    HasSafeAnnotate
  59. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  60. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. val inputAnnotatorTypes: Array[String]

    DOCUMENT, TOKEN

    DOCUMENT, TOKEN

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

    When set to true, it will output regex match regardless of context matches.

  86. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  87. val outputAnnotatorType: AnnotatorType

    CHUNK

    CHUNK

    Definition Classes
    ContextualParserModel → HasOutputAnnotatorType
  88. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  89. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  90. var parent: Estimator[ContextualParserModel]
    Definition Classes
    Model
  91. val prefixAndSuffixMatch: BooleanParam

    Whether to match both prefix and suffix to annotate the hit

  92. 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
  93. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  94. def set[T](feature: StructFeature[T], value: T): ContextualParserModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  95. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ContextualParserModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def set[T](feature: SetFeature[T], value: Set[T]): ContextualParserModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def set[T](feature: ArrayFeature[T], value: Array[T]): ContextualParserModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. final def set(paramPair: ParamPair[_]): ContextualParserModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  99. final def set(param: String, value: Any): ContextualParserModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  100. final def set[T](param: Param[T], value: T): ContextualParserModel.this.type
    Definition Classes
    Params
  101. def setCaseSensitive(value: Boolean): ContextualParserModel.this.type

    Whether to use case sensitive when matching values

  102. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ContextualParserModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  103. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ContextualParserModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  104. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ContextualParserModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  105. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ContextualParserModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  106. final def setDefault(paramPairs: ParamPair[_]*): ContextualParserModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  107. final def setDefault[T](param: Param[T], value: T): ContextualParserModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  108. def setDictionary(value: Dictionary): ContextualParserModel.this.type
  109. def setDoExceptionHandling(value: Boolean): ContextualParserModel.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
  110. def setEntityDefinition(value: EntityDefinition): ContextualParserModel.this.type
  111. def setExtraInputCols(value: Array[String]): ContextualParserModel.this.type
    Definition Classes
    HasInputAnnotationCols
  112. final def setInputCols(value: String*): ContextualParserModel.this.type
    Definition Classes
    HasInputAnnotationCols
  113. def setInputCols(value: Array[String]): ContextualParserModel.this.type
    Definition Classes
    HasInputAnnotationCols
  114. def setLazyAnnotator(value: Boolean): ContextualParserModel.this.type
    Definition Classes
    CanBeLazy
  115. def setOptionalContextRules(value: Boolean): ContextualParserModel.this.type
  116. final def setOutputCol(value: String): ContextualParserModel.this.type
    Definition Classes
    HasOutputAnnotationCol
  117. def setParent(parent: Estimator[ContextualParserModel]): ContextualParserModel
    Definition Classes
    Model
  118. def setPrefixAndSuffixMatch(value: Boolean): ContextualParserModel.this.type

    Whether to match both prefix and suffix to annotate the hit

  119. def setShortestContextMatch(value: Boolean): ContextualParserModel.this.type
  120. val shortestContextMatch: BooleanParam

    When set to true, it will stop finding for matches when prefix/suffix data is found in the text.

  121. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  122. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  123. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  124. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  125. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  126. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  127. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  128. val uid: String
    Definition Classes
    ContextualParserModel → Identifiable
  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 HasSafeAnnotate[ContextualParserModel]

Inherited from HandleExceptionParams

Inherited from HasSimpleAnnotate[ContextualParserModel]

Inherited from AnnotatorModel[ContextualParserModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[ContextualParserModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[ContextualParserModel]

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