Packages

c

com.johnsnowlabs.nlp.annotators.qa

NerQuestionGenerator

class NerQuestionGenerator extends AnnotatorModel[NerQuestionGenerator] with HasSimpleAnnotate[NerQuestionGenerator] with CheckLicense

Automatically generates questions for NER.

This annotator takes a NER chunk (obtained by, e.g., NerConverterInternal) and generates a questions based on two entity types, a pronoun and a strategy.

The question is generated in the form of [QUESTIONPRONOUN] [ENTITY1] [ENTITY2] [QUESTIONMARK].

The generated question can be used by QuestionAnswerer annotator to find answers to the generated questions.

Pretrained models can be loaded with pretrained of the companion object:

val medQA = NerQuestionGenerator.pretrained()
  .setInputCols("ner_chunk")
  .setOutputCol("question")
Linear Supertypes
CheckLicense, HasSimpleAnnotate[NerQuestionGenerator], AnnotatorModel[NerQuestionGenerator], CanBeLazy, RawAnnotator[NerQuestionGenerator], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[NerQuestionGenerator], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
FinanceNerQuestionGenerator, LegalNerQuestionGenerator
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. NerQuestionGenerator
  2. CheckLicense
  3. HasSimpleAnnotate
  4. AnnotatorModel
  5. CanBeLazy
  6. RawAnnotator
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. HasOutputAnnotatorType
  10. ParamsAndFeaturesWritable
  11. HasFeatures
  12. DefaultParamsWritable
  13. MLWritable
  14. Model
  15. Transformer
  16. PipelineStage
  17. Logging
  18. Params
  19. Serializable
  20. Serializable
  21. Identifiable
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NerQuestionGenerator()
  2. new NerQuestionGenerator(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
    NerQuestionGenerator → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    NerQuestionGenerator → AnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String]): Unit
    Definition Classes
    CheckLicense
  16. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  17. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  18. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  19. final def clear(param: Param[_]): NerQuestionGenerator.this.type
    Definition Classes
    Params
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. def copy(extra: ParamMap): NerQuestionGenerator
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  22. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  23. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  25. val entities1: StringArrayParam

    List with the entity types of entities that appear first in the question.

  26. val entities2: StringArrayParam

    List with the entity types of entities that appear second in the question.

  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  29. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  30. def explainParams(): String
    Definition Classes
    Params
  31. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  32. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  33. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  34. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  35. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  36. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  42. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  45. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  46. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  47. final def getOutputCol: String
    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 type : CHUNK

    Input annotator type : CHUNK

    Definition Classes
    NerQuestionGenerator → HasInputAnnotationCols
  56. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  57. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  58. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  59. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  60. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  61. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  62. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  63. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  70. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  75. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  76. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  77. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  78. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  79. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  80. val outputAnnotatorType: AnnotatorType

    Output annotator type : DOCUMENT

    Output annotator type : DOCUMENT

    Definition Classes
    NerQuestionGenerator → HasOutputAnnotatorType
  81. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  82. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  83. var parent: Estimator[NerQuestionGenerator]
    Definition Classes
    Model
  84. val questionMark: BooleanParam

    Whether to add a question mark at the end of the question.

  85. val questionPronoun: Param[String]

    Pronoun to be used in the question.

    Pronoun to be used in the question. E.g., 'When', 'Where', 'Why', 'How', 'Who', 'What'.

  86. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  87. def set[T](feature: StructFeature[T], value: T): NerQuestionGenerator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  88. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): NerQuestionGenerator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  89. def set[T](feature: SetFeature[T], value: Set[T]): NerQuestionGenerator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. def set[T](feature: ArrayFeature[T], value: Array[T]): NerQuestionGenerator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. final def set(paramPair: ParamPair[_]): NerQuestionGenerator.this.type
    Attributes
    protected
    Definition Classes
    Params
  92. final def set(param: String, value: Any): NerQuestionGenerator.this.type
    Attributes
    protected
    Definition Classes
    Params
  93. final def set[T](param: Param[T], value: T): NerQuestionGenerator.this.type
    Definition Classes
    Params
  94. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): NerQuestionGenerator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  95. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): NerQuestionGenerator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): NerQuestionGenerator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): NerQuestionGenerator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. final def setDefault(paramPairs: ParamPair[_]*): NerQuestionGenerator.this.type
    Attributes
    protected
    Definition Classes
    Params
  99. final def setDefault[T](param: Param[T], value: T): NerQuestionGenerator.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  100. def setEntities1(list: String*): NerQuestionGenerator.this.type

  101. def setEntities2(list: String*): NerQuestionGenerator.this.type

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

  108. def setQuestionPronoun(value: String): NerQuestionGenerator

  109. def setStrategy(value: String): NerQuestionGenerator

    Sets the strategy to be used in the proccess.

    Sets the strategy to be used in the proccess. Either Paired or Combined.

    If set to Paired (default), applies a one-vs-one strategy. In this case, the number of chunks in Entity 1 must be aligned with the number of chunks in Entity 2. E.g., if Entity 1 has 3 chunks and Entity 2 has 3 chunks, the first chunk of Entity 1 will be grouped with first chunk of Entity 2, the second with second, third with third, etc.

    If set to Combined, applies a one-vs-all strategy. In this case, the number of chunks in Entity 1 don't need to be the same as the number of chunks in Entity 2, and each chunk in Entity 1 will be grouped with all chunks in Entity 2.

  110. val strategyType: Param[String]

    Strategy for the proccess.

    Strategy for the proccess. Either Paired or Combined.

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

Inherited from CheckLicense

Inherited from HasSimpleAnnotate[NerQuestionGenerator]

Inherited from AnnotatorModel[NerQuestionGenerator]

Inherited from CanBeLazy

Inherited from RawAnnotator[NerQuestionGenerator]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[NerQuestionGenerator]

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