Packages

class Extractor extends AnnotatorModel[Extractor] with HasSimpleAnnotate[Extractor]

Linear Supertypes
HasSimpleAnnotate[Extractor], AnnotatorModel[Extractor], CanBeLazy, RawAnnotator[Extractor], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[Extractor], Transformer, PipelineStage, Logging, Params, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Extractor
  2. HasSimpleAnnotate
  3. AnnotatorModel
  4. CanBeLazy
  5. RawAnnotator
  6. HasOutputAnnotationCol
  7. HasInputAnnotationCols
  8. HasOutputAnnotatorType
  9. ParamsAndFeaturesWritable
  10. HasFeatures
  11. DefaultParamsWritable
  12. MLWritable
  13. Model
  14. Transformer
  15. PipelineStage
  16. Logging
  17. Params
  18. Serializable
  19. Identifiable
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

Type Members

  1. type AnnotationContent = Seq[Row]

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    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]

    takes a document and annotations and produces new annotations of this annotator's annotation type

    takes a document and annotations and produces new annotations of this annotator's annotation type

    annotations

    Annotations that correspond to inputAnnotationCols generated by previous annotators if any

    returns

    any number of annotations processed for every input annotation. Not necessary one to one relationship

    Definition Classes
    Extractor → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. final def clear(param: Param[_]): Extractor.this.type
    Definition Classes
    Params
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  17. def copy(extra: ParamMap): Extractor

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  18. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  19. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. def dfAnnotate: UserDefinedFunction

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    returns

    udf function to be applied to inputCols using this annotator's annotate function as part of ML transformation

    Definition Classes
    HasSimpleAnnotate
  21. val emailAddress: Param[String]
  22. val emailDateTimeTzPattern: Param[String]
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  26. def explainParams(): String
    Definition Classes
    Params
  27. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  28. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  29. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  30. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  31. val extractorMode: Param[String]

    extractorMode can take the following values:

    extractorMode can take the following values:

    • email_date: extract email date
    • email_address: extract email address
    • ip_address: extract ip address
    • ip_address_name: extract ip address with name
    • mapi_id: extract mapi id
    • us_phone_numbers: extract US phone numbers
    • image_urls: extract image URLs
    • bullets: extract ordered bullets
    • text_after: extract text after a pattern
    • text_before: extract text before a pattern
  32. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  33. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  34. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  35. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  36. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  38. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  39. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  40. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  41. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  42. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  43. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  44. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  45. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  46. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  47. def hasParent: Boolean
    Definition Classes
    Model
  48. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  49. val imageUrlPattern: Param[String]
  50. val index: IntParam
  51. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  52. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. val inputAnnotatorTypes: Array[AnnotatorType]

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

    Definition Classes
    Extractor → HasInputAnnotationCols
  54. 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
  55. val ipAddressNamePattern: Param[String]
  56. val ipAddressPattern: Param[String]
  57. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  58. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  59. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  60. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  61. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  62. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  63. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  70. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. val mapiIdPattern: Param[String]
  75. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  76. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  77. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  78. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  79. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  80. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  81. val outputAnnotatorType: AnnotatorType
    Definition Classes
    Extractor → HasOutputAnnotatorType
  82. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  83. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  84. var parent: Estimator[Extractor]
    Definition Classes
    Model
  85. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @throws("If the input path already exists but overwrite is not enabled.") @Since("1.6.0")
  86. def set[T](feature: StructFeature[T], value: T): Extractor.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  87. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): Extractor.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  88. def set[T](feature: SetFeature[T], value: Set[T]): Extractor.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  89. def set[T](feature: ArrayFeature[T], value: Array[T]): Extractor.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. final def set(paramPair: ParamPair[_]): Extractor.this.type
    Attributes
    protected
    Definition Classes
    Params
  91. final def set(param: String, value: Any): Extractor.this.type
    Attributes
    protected
    Definition Classes
    Params
  92. final def set[T](param: Param[T], value: T): Extractor.this.type
    Definition Classes
    Params
  93. def setDefault[T](feature: StructFeature[T], value: () => T): Extractor.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  94. def setDefault[K, V](feature: MapFeature[K, V], value: () => Map[K, V]): Extractor.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  95. def setDefault[T](feature: SetFeature[T], value: () => Set[T]): Extractor.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def setDefault[T](feature: ArrayFeature[T], value: () => Array[T]): Extractor.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. final def setDefault(paramPairs: ParamPair[_]*): Extractor.this.type
    Attributes
    protected
    Definition Classes
    Params
  98. final def setDefault[T](param: Param[T], value: T): Extractor.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  99. def setEmailDateTimeTzPattern(value: String): Extractor.this.type

  100. def setExtractorMode(value: String): Extractor.this.type

  101. def setImageUrlPattern(value: String): Extractor.this.type

  102. def setIndex(value: Int): Extractor.this.type

  103. final def setInputCols(value: String*): Extractor.this.type
    Definition Classes
    HasInputAnnotationCols
  104. def setInputCols(value: Array[String]): Extractor.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  105. def setIpAddressNamePattern(value: String): Extractor.this.type

  106. def setIpAddressPattern(value: String): Extractor.this.type

  107. def setLazyAnnotator(value: Boolean): Extractor.this.type
    Definition Classes
    CanBeLazy
  108. def setMapiIdPattern(value: String): Extractor.this.type

  109. final def setOutputCol(value: String): Extractor.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  110. def setParent(parent: Estimator[Extractor]): Extractor
    Definition Classes
    Model
  111. def setTextPattern(value: String): Extractor.this.type
  112. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  113. val textPattern: Param[String]
  114. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  115. final def transform(dataset: Dataset[_]): DataFrame

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    dataset

    Dataset[Row]

    Definition Classes
    AnnotatorModel → Transformer
  116. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since("2.0.0")
  117. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @varargs() @Since("2.0.0")
  118. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

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

    Definition Classes
    RawAnnotator → PipelineStage
  119. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  120. val uid: String
    Definition Classes
    Extractor → Identifiable
  121. val usPhoneNumbersPattern: Param[String]
  122. 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
    RawAnnotator
  123. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  124. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  125. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  126. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  127. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from HasSimpleAnnotate[Extractor]

Inherited from AnnotatorModel[Extractor]

Inherited from CanBeLazy

Inherited from RawAnnotator[Extractor]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[Extractor]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

param

setParam

Ungrouped