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
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 that correspond to inputAnnotationCols generated by previous annotators if any
any number of annotations processed for every input annotation. Not necessary one to one relationship
requirement for annotators copies
requirement for annotators copies
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
udf function to be applied to inputCols using this annotator's annotate function as part of ML transformation
Override for additional custom schema checks
Override for additional custom schema checks
input annotations columns currently used
Gets annotation column name going to generate
Gets annotation column name going to generate
Input annotator type: DOCUMENT
Input annotator type: DOCUMENT
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
Maximum token length, greater than or equal to 1.
Minimum token length, greater than or equal to 0 (Default: 1
).
Minimum token length, greater than or equal to 0 (Default: 1
).
Default is 1, to avoid returning empty strings.
Output annotator type: TOKEN
Output annotator type: TOKEN
Regex pattern used to match delimiters (Default: "\\s+"
)
Indicates whether to apply the regex tokenization using a positional mask to guarantee the incremental progression
(Default: false
).
Overrides required annotators column if different than default
Overrides required annotators column if different than default
Overrides annotation column name when transforming
Overrides annotation column name when transforming
This func generates a Seq of TokenizedSentences from a Seq of Sentences.
This func generates a Seq of TokenizedSentences from a Seq of Sentences.
to tag
Seq of TokenizedSentence objects
This func generates a Seq of TokenizedSentences from a Seq of Sentences preserving positional progression
This func generates a Seq of TokenizedSentences from a Seq of Sentences preserving positional progression
to tag
Seq of TokenizedSentence objects
Indicates whether to convert all characters to lowercase before tokenizing (Default: false
).
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[Row]
requirement for pipeline transformation validation.
requirement for pipeline transformation validation. It is called on fit()
required uid for storing annotator to disk
required uid for storing annotator to disk
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.
to be validated
True if all the required types are present, else false
A list of (hyper-)parameter keys this annotator can take. Users can set and get the parameter values through setters and getters, respectively.
Required input and expected output annotator types
A tokenizer that splits text by a regex pattern.
The pattern needs to be set with
setPattern
and this sets the delimiting pattern or how the tokens should be split. By default this pattern is\s+
which means that tokens should be split by 1 or more whitespace characters.Example