Packages

class ContextSplitAssembler extends AnnotatorModel[ContextSplitAssembler] with HasSimpleAnnotate[ContextSplitAssembler]

Converts and assembles VECTOR_SIMILARITY_RANKINGS type annotations into DOCUMENT type. The input annotations are expected to be of type VECTOR_SIMILARITY_RANKINGS and the output annotation type is DOCUMENT. It concatenates the results of the input annotations into a single result, separated by a join string. When explodeSplits is set to true, the splits are exploded into separate annotations. joinString parameter is used to add the delimiter between results of annotations when combining them into a single result.

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

    uid

    required uid for storing annotator to disk

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
    ContextSplitAssembler → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. final def clear(param: Param[_]): ContextSplitAssembler.this.type
    Definition Classes
    Params
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  17. def copy(extra: ParamMap): ContextSplitAssembler
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  18. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  19. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  24. def explainParams(): String
    Definition Classes
    Params
  25. val explodeSplits: BooleanParam

    Whether to explode the splits into separate annotations or not.

    Whether to explode the splits into separate annotations or not. Default: false

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

    Get explodeSplits param.

  40. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  41. def getJoinString: String

    Get joinString param.

  42. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  43. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  44. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  45. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  46. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  47. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  48. def hasParent: Boolean
    Definition Classes
    Model
  49. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  50. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  51. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. val inputAnnotatorTypes: Array[String]

    Input annotator types: VECTOR_SIMILARITY_RANKINGS

    Input annotator types: VECTOR_SIMILARITY_RANKINGS

    Definition Classes
    ContextSplitAssembler → HasInputAnnotationCols
  53. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  54. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  55. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  56. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  57. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  58. val joinString: Param[String]

    This parameter specifies the string that will be inserted between results of annotations when combining them into a single result.

    This parameter specifies the string that will be inserted between results of annotations when combining them into a single result. It acts as a delimiter, ensuring that the elements are properly separated and organized in the final result of annotation. Default: " "

  59. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  60. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  61. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  68. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  73. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  74. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  75. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  76. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  77. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  78. val outputAnnotatorType: String

    outputAnnotatorType: DOCUMENT

    outputAnnotatorType: DOCUMENT

    Definition Classes
    ContextSplitAssembler → HasOutputAnnotatorType
  79. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  80. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  81. var parent: Estimator[ContextSplitAssembler]
    Definition Classes
    Model
  82. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  83. def set[T](feature: StructFeature[T], value: T): ContextSplitAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  84. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ContextSplitAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  85. def set[T](feature: SetFeature[T], value: Set[T]): ContextSplitAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  86. def set[T](feature: ArrayFeature[T], value: Array[T]): ContextSplitAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  87. final def set(paramPair: ParamPair[_]): ContextSplitAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  88. final def set(param: String, value: Any): ContextSplitAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  89. final def set[T](param: Param[T], value: T): ContextSplitAssembler.this.type
    Definition Classes
    Params
  90. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ContextSplitAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ContextSplitAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ContextSplitAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ContextSplitAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  94. final def setDefault(paramPairs: ParamPair[_]*): ContextSplitAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  95. final def setDefault[T](param: Param[T], value: T): ContextSplitAssembler.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  96. def setExplodeSplits(value: Boolean): ContextSplitAssembler.this.type

    Set whether to explode the splits into separate annotations or not.

    Set whether to explode the splits into separate annotations or not. Default: false

  97. final def setInputCols(value: String*): ContextSplitAssembler.this.type
    Definition Classes
    HasInputAnnotationCols
  98. def setInputCols(value: Array[String]): ContextSplitAssembler.this.type
    Definition Classes
    HasInputAnnotationCols
  99. def setJoinString(value: String): ContextSplitAssembler.this.type

    Set the string that will be inserted between results of annotations when combining them into a single result.

    Set the string that will be inserted between results of annotations when combining them into a single result. Default: " "

  100. def setLazyAnnotator(value: Boolean): ContextSplitAssembler.this.type
    Definition Classes
    CanBeLazy
  101. final def setOutputCol(value: String): ContextSplitAssembler.this.type
    Definition Classes
    HasOutputAnnotationCol
  102. def setParent(parent: Estimator[ContextSplitAssembler]): ContextSplitAssembler
    Definition Classes
    Model
  103. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  104. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  105. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  106. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  107. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  108. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  109. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  110. val uid: String
    Definition Classes
    ContextSplitAssembler → Identifiable
  111. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  112. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  113. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  114. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  115. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  116. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasSimpleAnnotate[ContextSplitAssembler]

Inherited from AnnotatorModel[ContextSplitAssembler]

Inherited from CanBeLazy

Inherited from RawAnnotator[ContextSplitAssembler]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[ContextSplitAssembler]

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

A list of (hyper-)parameter keys this annotator can take. Users can set and get the parameter values through setters and getters, respectively.

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters