sparknlp_jsl.annotator.source_tracking_metadata_params#

Classes#

class SourceTrackingMetadataParams#

Bases: sparknlp_jsl.annotator.params.reset_sentence_indices_param.ResetSentenceIndicesParam

It is a base class that reset sentence indices to treat the entire output as if it originates from a single document.

allPossibleFieldsToStandardize#

includeOutputColumn#

includeStandardField#

outputColumnKey#

resetSentenceIndices#

standardFieldKey#

setAllPossibleFieldsToStandardize(fields)#

Sets array with all possible fields containing the value to write in the standard field ordered by priority

Parameters:

fields (list) – array with all possible fields containing the value to write in the standard field ordered by priority

setIncludeOutputColumn(p)#

Sets whether to include a metadata key/value to specify the output column name for the annotation

Parameters:

p (bool) – whether to include a metadata key/value to specify the output column name for the annotation

setIncludeStandardField(p)#

Sets whether to include a metadata key/value to specify the output column name for the annotation

Parameters:

p (bool) – whether to include a metadata key/value to specify the output column name for the annotation

setOutputColumnKey(s)#

Set key name for the source column value

Parameters:

s (str) – key name for the source column value

setResetSentenceIndices(value)#

Set whether to reset sentence indices to treat the entire output as if it originates from a single document.

When set to true, the metadata of each entity will be updated by assigning the sentence key a value of 0, effectively treating the entire output as if it originates from a single document. regardless of the original sentence boundaries. Default: False.

Parameters:

value (bool) – If set to true, sentence indices will be reset to treat the entire output as if it originates from a single document.

setStandardFieldKey(s)#

Set key name for the source column value

Parameters:

s (str) – key name for the source column value