Packages

c

com.johnsnowlabs.ml.ai

OpenAICompletion

class OpenAICompletion extends AnnotatorModel[OpenAICompletion] with HasSimpleAnnotate[OpenAICompletion]

Transformer that makes a request for OpenAI Completion API for each executor.

See also

OpenAI API Doc for reference

Example

import spark.implicits._
import com.johnsnowlabs.nlp.base.DocumentAssembler
import com.johnsnowlabs.ml.ai.OpenAICompletion
import org.apache.spark.ml.Pipeline

val documentAssembler = new DocumentAssembler()
  .setInputCol("text")
  .setOutputCol("document")

val openAICompletion = new OpenAICompletion()
 .setInputCols("document")
 .setOutputCol("completion")
 .setModel("text-davinci-003")
 .setMaxTokens(50)


val pipeline = new Pipeline().setStages(Array(
  documentAssembler,
  openAICompletion
))

val promptDF = Seq(
 "Generate a restaurant review.",
 "Write a review for a local eatery.",
 "Create a JSON with a review of a dining experience.").toDS.toDF("text")
val completionDF = pipeline.fit(promptDF).transform(promptDF)

completionDF.select("completion").show(false)
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|completion                                                                                                                                                                                                                                                                                        |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|[{document, 0, 258, \n\nI had the pleasure of dining at La Fiorita recently, and it was a truly delightful experience! The menu boasted a wonderful selection of classic Italian dishes, all exquisitely prepared and presented. The service staff was friendly and attentive and really, {}, []}]|
|[{document, 0, 227, \n\nI recently visited Barbecue Joe's for dinner and it was amazing! The menu had so many items to choose from including pulled pork, smoked turkey, brisket, pork ribs, and sandwiches. I opted for the pulled pork sandwich and let, {}, []}]                               |
|[{document, 0, 172, \n\n{ \n   "review": { \n      "overallRating": 4, \n      "reviewBody": "I enjoyed my meal at this restaurant. The food was flavourful, well-prepared and beautifully presented., {}, []}]                                                                                   |
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Linear Supertypes
HasSimpleAnnotate[OpenAICompletion], AnnotatorModel[OpenAICompletion], CanBeLazy, RawAnnotator[OpenAICompletion], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[OpenAICompletion], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpenAICompletion
  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 OpenAICompletion()
  2. new OpenAICompletion(uid: String)

    uid

    required uid for storing annotator to disk

Type Members

  1. type AnnotationContent = Seq[Row]

    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

    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]

    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

    Annotations that correspond to inputAnnotationCols generated by previous annotators if any

    returns

    any number of annotations processed for every input annotation. Not necessary one to one relationship

    Definition Classes
    OpenAICompletion → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Definition Classes
    OpenAICompletion → AnnotatorModel
  14. val bestOf: IntParam
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. final def clear(param: Param[_]): OpenAICompletion.this.type
    Definition Classes
    Params
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. def copy(extra: ParamMap): OpenAICompletion

    requirement for annotators copies

    requirement for annotators copies

    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

    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

    returns

    udf function to be applied to inputCols using this annotator's annotate function as part of ML transformation

    Definition Classes
    HasSimpleAnnotate
  22. val echo: BooleanParam
  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

    Override for additional custom schema checks

    Override for additional custom schema checks

    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. val frequencyPenalty: FloatParam
  34. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  35. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  36. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  39. def getBearerToken: String
  40. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  41. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  42. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  43. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  44. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  45. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

    Definition Classes
    OpenAICompletion → HasInputAnnotationCols
  54. final val inputCols: StringArrayParam

    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

    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  55. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  56. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  57. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  58. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  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. val logitBias: StructFeature[Option[Map[String, Int]]]
  73. val logprobs: IntParam
  74. val maxTokens: IntParam
  75. val model: Param[String]
  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. val numberOfCompletions: IntParam
  81. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  82. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  83. val outputAnnotatorType: AnnotatorType
    Definition Classes
    OpenAICompletion → HasOutputAnnotatorType
  84. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  85. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  86. var parent: Estimator[OpenAICompletion]
    Definition Classes
    Model
  87. val presencePenalty: FloatParam
  88. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  89. def set[T](feature: StructFeature[T], value: T): OpenAICompletion.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): OpenAICompletion.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. def set[T](feature: SetFeature[T], value: Set[T]): OpenAICompletion.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. def set[T](feature: ArrayFeature[T], value: Array[T]): OpenAICompletion.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. final def set(paramPair: ParamPair[_]): OpenAICompletion.this.type
    Attributes
    protected
    Definition Classes
    Params
  94. final def set(param: String, value: Any): OpenAICompletion.this.type
    Attributes
    protected
    Definition Classes
    Params
  95. final def set[T](param: Param[T], value: T): OpenAICompletion.this.type
    Definition Classes
    Params
  96. def setBearerTokenIfNotSet(spark: SparkSession, openAIKey: Option[String]): OpenAICompletion.this.type
  97. def setBestOf(value: Int): OpenAICompletion.this.type
  98. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): OpenAICompletion.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): OpenAICompletion.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): OpenAICompletion.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  101. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): OpenAICompletion.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  102. final def setDefault(paramPairs: ParamPair[_]*): OpenAICompletion.this.type
    Attributes
    protected
    Definition Classes
    Params
  103. final def setDefault[T](param: Param[T], value: T): OpenAICompletion.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  104. def setFrequencyPenalty(value: Float): OpenAICompletion.this.type
  105. final def setInputCols(value: String*): OpenAICompletion.this.type
    Definition Classes
    HasInputAnnotationCols
  106. def setInputCols(value: Array[String]): OpenAICompletion.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  107. def setLazyAnnotator(value: Boolean): OpenAICompletion.this.type
    Definition Classes
    CanBeLazy
  108. def setLogitBias(value: Option[Map[String, Int]]): OpenAICompletion.this.type
  109. def setLogprobs(value: Int): OpenAICompletion.this.type
  110. def setMaxTokens(value: Int): OpenAICompletion.this.type
  111. def setModel(value: String): OpenAICompletion.this.type
  112. def setNumberOfCompletions(value: Int): OpenAICompletion.this.type
  113. final def setOutputCol(value: String): OpenAICompletion.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  114. def setParent(parent: Estimator[OpenAICompletion]): OpenAICompletion
    Definition Classes
    Model
  115. def setPresencePenalty(value: Float): OpenAICompletion.this.type
  116. def setStop(value: Array[String]): OpenAICompletion.this.type
  117. def setSuffix(value: String): OpenAICompletion.this.type
  118. def setTemperature(value: Float): OpenAICompletion.this.type
  119. def setTopP(value: Float): OpenAICompletion.this.type
  120. def setUser(value: String): OpenAICompletion.this.type
  121. val stop: StringArrayParam
  122. val suffix: Param[String]
  123. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  124. val temperature: FloatParam
  125. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  126. val topP: FloatParam
  127. final def transform(dataset: Dataset[_]): DataFrame

    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

    Dataset[Row]

    Definition Classes
    AnnotatorModel → Transformer
  128. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  129. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  130. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

    requirement for pipeline transformation validation. It is called on fit()

    Definition Classes
    RawAnnotator → PipelineStage
  131. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  132. val uid: String
    Definition Classes
    OpenAICompletion → Identifiable
  133. val user: Param[String]
  134. def validate(schema: StructType): Boolean

    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.

    schema

    to be validated

    returns

    True if all the required types are present, else false

    Attributes
    protected
    Definition Classes
    RawAnnotator
  135. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  136. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  138. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  139. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasSimpleAnnotate[OpenAICompletion]

Inherited from AnnotatorModel[OpenAICompletion]

Inherited from CanBeLazy

Inherited from RawAnnotator[OpenAICompletion]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[OpenAICompletion]

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

Members