Packages

class MetadataAnnotationConverter extends AnnotatorModel[MetadataAnnotationConverter] with HasSimpleAnnotate[MetadataAnnotationConverter]

Converts metadata fields in annotations into their respective result, begin, or end values.

In certain pipelines, annotations carry rich metadata such as normalized values, custom offsets, or alternative representations. MetadataAnnotationConverter is a helper component that transforms these metadata fields into actual Annotation fields. This can be used to ensure consistency or to override noisy model predictions with more reliable metadata-derived information.

Notes

This annotator assumes that metadata fields like begin_key, end_key, or result_key contain values that can override the corresponding fields in the original annotation. If a metadata key is missing or invalid, the original annotation's values are used.

Example

Use the converter to override annotation fields from metadata:

val converter = new MetadataAnnotationConverter()
  .setInputAnnotatorType("chunk")
  .setResultField("normalized")
  .setBeginField("char_start")
  .setEndField("char_end")
  .setInputCols("chunk")  // input should match inputAnnotatorType
  .setOutputCol("converted_chunk")

After transformation, the annotation in converted_chunk will use metadata if available.

Linear Supertypes
HasSimpleAnnotate[MetadataAnnotationConverter], AnnotatorModel[MetadataAnnotationConverter], CanBeLazy, RawAnnotator[MetadataAnnotationConverter], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[MetadataAnnotationConverter], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. MetadataAnnotationConverter
  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 MetadataAnnotationConverter()
  2. new MetadataAnnotationConverter(uid: String)

    uid

    a unique identifier for the instantiated AnnotatorModel

Type Members

  1. type AnnotationContent = Seq[Row]
    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
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]
    Definition Classes
    MetadataAnnotationConverter → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  14. val beginField: Param[String]

    Name of the metadata field that contains the begin offset.

    Name of the metadata field that contains the begin offset. If not present or invalid, the original Annotation.begin is used.

  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. final def clear(param: Param[_]): MetadataAnnotationConverter.this.type
    Definition Classes
    Params
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. def copy(extra: ParamMap): MetadataAnnotationConverter
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  19. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  21. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  22. val endField: Param[String]

    Name of the metadata field that contains the end offset.

    Name of the metadata field that contains the end offset. If not present or invalid, the original Annotation.end is used.

  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  26. def explainParams(): String
    Definition Classes
    Params
  27. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  28. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  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. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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. def getBeginField: String

    Gets the metadata key used as the begin offset.

  39. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  40. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  41. def getEndField: String

    Gets the metadata key used as the end offset.

  42. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  43. def getInputType(): String
  44. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  45. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  46. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  47. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  48. def getResultField: String

    Gets the metadata key used as the result value.

  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. lazy val inputAnnotatorTypes: Array[String]
    Definition Classes
    MetadataAnnotationConverter → HasInputAnnotationCols
  56. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  57. val inputLazyType: String
  58. val inputType: Param[String]
  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. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  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. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  77. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  78. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  79. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  80. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  81. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  82. lazy val outputAnnotatorType: String
    Definition Classes
    MetadataAnnotationConverter → HasOutputAnnotatorType
  83. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  84. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  85. var parent: Estimator[MetadataAnnotationConverter]
    Definition Classes
    Model
  86. val resultField: Param[String]

    Name of the metadata field that contains the actual result value.

    Name of the metadata field that contains the actual result value. If not set or metadata is missing, the original Annotation.result will be used.

  87. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  88. def set[T](feature: StructFeature[T], value: T): MetadataAnnotationConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  89. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): MetadataAnnotationConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. def set[T](feature: SetFeature[T], value: Set[T]): MetadataAnnotationConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. def set[T](feature: ArrayFeature[T], value: Array[T]): MetadataAnnotationConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. final def set(paramPair: ParamPair[_]): MetadataAnnotationConverter.this.type
    Attributes
    protected
    Definition Classes
    Params
  93. final def set(param: String, value: Any): MetadataAnnotationConverter.this.type
    Attributes
    protected
    Definition Classes
    Params
  94. final def set[T](param: Param[T], value: T): MetadataAnnotationConverter.this.type
    Definition Classes
    Params
  95. def setBeginField(value: String): MetadataAnnotationConverter.this.type

    Sets the metadata key to use as the new begin offset of the annotation.

  96. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): MetadataAnnotationConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): MetadataAnnotationConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): MetadataAnnotationConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): MetadataAnnotationConverter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. final def setDefault(paramPairs: ParamPair[_]*): MetadataAnnotationConverter.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. final def setDefault[T](param: Param[T], value: T): MetadataAnnotationConverter.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  102. def setEndField(value: String): MetadataAnnotationConverter.this.type

    Sets the metadata key to use as the new end offset of the annotation.

  103. final def setInputCols(value: String*): MetadataAnnotationConverter.this.type
    Definition Classes
    HasInputAnnotationCols
  104. def setInputCols(value: Array[String]): MetadataAnnotationConverter.this.type
    Definition Classes
    HasInputAnnotationCols
  105. def setInputType(value: String): MetadataAnnotationConverter.this.type
  106. def setLazyAnnotator(value: Boolean): MetadataAnnotationConverter.this.type
    Definition Classes
    CanBeLazy
  107. final def setOutputCol(value: String): MetadataAnnotationConverter.this.type
    Definition Classes
    HasOutputAnnotationCol
  108. def setParent(parent: Estimator[MetadataAnnotationConverter]): MetadataAnnotationConverter
    Definition Classes
    Model
  109. def setResultField(value: String): MetadataAnnotationConverter.this.type

    Sets the metadata key to use as the new result field of the annotation.

  110. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  111. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  112. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  113. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  114. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  115. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  116. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  117. val uid: String
    Definition Classes
    MetadataAnnotationConverter → Identifiable
  118. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    MetadataAnnotationConverter → RawAnnotator
  119. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  120. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  121. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  122. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  123. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasSimpleAnnotate[MetadataAnnotationConverter]

Inherited from AnnotatorModel[MetadataAnnotationConverter]

Inherited from CanBeLazy

Inherited from RawAnnotator[MetadataAnnotationConverter]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[MetadataAnnotationConverter]

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

Parameters

Members

Parameter setters

Parameter getters