class TableAssembler extends AnnotatorModel[TokenAssembler] with HasSimpleAnnotate[TokenAssembler]

This transformer parses text into tabular representation. The input consists of DOCUMENT annotations and the output are TABLE annotations. The source format can be either JSON or CSV. The format of the JSON files should be:

{
  "header": [col1, col2, ..., colN],
  "rows": [
    [val11, val12, ..., val1N],
    [val22, va22, ..., val2N],
    ...
   ]
}

The CSV format support alternative delimiters (e.g. tab), as well as escaping delimiters by surrounding cell values with double quotes. For example:

column1, column2, "column with, comma"
value1, value2, value3
"escaped value", "value with, comma", "value with double ("") quote"

The transformer stores tabular data internally as JSON. The default input format is also JSON.

Example

import spark.implicits._
import com.johnsnowlabs.nlp.DocumentAssembler
import org.apache.spark.ml.Pipeline

val csvData =
  """
    |"name", "money", "age"
    |"Donald Trump", "$100,000,000", "75"
    |"Elon Musk", "$20,000,000,000,000", "55"
    |""".stripMargin.trim

val data =Seq(csvData).toDF("csv")

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

val tableAssembler = new TableAssembler()
  .setInputCols(Array("document"))
  .setOutputCol("table")
  .setInputFormat("csv")

val pipeline = new Pipeline()
  .setStages(
    Array(documentAssembler, tableAssembler)
    ).fit(data)

val result = pipeline.transform(data)
result
  .selectExpr("explode(table) AS table")
  .select("table.result", "table.metadata.input_format")
  .show(false)

+--------------------------------------------+-------------+
|result                                      |input_format |
+--------------------------------------------+-------------+
|{                                           |csv          |
| "header": ["name","money","age"],          |             |
|  "rows":[                                  |             |
|   ["Donald Trump","$100,000,000","75"],    |             |
|   ["Elon Musk","$20,000,000,000,000","55"] |             |
|  ]                                         |             |
|}                                           |             |
+--------------------------------------------+-------------+
Linear Supertypes
HasSimpleAnnotate[TokenAssembler], AnnotatorModel[TokenAssembler], CanBeLazy, RawAnnotator[TokenAssembler], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[TokenAssembler], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. TableAssembler
  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. Serializable
  20. Identifiable
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    required uid for storing annotator to disk

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. val INPUT_FORMATS: Array[String]
    Attributes
    protected
  10. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  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
    TableAssembler → HasSimpleAnnotate
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. final def clear(param: Param[_]): TableAssembler.this.type
    Definition Classes
    Params
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. def copy(extra: ParamMap): TokenAssembler

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  19. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. val csvDelimiter: Param[String]
  21. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  22. 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
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. val escapeCsvDelimiter: BooleanParam
  26. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  27. def explainParams(): String
    Definition Classes
    Params
  28. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  29. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  30. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  31. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  32. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  33. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  34. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  35. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  36. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  39. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  40. def getCsvDelimiter: String
  41. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  42. def getEscapeCsvDelimiter: Boolean
  43. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  44. def getInputFormat: String
  45. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  46. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  47. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Input annotator types: DOCUMENT, TOKEN

    Input annotator types: DOCUMENT, TOKEN

    Definition Classes
    TableAssembler → HasInputAnnotationCols
  56. 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
  57. val inputFormat: Param[String]
  58. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  59. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  60. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  61. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  62. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  63. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  64. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  71. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  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
    @native()
  78. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @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

    Output annotator types: DOCUMENT

    Output annotator types: DOCUMENT

    Definition Classes
    TableAssembler → 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[TokenAssembler]
    Definition Classes
    Model
  85. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  86. def set[T](feature: StructFeature[T], value: T): TableAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  87. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): TableAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  88. def set[T](feature: SetFeature[T], value: Set[T]): TableAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  89. def set[T](feature: ArrayFeature[T], value: Array[T]): TableAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. final def set(paramPair: ParamPair[_]): TableAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  91. final def set(param: String, value: Any): TableAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  92. final def set[T](param: Param[T], value: T): TableAssembler.this.type
    Definition Classes
    Params
  93. def setCsvDelimiter(value: String): TableAssembler.this.type
  94. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): TableAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  95. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): TableAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): TableAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): TableAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. final def setDefault(paramPairs: ParamPair[_]*): TableAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  99. final def setDefault[T](param: Param[T], value: T): TableAssembler.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  100. def setEscapeCsvDelimiter(value: Boolean): TableAssembler.this.type
  101. final def setInputCols(value: String*): TableAssembler.this.type
    Definition Classes
    HasInputAnnotationCols
  102. def setInputCols(value: Array[String]): TableAssembler.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  103. def setInputFormat(value: String): TableAssembler.this.type
  104. def setLazyAnnotator(value: Boolean): TableAssembler.this.type
    Definition Classes
    CanBeLazy
  105. final def setOutputCol(value: String): TableAssembler.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  106. def setParent(parent: Estimator[TokenAssembler]): TokenAssembler
    Definition Classes
    Model
  107. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  108. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  109. 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
  110. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  111. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  112. 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
  113. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  114. val uid: String
    Definition Classes
    TableAssembler → Identifiable
  115. 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
  116. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  117. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  118. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  119. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  120. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasSimpleAnnotate[TokenAssembler]

Inherited from AnnotatorModel[TokenAssembler]

Inherited from CanBeLazy

Inherited from RawAnnotator[TokenAssembler]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[TokenAssembler]

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

Annotator types

Required input and expected output annotator types

Members