c

com.johnsnowlabs.partition

PartitionTransformer

class PartitionTransformer extends AnnotatorModel[PartitionTransformer] with HasSimpleAnnotate[PartitionTransformer] with HasReaderProperties with HasEmailReaderProperties with HasExcelReaderProperties with HasHTMLReaderProperties with HasPowerPointProperties with HasTextReaderProperties with HasPdfToTextProperties with HasXmlReaderProperties with HasChunkerProperties

The PartitionTransformer annotator allows you to use the Partition feature more smoothly within existing Spark NLP workflows, enabling seamless reuse of your pipelines. PartitionTransformer can be used for extracting structured content from various document types using Spark NLP readers. It supports reading from files, URLs, in-memory strings, or byte arrays, and returns parsed output as a structured Spark DataFrame.

Supported formats include plain text, HTML, Word (.doc/.docx), Excel (.xls/.xlsx), PowerPoint (.ppt/.pptx), email files (.eml, .msg), and PDFs.

Example

import com.johnsnowlabs.partition.PartitionTransformer
import com. johnsnowlabs. nlp. base. DocumentAssembler
import org.apache.spark.ml.Pipeline
import spark.implicits._
val urls = Seq("https://www.blizzard.com", "https://www.google.com/").toDS.toDF("text")

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

val partition = new PartitionTransformer()
  .setInputCols("document")
  .setOutputCol("partition")
  .setContentType("url")
  .setHeaders(Map("Accept-Language" -> "es-ES"))

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

val pipelineModel = pipeline.fit(testDataSet)
val resultDf = pipelineModel.transform(testDataSet)

resultDf.show()
+--------------------+--------------------+--------------------+
|                text|            document|           partition|
+--------------------+--------------------+--------------------+
|https://www.blizz...|[{Title, Juegos d...|[{document, 0, 16...|
|https://www.googl...|[{Title, Gmail Im...|[{document, 0, 28...|
+--------------------+--------------------+--------------------+
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. PartitionTransformer
  2. HasChunkerProperties
  3. HasXmlReaderProperties
  4. HasPdfToTextProperties
  5. HasTextReaderProperties
  6. HasPowerPointProperties
  7. HasHTMLReaderProperties
  8. HasExcelReaderProperties
  9. HasEmailReaderProperties
  10. HasReaderProperties
  11. HasSimpleAnnotate
  12. AnnotatorModel
  13. CanBeLazy
  14. RawAnnotator
  15. HasOutputAnnotationCol
  16. HasInputAnnotationCols
  17. HasOutputAnnotatorType
  18. ParamsAndFeaturesWritable
  19. HasFeatures
  20. DefaultParamsWritable
  21. MLWritable
  22. Model
  23. Transformer
  24. PipelineStage
  25. Logging
  26. Params
  27. Serializable
  28. Serializable
  29. Identifiable
  30. AnyRef
  31. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PartitionTransformer()
  2. new PartitionTransformer(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
    Definition Classes
    PartitionTransformerAnnotatorModel
  10. val addAttachmentContent: Param[Boolean]
    Definition Classes
    HasEmailReaderProperties
  11. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  12. 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
    PartitionTransformerHasSimpleAnnotate
  13. val appendCells: Param[Boolean]
    Definition Classes
    HasExcelReaderProperties
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  16. val cellSeparator: Param[String]
    Definition Classes
    HasExcelReaderProperties
  17. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  18. val chunkingStrategy: Param[String]
    Definition Classes
    HasChunkerProperties
  19. final def clear(param: Param[_]): PartitionTransformer.this.type
    Definition Classes
    Params
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. val combineTextUnderNChars: Param[Int]
    Definition Classes
    HasChunkerProperties
  22. val contentPath: Param[String]
    Definition Classes
    HasReaderProperties
  23. val contentType: Param[String]
    Definition Classes
    HasReaderProperties
  24. def copy(extra: ParamMap): PartitionTransformer

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  25. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  26. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  27. 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
  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. val explodeDocs: BooleanParam
    Definition Classes
    HasReaderProperties
  33. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  34. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  35. final val extractCoordinates: BooleanParam
    Definition Classes
    HasPdfToTextProperties
  36. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  37. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  38. val extractTagAttributes: StringArrayParam
    Definition Classes
    HasTextReaderProperties
  39. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  40. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  41. val flattenOutput: BooleanParam
    Definition Classes
    HasReaderProperties
  42. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  43. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  44. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  45. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  46. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  47. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  48. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  49. final def getInputCol: String
    Definition Classes
    HasReaderProperties
  50. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  51. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  52. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  53. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  54. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  55. val groupBrokenParagraphs: Param[Boolean]
    Definition Classes
    HasTextReaderProperties
  56. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  57. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  58. def hasParent: Boolean
    Definition Classes
    Model
  59. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  60. val headers: Param[Map[String, String]]
    Definition Classes
    HasHTMLReaderProperties
  61. val ignoreExceptions: BooleanParam
    Definition Classes
    HasReaderProperties
  62. val includePageBreaks: Param[Boolean]
    Definition Classes
    HasReaderProperties
  63. val includeSlideNotes: Param[Boolean]
    Definition Classes
    HasPowerPointProperties
  64. val includeTitleTag: Param[Boolean]
    Definition Classes
    HasHTMLReaderProperties
  65. val inferTableStructure: Param[Boolean]
    Definition Classes
    HasReaderProperties
  66. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  67. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. 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
    PartitionTransformerHasInputAnnotationCols
  69. final val inputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasReaderProperties
  70. 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
  71. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  72. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  73. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  74. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  75. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  76. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  77. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  84. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  85. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  86. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  87. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  88. val logger: Logger
    Attributes
    protected
  89. val maxCharacters: Param[Int]
    Definition Classes
    HasChunkerProperties
  90. val maxLineCount: Param[Int]
    Definition Classes
    HasTextReaderProperties
  91. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  92. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  93. val newAfterNChars: Param[Int]
    Definition Classes
    HasChunkerProperties
  94. final val normalizeLigatures: BooleanParam
    Definition Classes
    HasPdfToTextProperties
  95. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  96. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  97. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  98. val onlyLeafNodes: Param[Boolean]
    Definition Classes
    HasXmlReaderProperties
  99. final val onlyPageNum: BooleanParam
    Definition Classes
    HasPdfToTextProperties
  100. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  101. final val originCol: Param[String]
    Definition Classes
    HasPdfToTextProperties
  102. val outputAnnotatorType: AnnotatorType
  103. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  104. val outputFormat: Param[String]
    Definition Classes
    HasHTMLReaderProperties
  105. val overlap: Param[Int]
    Definition Classes
    HasChunkerProperties
  106. val overlapAll: Param[Boolean]
    Definition Classes
    HasChunkerProperties
  107. final val pageNumCol: Param[String]
    Definition Classes
    HasPdfToTextProperties
  108. val paragraphSplit: Param[String]
    Definition Classes
    HasTextReaderProperties
  109. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  110. var parent: Estimator[PartitionTransformer]
    Definition Classes
    Model
  111. final val partitionNum: IntParam
    Definition Classes
    HasPdfToTextProperties
  112. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  113. def set[T](feature: StructFeature[T], value: T): PartitionTransformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  114. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): PartitionTransformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  115. def set[T](feature: SetFeature[T], value: Set[T]): PartitionTransformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  116. def set[T](feature: ArrayFeature[T], value: Array[T]): PartitionTransformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  117. final def set(paramPair: ParamPair[_]): PartitionTransformer.this.type
    Attributes
    protected
    Definition Classes
    Params
  118. final def set(param: String, value: Any): PartitionTransformer.this.type
    Attributes
    protected
    Definition Classes
    Params
  119. final def set[T](param: Param[T], value: T): PartitionTransformer.this.type
    Definition Classes
    Params
  120. def setAddAttachmentContent(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasEmailReaderProperties
  121. def setAppendCells(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasExcelReaderProperties
  122. def setCellSeparator(value: String): PartitionTransformer.this.type
    Definition Classes
    HasExcelReaderProperties
  123. def setChunkingStrategy(value: String): PartitionTransformer.this.type
    Definition Classes
    HasChunkerProperties
  124. def setComBineTextUnderNChars(value: Int): PartitionTransformer.this.type
    Definition Classes
    HasChunkerProperties
  125. def setContentPath(value: String): PartitionTransformer.this.type
    Definition Classes
    HasReaderProperties
  126. def setContentType(value: String): PartitionTransformer.this.type
    Definition Classes
    HasReaderProperties
  127. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): PartitionTransformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  128. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): PartitionTransformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  129. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): PartitionTransformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  130. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): PartitionTransformer.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  131. final def setDefault(paramPairs: ParamPair[_]*): PartitionTransformer.this.type
    Attributes
    protected
    Definition Classes
    Params
  132. final def setDefault[T](param: Param[T], value: T): PartitionTransformer.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  133. def setExplodeDocs(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasReaderProperties
  134. def setExtractCoordinates(value: Boolean): PartitionTransformer.this.type

    Definition Classes
    HasPdfToTextProperties
  135. def setExtractTagAttributes(attributes: Array[String]): PartitionTransformer.this.type

    Specify which tag attributes should have their values extracted as text when parsing tag-based formats (e.g., HTML or XML).

    Specify which tag attributes should have their values extracted as text when parsing tag-based formats (e.g., HTML or XML).

    attributes

    array of attribute names to extract

    returns

    this instance with the updated extractTagAttributes parameter

    Definition Classes
    HasTextReaderProperties
  136. def setFlattenOutput(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasReaderProperties
  137. def setGroupBrokenParagraphs(value: Boolean): PartitionTransformer.this.type

    Enable or disable merging of fragmented lines into coherent paragraphs when parsing text.

    Enable or disable merging of fragmented lines into coherent paragraphs when parsing text. When enabled, heuristics based on line length and structure are used to group lines.

    value

    true to group broken paragraphs, false to preserve original line breaks

    returns

    this instance with the updated groupBrokenParagraphs parameter

    Definition Classes
    HasTextReaderProperties
  138. def setHeaders(value: Map[String, String]): PartitionTransformer.this.type
    Definition Classes
    HasHTMLReaderProperties
  139. def setHeadersPython(headers: Map[String, String]): PartitionTransformer.this.type
    Definition Classes
    HasHTMLReaderProperties
  140. def setIgnoreExceptions(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasReaderProperties
  141. def setIncludePageBreaks(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasReaderProperties
  142. def setIncludeSlideNotes(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasPowerPointProperties
  143. def setIncludeTitleTag(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasHTMLReaderProperties
  144. def setInferTableStructure(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasReaderProperties
  145. final def setInputCol(value: String): PartitionTransformer.this.type
    Definition Classes
    HasReaderProperties
  146. def setInputCols(value: Array[String]): PartitionTransformer.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    PartitionTransformerHasInputAnnotationCols
  147. final def setInputCols(value: String*): PartitionTransformer.this.type
    Definition Classes
    HasInputAnnotationCols
  148. def setLazyAnnotator(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    CanBeLazy
  149. def setMaxCharacters(value: Int): PartitionTransformer.this.type
    Definition Classes
    HasChunkerProperties
  150. def setMaxLineCount(value: Int): PartitionTransformer.this.type

    Set the maximum number of lines to evaluate when estimating paragraph layout characteristics.

    Set the maximum number of lines to evaluate when estimating paragraph layout characteristics. This limits the amount of text inspected for layout heuristics.

    value

    maximum number of lines to inspect

    returns

    this instance with the updated maxLineCount parameter

    Definition Classes
    HasTextReaderProperties
  151. def setNewAfterNChars(value: Int): PartitionTransformer.this.type
    Definition Classes
    HasChunkerProperties
  152. def setNormalizeLigatures(value: Boolean): PartitionTransformer.this.type

    Definition Classes
    HasPdfToTextProperties
  153. def setOnlyLeafNodes(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasXmlReaderProperties
  154. def setOnlyPageNum(value: Boolean): PartitionTransformer.this.type

    Definition Classes
    HasPdfToTextProperties
  155. def setOriginCol(value: String): PartitionTransformer.this.type

    Definition Classes
    HasPdfToTextProperties
  156. final def setOutputCol(value: String): PartitionTransformer.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  157. def setOutputFormat(value: String): PartitionTransformer.this.type
    Definition Classes
    HasHTMLReaderProperties
  158. def setOverlap(value: Int): PartitionTransformer.this.type
    Definition Classes
    HasChunkerProperties
  159. def setOverlapAll(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasChunkerProperties
  160. def setPageNumCol(value: String): PartitionTransformer.this.type

    Definition Classes
    HasPdfToTextProperties
  161. def setParagraphSplit(value: String): PartitionTransformer.this.type

    Set the regular expression used to detect paragraph boundaries when grouping broken paragraphs.

    Set the regular expression used to detect paragraph boundaries when grouping broken paragraphs.

    value

    regex pattern string to detect paragraph boundaries

    returns

    this instance with the updated paragraphSplit parameter

    Definition Classes
    HasTextReaderProperties
  162. def setParent(parent: Estimator[PartitionTransformer]): PartitionTransformer
    Definition Classes
    Model
  163. def setPartitionNum(value: Int): PartitionTransformer.this.type

    Definition Classes
    HasPdfToTextProperties
  164. def setShortLineWordThreshold(value: Int): PartitionTransformer.this.type

    Set the maximum number of words for a line to be considered "short" when grouping broken paragraphs.

    Set the maximum number of words for a line to be considered "short" when grouping broken paragraphs. Short lines often indicate line-wrapping within a paragraph rather than a real paragraph break.

    value

    maximum word count for a line to be considered short

    returns

    this instance with the updated shortLineWordThreshold parameter

    Definition Classes
    HasTextReaderProperties
  165. def setSort(value: Boolean): PartitionTransformer.this.type

    Definition Classes
    HasPdfToTextProperties
  166. def setSplitPage(value: Boolean): PartitionTransformer.this.type

    Definition Classes
    HasPdfToTextProperties
  167. def setStoreContent(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasReaderProperties
  168. def setStoreSplittedPdf(value: Boolean): PartitionTransformer.this.type

    Definition Classes
    HasPdfToTextProperties
  169. def setTextStripper(value: String): PartitionTransformer.this.type

    Definition Classes
    HasPdfToTextProperties
  170. def setThreshold(value: Double): PartitionTransformer.this.type

    Set the threshold ratio of empty lines used to decide between new line-based or broken-paragraph grouping.

    Set the threshold ratio of empty lines used to decide between new line-based or broken-paragraph grouping. Lower values make it easier to choose broken-paragraph grouping.

    value

    ratio between 0.0 and 1.0 representing the empty-line threshold

    returns

    this instance with the updated threshold parameter

    Definition Classes
    HasTextReaderProperties
  171. def setTimeout(value: Int): PartitionTransformer.this.type
    Definition Classes
    HasHTMLReaderProperties
  172. def setTitleFontSize(value: Int): PartitionTransformer.this.type
    Definition Classes
    HasReaderProperties
  173. def setTitleLengthSize(value: Int): PartitionTransformer.this.type

    Set the maximum character length used to determine if a text block qualifies as a title during parsing.

    Set the maximum character length used to determine if a text block qualifies as a title during parsing.

    value

    maximum number of characters to treat a block as a title

    returns

    this instance with the updated titleLengthSize parameter

    Definition Classes
    HasTextReaderProperties
  174. def setXmlKeepTags(value: Boolean): PartitionTransformer.this.type
    Definition Classes
    HasXmlReaderProperties
  175. val shortLineWordThreshold: Param[Int]
    Definition Classes
    HasTextReaderProperties
  176. final val sort: BooleanParam
    Definition Classes
    HasPdfToTextProperties
  177. final val splitPage: BooleanParam
    Definition Classes
    HasPdfToTextProperties
  178. val storeContent: Param[Boolean]
    Definition Classes
    HasReaderProperties
  179. final val storeSplittedPdf: BooleanParam
    Definition Classes
    HasPdfToTextProperties
  180. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  181. final val textStripper: Param[String]
    Definition Classes
    HasPdfToTextProperties
  182. val threshold: Param[Double]
    Definition Classes
    HasTextReaderProperties
  183. val timeout: Param[Int]
    Definition Classes
    HasHTMLReaderProperties
  184. val titleFontSize: Param[Int]
    Definition Classes
    HasReaderProperties
  185. val titleLengthSize: Param[Int]
    Definition Classes
    HasTextReaderProperties
  186. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  187. 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
  188. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  189. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  190. 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
  191. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  192. val uid: String
    Definition Classes
    PartitionTransformer → Identifiable
  193. 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
  194. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  195. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  196. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  197. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  198. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  199. val xmlKeepTags: Param[Boolean]
    Definition Classes
    HasXmlReaderProperties

Inherited from HasChunkerProperties

Inherited from HasXmlReaderProperties

Inherited from HasPdfToTextProperties

Inherited from HasTextReaderProperties

Inherited from HasPowerPointProperties

Inherited from HasHTMLReaderProperties

Inherited from HasExcelReaderProperties

Inherited from HasEmailReaderProperties

Inherited from HasReaderProperties

Inherited from CanBeLazy

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[PartitionTransformer]

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

getParam

setParam

Ungrouped