class OpenAIPrompt extends Transformer with HasOpenAITextParamsExtended with HasMessagesInput with HasErrorCol with HasOutputCol with HasURL with HasCustomCogServiceDomain with ConcurrencyParams with HasSubscriptionKey with HasAADToken with HasCustomAuthHeader with HasCognitiveServiceInput with ComplexParamsWritable with SynapseMLLogging with HasGlobalParams

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpenAIPrompt
  2. HasGlobalParams
  3. ComplexParamsWritable
  4. MLWritable
  5. HasCognitiveServiceInput
  6. SynapseMLLogging
  7. HasCustomHeaders
  8. HasCustomAuthHeader
  9. HasAADToken
  10. HasSubscriptionKey
  11. ConcurrencyParams
  12. HasCustomCogServiceDomain
  13. HasUrlPath
  14. Wrappable
  15. RWrappable
  16. PythonWrappable
  17. BaseWrappable
  18. HasURL
  19. HasOutputCol
  20. HasErrorCol
  21. HasMessagesInput
  22. HasOpenAITextParamsExtended
  23. HasOpenAITextParams
  24. HasOpenAISharedParams
  25. HasAPIVersion
  26. HasServiceParams
  27. Transformer
  28. PipelineStage
  29. Logging
  30. Params
  31. Serializable
  32. Serializable
  33. Identifiable
  34. AnyRef
  35. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OpenAIPrompt()
  2. new OpenAIPrompt(uid: String)

Value Members

  1. val AADToken: ServiceParam[String]
    Definition Classes
    HasAADToken
  2. val CustomAuthHeader: ServiceParam[String]
    Definition Classes
    HasCustomAuthHeader
  3. val apiVersion: ServiceParam[String]
    Definition Classes
    HasAPIVersion
  4. val bestOf: ServiceParam[Int]
    Definition Classes
    HasOpenAITextParams
  5. val cacheLevel: ServiceParam[Int]
    Definition Classes
    HasOpenAITextParams
  6. final def clear(param: Param[_]): OpenAIPrompt.this.type
    Definition Classes
    Params
  7. val concurrency: Param[Int]
    Definition Classes
    ConcurrencyParams
  8. val concurrentTimeout: Param[Double]
    Definition Classes
    ConcurrencyParams
  9. def copy(extra: ParamMap): Transformer
    Definition Classes
    OpenAIPrompt → Transformer → PipelineStage → Params
  10. val customHeaders: ServiceParam[Map[String, String]]
    Definition Classes
    HasCustomHeaders
  11. val customUrlRoot: Param[String]
    Definition Classes
    HasCognitiveServiceInput
  12. val deploymentName: ServiceParam[String]
    Definition Classes
    HasOpenAISharedParams
  13. val dropPrompt: BooleanParam
  14. val echo: ServiceParam[Boolean]
    Definition Classes
    HasOpenAITextParams
  15. val errorCol: Param[String]
    Definition Classes
    HasErrorCol
  16. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  17. def explainParams(): String
    Definition Classes
    Params
  18. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  19. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  20. val frequencyPenalty: ServiceParam[Double]
    Definition Classes
    HasOpenAITextParams
  21. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  22. def getAADToken: String
    Definition Classes
    HasAADToken
  23. def getAADTokenCol: String
    Definition Classes
    HasAADToken
  24. def getApiVersion: String
    Definition Classes
    HasAPIVersion
  25. def getApiVersionCol: String
    Definition Classes
    HasAPIVersion
  26. def getBestOf: Int
    Definition Classes
    HasOpenAITextParams
  27. def getBestOfCol: String
    Definition Classes
    HasOpenAITextParams
  28. def getCacheLevel: Int
    Definition Classes
    HasOpenAITextParams
  29. def getCacheLevelCol: String
    Definition Classes
    HasOpenAITextParams
  30. def getConcurrency: Int

    Definition Classes
    ConcurrencyParams
  31. def getConcurrentTimeout: Double

    Definition Classes
    ConcurrencyParams
  32. def getCustomAuthHeader: String
    Definition Classes
    HasCustomAuthHeader
  33. def getCustomAuthHeaderCol: String
    Definition Classes
    HasCustomAuthHeader
  34. def getCustomHeaders: Map[String, String]
    Definition Classes
    HasCustomHeaders
  35. def getCustomUrlRoot: String
    Definition Classes
    HasCognitiveServiceInput
  36. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  37. def getDeploymentName: String
    Definition Classes
    HasOpenAISharedParams
  38. def getDeploymentNameCol: String
    Definition Classes
    HasOpenAISharedParams
  39. def getDropPrompt: Boolean
  40. def getEcho: Boolean
    Definition Classes
    HasOpenAITextParams
  41. def getEchoCol: String
    Definition Classes
    HasOpenAITextParams
  42. def getErrorCol: String
    Definition Classes
    HasErrorCol
  43. def getFrequencyPenalty: Double
    Definition Classes
    HasOpenAITextParams
  44. def getFrequencyPenaltyCol: String
    Definition Classes
    HasOpenAITextParams
  45. def getInternalServiceType: String
    Definition Classes
    HasCustomCogServiceDomain
  46. def getLogProbs: Int
    Definition Classes
    HasOpenAITextParams
  47. def getLogProbsCol: String
    Definition Classes
    HasOpenAITextParams
  48. def getMaxTokens: Int
    Definition Classes
    HasOpenAITextParams
  49. def getMaxTokensCol: String
    Definition Classes
    HasOpenAITextParams
  50. def getMessagesCol: String
    Definition Classes
    HasMessagesInput
  51. def getN: Int
    Definition Classes
    HasOpenAITextParams
  52. def getNCol: String
    Definition Classes
    HasOpenAITextParams
  53. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  54. def getOutputCol: String

    Definition Classes
    HasOutputCol
  55. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  56. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  57. def getPostProcessing: String
  58. def getPostProcessingOptions: Map[String, String]
  59. def getPresencePenalty: Double
    Definition Classes
    HasOpenAITextParams
  60. def getPresencePenaltyCol: String
    Definition Classes
    HasOpenAITextParams
  61. def getPromptTemplate: String
  62. def getResponseFormat: Map[String, String]
    Definition Classes
    HasOpenAITextParamsExtended
  63. def getScalarParam[T](name: String): T
    Definition Classes
    HasServiceParams
  64. def getScalarParam[T](p: ServiceParam[T]): T
    Definition Classes
    HasServiceParams
  65. def getStop: String
    Definition Classes
    HasOpenAITextParams
  66. def getStopCol: String
    Definition Classes
    HasOpenAITextParams
  67. def getSubscriptionKey: String
    Definition Classes
    HasSubscriptionKey
  68. def getSubscriptionKeyCol: String
    Definition Classes
    HasSubscriptionKey
  69. def getSystemPrompt: String
  70. def getTemperature: Double
    Definition Classes
    HasOpenAITextParams
  71. def getTemperatureCol: String
    Definition Classes
    HasOpenAITextParams
  72. def getTimeout: Double

    Definition Classes
    ConcurrencyParams
  73. def getTopP: Double
    Definition Classes
    HasOpenAITextParams
  74. def getTopPCol: String
    Definition Classes
    HasOpenAITextParams
  75. def getUrl: String

    Definition Classes
    HasCognitiveServiceInputHasURL
  76. def getUser: String
    Definition Classes
    HasOpenAISharedParams
  77. def getUserCol: String
    Definition Classes
    HasOpenAISharedParams
  78. def getVectorParam(name: String): String
    Definition Classes
    HasServiceParams
  79. def getVectorParam(p: ServiceParam[_]): String
    Definition Classes
    HasServiceParams
  80. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  81. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  82. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  83. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  84. def logClass(featureName: String): Unit
    Definition Classes
    SynapseMLLogging
  85. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  86. val logProbs: ServiceParam[Int]
    Definition Classes
    HasOpenAITextParams
  87. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  88. def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
    Definition Classes
    SynapseMLLogging
  89. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  90. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  91. val maxTokens: ServiceParam[Int]
    Definition Classes
    HasOpenAITextParams
  92. val messagesCol: Param[String]
    Definition Classes
    HasMessagesInput
  93. val n: ServiceParam[Int]
    Definition Classes
    HasOpenAITextParams
  94. val outputCol: Param[String]

    The name of the output column

    The name of the output column

    Definition Classes
    HasOutputCol
  95. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  96. val postProcessing: Param[String]
  97. val postProcessingOptions: StringStringMapParam
  98. val presencePenalty: ServiceParam[Double]
    Definition Classes
    HasOpenAITextParams
  99. val promptTemplate: Param[String]
  100. def pyAdditionalMethods: String
  101. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  102. val responseFormat: ServiceParam[Map[String, String]]
    Definition Classes
    HasOpenAITextParamsExtended
  103. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  104. final def set[T](param: Param[T], value: T): OpenAIPrompt.this.type
    Definition Classes
    Params
  105. def setAADToken(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasAADToken
  106. def setAADTokenCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasAADToken
  107. def setApiVersion(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasAPIVersion
  108. def setApiVersionCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasAPIVersion
  109. def setBestOf(v: Int): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  110. def setBestOfCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  111. def setCacheLevel(v: Int): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  112. def setCacheLevelCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  113. def setConcurrency(value: Int): OpenAIPrompt.this.type

    Definition Classes
    ConcurrencyParams
  114. def setConcurrentTimeout(value: Option[Double]): OpenAIPrompt.this.type
    Definition Classes
    ConcurrencyParams
  115. def setConcurrentTimeout(value: Double): OpenAIPrompt.this.type

    Definition Classes
    ConcurrencyParams
  116. def setCustomAuthHeader(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasCustomAuthHeader
  117. def setCustomAuthHeaderCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasCustomAuthHeader
  118. def setCustomHeaders(v: HashMap[String, String]): OpenAIPrompt.this.type
    Definition Classes
    HasCustomHeaders
  119. def setCustomHeaders(v: Map[String, String]): OpenAIPrompt.this.type
    Definition Classes
    HasCustomHeaders
  120. def setCustomServiceName(v: String): OpenAIPrompt.this.type
  121. def setCustomUrlRoot(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasCognitiveServiceInput
  122. def setDefaultAADToken(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasAADToken
  123. def setDefaultCustomAuthHeader(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasCustomAuthHeader
  124. def setDefaultInternalEndpoint(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasCustomCogServiceDomain
  125. def setDeploymentName(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAISharedParams
  126. def setDeploymentNameCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAISharedParams
  127. def setDropPrompt(value: Boolean): OpenAIPrompt.this.type
  128. def setEcho(v: Boolean): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  129. def setEchoCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  130. def setEndpoint(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasCustomCogServiceDomain
  131. def setErrorCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasErrorCol
  132. def setFrequencyPenalty(v: Double): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  133. def setFrequencyPenaltyCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  134. def setLogProbs(v: Int): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  135. def setLogProbsCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  136. def setMaxTokens(v: Int): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  137. def setMaxTokensCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  138. def setMessagesCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasMessagesInput
  139. def setN(v: Int): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  140. def setNCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  141. def setOutputCol(value: String): OpenAIPrompt.this.type

    Definition Classes
    HasOutputCol
  142. def setPostProcessing(value: String): OpenAIPrompt.this.type
  143. def setPostProcessingOptions(v: HashMap[String, String]): OpenAIPrompt.this.type
  144. def setPostProcessingOptions(value: Map[String, String]): OpenAIPrompt.this.type
  145. def setPresencePenalty(v: Double): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  146. def setPresencePenaltyCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  147. def setPromptTemplate(value: String): OpenAIPrompt.this.type
  148. def setResponseFormat(value: ResponseFormat): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParamsExtended
  149. def setResponseFormat(value: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParamsExtended
  150. def setResponseFormat(value: Map[String, String]): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParamsExtended
  151. def setScalarParam[T](name: String, value: T): OpenAIPrompt.this.type
    Definition Classes
    HasServiceParams
  152. def setScalarParam[T](p: ServiceParam[T], value: T): OpenAIPrompt.this.type
    Definition Classes
    HasServiceParams
  153. def setStop(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  154. def setStopCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  155. def setSubscriptionKey(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasSubscriptionKey
  156. def setSubscriptionKeyCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasSubscriptionKey
  157. def setSystemPrompt(value: String): OpenAIPrompt.this.type
  158. def setTemperature(v: Double): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  159. def setTemperatureCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  160. def setTimeout(value: Double): OpenAIPrompt.this.type

    Definition Classes
    ConcurrencyParams
  161. def setTopP(v: Double): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  162. def setTopPCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAITextParams
  163. def setUrl(value: String): OpenAIPrompt.this.type

    Definition Classes
    HasURL
  164. def setUser(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAISharedParams
  165. def setUserCol(v: String): OpenAIPrompt.this.type
    Definition Classes
    HasOpenAISharedParams
  166. def setVectorParam(name: String, value: String): OpenAIPrompt.this.type
    Definition Classes
    HasServiceParams
  167. def setVectorParam[T](p: ServiceParam[T], value: String): OpenAIPrompt.this.type
    Definition Classes
    HasServiceParams
  168. val stop: ServiceParam[String]
    Definition Classes
    HasOpenAITextParams
  169. val subscriptionKey: ServiceParam[String]
    Definition Classes
    HasSubscriptionKey
  170. val systemPrompt: Param[String]
  171. val temperature: ServiceParam[Double]
    Definition Classes
    HasOpenAITextParams
  172. val timeout: Param[Double]
    Definition Classes
    ConcurrencyParams
  173. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  174. val topP: ServiceParam[Double]
    Definition Classes
    HasOpenAITextParams
  175. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    OpenAIPrompt → Transformer
  176. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  177. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  178. def transformSchema(schema: StructType): StructType
    Definition Classes
    OpenAIPrompt → PipelineStage
  179. val uid: String
    Definition Classes
    OpenAIPromptSynapseMLLogging → Identifiable
  180. val url: Param[String]
    Definition Classes
    HasURL
  181. def urlPath: String
    Definition Classes
    OpenAIPromptHasUrlPath
  182. val user: ServiceParam[String]
    Definition Classes
    HasOpenAISharedParams
  183. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable