class Reader2Doc extends Transformer with DefaultParamsWritable with HasOutputAnnotatorType with HasOutputAnnotationCol with HasBinaryReaderProperties with HasTextReaderProperties with HasReaderContent

The Reader2Doc annotator allows you to use the reading files more smoothly within existing Spark NLP workflows, enabling seamless reuse of your pipelines. Reader2Doc can be used for extracting structured content from various document types using Spark NLP readers. It supports reading from many files types 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.reader.Reader2Doc
import com. johnsnowlabs.nlp.base.DocumentAssembler
import org.apache.spark.ml.Pipeline

val reader2Doc = new Reader2Doc()
  .setContentType("application/pdf")
  .setContentPath(s"$pdfDirectory/")
  .setExplodeDocs(true)

val pipeline = new Pipeline()
  .setStages(Array(reader2Doc))

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

resultDf.show()
+------------------------------------------------------------------------------------------------------------------------------------+
|document                                                                                                                            |
+------------------------------------------------------------------------------------------------------------------------------------+
|[{document, 0, 14, This is a Title, {pageNumber -> 1, elementType -> Title, fileName -> pdf-title.pdf}, []}]                        |
|[{document, 15, 38, This is a narrative text, {pageNumber -> 1, elementType -> NarrativeText, fileName -> pdf-title.pdf}, []}]      |
|[{document, 39, 68, This is another narrative text, {pageNumber -> 1, elementType -> NarrativeText, fileName -> pdf-title.pdf}, []}]|
+------------------------------------------------------------------------------------------------------------------------------------+
Linear Supertypes
HasReaderContent, HasTagsReaderProperties, HasXmlReaderProperties, HasHTMLReaderProperties, HasReaderProperties, HasTextReaderProperties, HasBinaryReaderProperties, HasPowerPointProperties, HasPdfReaderProperties, HasExcelReaderProperties, HasEmailReaderProperties, ParamsAndFeaturesWritable, HasFeatures, HasOutputAnnotationCol, HasOutputAnnotatorType, DefaultParamsWritable, MLWritable, Transformer, PipelineStage, Logging, Params, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Reader2Table
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Reader2Doc
  2. HasReaderContent
  3. HasTagsReaderProperties
  4. HasXmlReaderProperties
  5. HasHTMLReaderProperties
  6. HasReaderProperties
  7. HasTextReaderProperties
  8. HasBinaryReaderProperties
  9. HasPowerPointProperties
  10. HasPdfReaderProperties
  11. HasExcelReaderProperties
  12. HasEmailReaderProperties
  13. ParamsAndFeaturesWritable
  14. HasFeatures
  15. HasOutputAnnotationCol
  16. HasOutputAnnotatorType
  17. DefaultParamsWritable
  18. MLWritable
  19. Transformer
  20. PipelineStage
  21. Logging
  22. Params
  23. Serializable
  24. Identifiable
  25. AnyRef
  26. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

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. val addAttachmentContent: Param[Boolean]
    Definition Classes
    HasEmailReaderProperties
  10. def afterAnnotate(dataset: DataFrame): DataFrame
  11. val appendCells: Param[Boolean]
    Definition Classes
    HasExcelReaderProperties
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def buildEmptyDataFrame(dataset: Dataset[_]): DataFrame
    Definition Classes
    HasReaderContent
  14. def buildErrorDataFrame(dataset: Dataset[_], contentPath: String, ext: String): DataFrame
    Definition Classes
    HasReaderContent
  15. val cellSeparator: Param[String]
    Definition Classes
    HasExcelReaderProperties
  16. final def clear(param: Param[_]): Reader2Doc.this.type
    Definition Classes
    Params
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  18. val contentPath: Param[String]
    Definition Classes
    HasReaderProperties
  19. val contentType: Param[String]
    Definition Classes
    HasReaderProperties
  20. def copy(extra: ParamMap): Transformer
    Definition Classes
    Reader2Doc → Transformer → PipelineStage → Params
  21. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  22. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. val excludeNonText: BooleanParam
  26. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  27. def explainParams(): String
    Definition Classes
    Params
  28. val explodeDocs: BooleanParam
    Definition Classes
    HasReaderProperties
  29. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  30. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  31. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  32. val flattenOutput: BooleanParam
    Definition Classes
    HasReaderProperties
  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. def getContentType: String
    Definition Classes
    HasReaderContent
  40. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  41. val getFileName: UserDefinedFunction
    Definition Classes
    HasReaderContent
  42. final def getInputCol: String
    Definition Classes
    HasReaderProperties
  43. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  44. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  45. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  46. val groupBrokenParagraphs: Param[Boolean]
    Definition Classes
    HasTextReaderProperties
  47. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  48. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  49. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  50. val headers: Param[Map[String, String]]
    Definition Classes
    HasHTMLReaderProperties
  51. val ignoreExceptions: BooleanParam
    Definition Classes
    HasReaderProperties
  52. val includePageBreaks: Param[Boolean]
    Definition Classes
    HasReaderProperties
  53. val includeSlideNotes: Param[Boolean]
    Definition Classes
    HasPowerPointProperties
  54. val includeTitleTag: Param[Boolean]
    Definition Classes
    HasHTMLReaderProperties
  55. val inferTableStructure: Param[Boolean]
    Definition Classes
    HasReaderProperties
  56. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  57. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. final val inputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasReaderProperties
  59. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  60. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  61. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  62. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  63. def listAllFilesRecursively(dir: File): Seq[File]
    Definition Classes
    HasReaderContent
  64. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  65. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  72. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. val maxLineCount: Param[Int]
    Definition Classes
    HasTextReaderProperties
  77. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  78. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  79. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  80. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  81. val onlyLeafNodes: Param[Boolean]
    Definition Classes
    HasXmlReaderProperties
  82. val outputAnnotatorType: AnnotatorType
    Definition Classes
    Reader2Doc → HasOutputAnnotatorType
  83. val outputAsDocument: BooleanParam

    Whether to return all sentences joined into a single document

  84. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  85. val outputFormat: Param[String]
    Definition Classes
    HasHTMLReaderProperties
  86. val paragraphSplit: Param[String]
    Definition Classes
    HasTextReaderProperties
  87. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  88. def partitionBuilder: Partition
    Attributes
    protected
  89. def partitionContent(partition: Partition, contentPath: String, isText: Boolean, dataset: Dataset[_]): DataFrame
    Definition Classes
    HasReaderContent
  90. def partitionContentFromPath(partition: Partition, contentPath: String, isText: Boolean, dataset: Dataset[_]): DataFrame
    Definition Classes
    HasReaderContent
  91. def partitionMixedContent(dataset: Dataset[_], dirPath: String, partitionParams: Map[String, String]): DataFrame
    Definition Classes
    HasReaderContent
  92. def partitionToAnnotation: UserDefinedFunction
  93. final val readAsImage: BooleanParam
    Definition Classes
    HasPdfReaderProperties
  94. def retrieveFileName(path: String): String
    Definition Classes
    HasReaderContent
  95. 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")
  96. def set[T](feature: StructFeature[T], value: T): Reader2Doc.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): Reader2Doc.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def set[T](feature: SetFeature[T], value: Set[T]): Reader2Doc.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. def set[T](feature: ArrayFeature[T], value: Array[T]): Reader2Doc.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. final def set(paramPair: ParamPair[_]): Reader2Doc.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. final def set(param: String, value: Any): Reader2Doc.this.type
    Attributes
    protected
    Definition Classes
    Params
  102. final def set[T](param: Param[T], value: T): Reader2Doc.this.type
    Definition Classes
    Params
  103. def setAddAttachmentContent(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasEmailReaderProperties
  104. def setAppendCells(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasExcelReaderProperties
  105. def setCellSeparator(value: String): Reader2Doc.this.type
    Definition Classes
    HasExcelReaderProperties
  106. def setContentPath(value: String): Reader2Doc.this.type
    Definition Classes
    HasReaderProperties
  107. def setContentType(value: String): Reader2Doc.this.type
    Definition Classes
    HasReaderProperties
  108. def setDefault[T](feature: StructFeature[T], value: () => T): Reader2Doc.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  109. def setDefault[K, V](feature: MapFeature[K, V], value: () => Map[K, V]): Reader2Doc.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  110. def setDefault[T](feature: SetFeature[T], value: () => Set[T]): Reader2Doc.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  111. def setDefault[T](feature: ArrayFeature[T], value: () => Array[T]): Reader2Doc.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  112. final def setDefault(paramPairs: ParamPair[_]*): Reader2Doc.this.type
    Attributes
    protected
    Definition Classes
    Params
  113. final def setDefault[T](param: Param[T], value: T): Reader2Doc.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  114. def setExcludeNonText(value: Boolean): Reader2Doc.this.type

    Excludes rows that are not text data.

    Excludes rows that are not text data. e.g. tables

  115. def setExplodeDocs(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasReaderProperties
  116. def setFlattenOutput(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasReaderProperties
  117. def setGroupBrokenParagraphs(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasTextReaderProperties
  118. def setHeaders(value: Map[String, String]): Reader2Doc.this.type
    Definition Classes
    HasHTMLReaderProperties
  119. def setHeadersPython(headers: Map[String, String]): Reader2Doc.this.type
    Definition Classes
    HasHTMLReaderProperties
  120. def setIgnoreExceptions(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasReaderProperties
  121. def setIncludePageBreaks(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasReaderProperties
  122. def setIncludeSlideNotes(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasPowerPointProperties
  123. def setIncludeTitleTag(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasHTMLReaderProperties
  124. def setInferTableStructure(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasReaderProperties
  125. final def setInputCol(value: String): Reader2Doc.this.type
    Definition Classes
    HasReaderProperties
  126. def setMaxLineCount(value: Int): Reader2Doc.this.type
    Definition Classes
    HasTextReaderProperties
  127. def setOnlyLeafNodes(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasXmlReaderProperties
  128. def setOutputAsDocument(value: Boolean): Reader2Doc.this.type

    Whether to return all sentences joined into a single document

  129. final def setOutputCol(value: String): Reader2Doc.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  130. def setOutputFormat(value: String): Reader2Doc.this.type
    Definition Classes
    HasHTMLReaderProperties
  131. def setParagraphSplit(value: String): Reader2Doc.this.type
    Definition Classes
    HasTextReaderProperties
  132. def setShortLineWordThreshold(value: Int): Reader2Doc.this.type
    Definition Classes
    HasTextReaderProperties
  133. def setStoreContent(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasReaderProperties
  134. def setThreshold(value: Double): Reader2Doc.this.type
    Definition Classes
    HasTextReaderProperties
  135. def setTimeout(value: Int): Reader2Doc.this.type
    Definition Classes
    HasHTMLReaderProperties
  136. def setTitleFontSize(value: Int): Reader2Doc.this.type
    Definition Classes
    HasReaderProperties
  137. def setTitleLengthSize(value: Int): Reader2Doc.this.type
    Definition Classes
    HasTextReaderProperties
  138. def setTitleThreshold(value: Double): Reader2Doc.this.type
    Definition Classes
    HasPdfReaderProperties
  139. def setXmlKeepTags(value: Boolean): Reader2Doc.this.type
    Definition Classes
    HasXmlReaderProperties
  140. val shortLineWordThreshold: Param[Int]
    Definition Classes
    HasTextReaderProperties
  141. val storeContent: Param[Boolean]
    Definition Classes
    HasReaderProperties
  142. val supportedTypes: Map[String, (String, Boolean)]
    Definition Classes
    HasReaderContent
  143. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  144. val threshold: Param[Double]
    Definition Classes
    HasTextReaderProperties
  145. val timeout: Param[Int]
    Definition Classes
    HasHTMLReaderProperties
  146. val titleFontSize: Param[Int]
    Definition Classes
    HasReaderProperties
  147. val titleLengthSize: Param[Int]
    Definition Classes
    HasTextReaderProperties
  148. val titleThreshold: Param[Double]
    Definition Classes
    HasPdfReaderProperties
  149. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  150. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    Reader2Doc → Transformer
  151. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since("2.0.0")
  152. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @varargs() @Since("2.0.0")
  153. def transformSchema(schema: StructType): StructType
    Definition Classes
    Reader2Doc → PipelineStage
  154. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  155. val uid: String
    Definition Classes
    Reader2Doc → Identifiable
  156. def validateRequiredParameters(): Unit
    Attributes
    protected
  157. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  158. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  159. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  160. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  161. val xmlKeepTags: Param[Boolean]
    Definition Classes
    HasXmlReaderProperties

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 HasReaderContent

Inherited from HasTagsReaderProperties

Inherited from HasXmlReaderProperties

Inherited from HasHTMLReaderProperties

Inherited from HasReaderProperties

Inherited from HasTextReaderProperties

Inherited from HasBinaryReaderProperties

Inherited from HasPowerPointProperties

Inherited from HasPdfReaderProperties

Inherited from HasExcelReaderProperties

Inherited from HasEmailReaderProperties

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from HasOutputAnnotationCol

Inherited from HasOutputAnnotatorType

Inherited from DefaultParamsWritable

Inherited from MLWritable

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

Ungrouped