Packages

c

com.microsoft.azure.synapse.ml.cognitive

CognitiveServicesBase

abstract class CognitiveServicesBase extends CognitiveServicesBaseNoHandler with HasHandler

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CognitiveServicesBase
  2. HasHandler
  3. CognitiveServicesBaseNoHandler
  4. SynapseMLLogging
  5. HasCustomCogServiceDomain
  6. HasUrlPath
  7. HasAADToken
  8. HasErrorCol
  9. HasSubscriptionKey
  10. HasServiceParams
  11. ComplexParamsWritable
  12. MLWritable
  13. HasURL
  14. HasOutputCol
  15. ConcurrencyParams
  16. Wrappable
  17. DotnetWrappable
  18. RWrappable
  19. PythonWrappable
  20. BaseWrappable
  21. Transformer
  22. PipelineStage
  23. Logging
  24. Params
  25. Serializable
  26. Serializable
  27. Identifiable
  28. AnyRef
  29. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CognitiveServicesBase(uid: String)

Abstract Value Members

  1. abstract def getInternalInputParser(schema: StructType): HTTPInputParser
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseNoHandler
  2. abstract def getInternalOutputParser(schema: StructType): HTTPOutputParser
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseNoHandler
  3. abstract def urlPath: String
    Definition Classes
    HasUrlPath

Concrete 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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. val AADToken: ServiceParam[String]
    Definition Classes
    HasAADToken
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  8. final def clear(param: Param[_]): CognitiveServicesBase.this.type
    Definition Classes
    Params
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  11. val concurrency: Param[Int]
    Definition Classes
    ConcurrencyParams
  12. val concurrentTimeout: Param[Double]
    Definition Classes
    ConcurrencyParams
  13. def copy(extra: ParamMap): Transformer
    Definition Classes
    CognitiveServicesBaseNoHandler → Transformer → PipelineStage → Params
  14. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  15. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  16. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  17. def dotnetAdditionalMethods: String
    Definition Classes
    HasCustomCogServiceDomain → DotnetWrappable
  18. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  19. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  20. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  21. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  22. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  23. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  24. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  25. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  26. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  27. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  28. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  29. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  30. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  31. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  32. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  33. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  34. def emptyParamData[T](row: Row, p: ServiceParam[T]): Boolean
    Attributes
    protected
    Definition Classes
    HasServiceParams
  35. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  37. val errorCol: Param[String]
    Definition Classes
    HasErrorCol
  38. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  39. def explainParams(): String
    Definition Classes
    Params
  40. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  41. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  42. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  43. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. def getAADToken: String
    Definition Classes
    HasAADToken
  45. def getAADTokenCol: String
    Definition Classes
    HasAADToken
  46. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  47. def getConcurrency: Int

    Definition Classes
    ConcurrencyParams
  48. def getConcurrentTimeout: Double

    Definition Classes
    ConcurrencyParams
  49. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  50. def getErrorCol: String
    Definition Classes
    HasErrorCol
  51. def getHandler: HandlerFunc

    Definition Classes
    HasHandler
  52. def getInternalServiceType: String
    Definition Classes
    HasCustomCogServiceDomain
  53. def getInternalTransformer(schema: StructType): PipelineModel
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseNoHandler
  54. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  55. def getOutputCol: String

    Definition Classes
    HasOutputCol
  56. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  57. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  58. def getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  59. def getRequiredParams: Array[ServiceParam[_]]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  60. def getScalarParam[T](name: String): T
    Definition Classes
    HasServiceParams
  61. def getScalarParam[T](p: ServiceParam[T]): T
    Definition Classes
    HasServiceParams
  62. def getSubscriptionKey: String
    Definition Classes
    HasSubscriptionKey
  63. def getSubscriptionKeyCol: String
    Definition Classes
    HasSubscriptionKey
  64. def getTimeout: Double

    Definition Classes
    ConcurrencyParams
  65. def getUrl: String

    Definition Classes
    HasCustomCogServiceDomain → HasURL
  66. def getUrlParams: Array[ServiceParam[_]]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  67. def getValue[T](row: Row, p: ServiceParam[T]): T
    Attributes
    protected
    Definition Classes
    HasServiceParams
  68. def getValueAny(row: Row, p: ServiceParam[_]): Any
    Attributes
    protected
    Definition Classes
    HasServiceParams
  69. def getValueAnyOpt(row: Row, p: ServiceParam[_]): Option[Any]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  70. def getValueMap(row: Row, excludes: Set[ServiceParam[_]] = Set()): Map[String, Any]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  71. def getValueOpt[T](row: Row, p: ServiceParam[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  72. def getVectorParam(name: String): String
    Definition Classes
    HasServiceParams
  73. def getVectorParam(p: ServiceParam[_]): String
    Definition Classes
    HasServiceParams
  74. def getVectorParamMap: Map[String, String]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  75. val handler: UDFParam
    Definition Classes
    HasHandler
  76. def handlingFunc(client: CloseableHttpClient, request: HTTPRequestData): HTTPResponseData
    Definition Classes
    HasHandler
  77. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  78. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  79. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  80. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  81. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  83. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  84. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  85. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  86. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  87. def logBase(info: Map[String, String], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  88. def logBase(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  89. def logClass(featureName: String): Unit
    Definition Classes
    SynapseMLLogging
  90. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  92. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  93. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  94. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  95. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  96. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  97. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  98. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  99. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  100. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  101. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  102. def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
    Definition Classes
    SynapseMLLogging
  103. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  104. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  105. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  106. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  107. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  108. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  109. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  110. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  111. val outputCol: Param[String]

    The name of the output column

    The name of the output column

    Definition Classes
    HasOutputCol
  112. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  113. def pyAdditionalMethods: String
    Definition Classes
    HasCustomCogServiceDomain → PythonWrappable
  114. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  115. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  116. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  117. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  118. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  119. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  120. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  121. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  122. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  123. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  124. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  125. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  126. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  127. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  128. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  129. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  130. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  131. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  132. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  133. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  134. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  135. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  136. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  137. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  138. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  139. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  140. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  141. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  142. final def set(paramPair: ParamPair[_]): CognitiveServicesBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  143. final def set(param: String, value: Any): CognitiveServicesBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  144. final def set[T](param: Param[T], value: T): CognitiveServicesBase.this.type
    Definition Classes
    Params
  145. def setAADToken(v: String): CognitiveServicesBase.this.type
    Definition Classes
    HasAADToken
  146. def setAADTokenCol(v: String): CognitiveServicesBase.this.type
    Definition Classes
    HasAADToken
  147. def setConcurrency(value: Int): CognitiveServicesBase.this.type

    Definition Classes
    ConcurrencyParams
  148. def setConcurrentTimeout(value: Option[Double]): CognitiveServicesBase.this.type
    Definition Classes
    ConcurrencyParams
  149. def setConcurrentTimeout(value: Double): CognitiveServicesBase.this.type

    Definition Classes
    ConcurrencyParams
  150. def setCustomServiceName(v: String): CognitiveServicesBase.this.type
    Definition Classes
    HasCustomCogServiceDomain
  151. final def setDefault(paramPairs: ParamPair[_]*): CognitiveServicesBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  152. final def setDefault[T](param: Param[T], value: T): CognitiveServicesBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  153. def setDefaultAADToken(v: String): CognitiveServicesBase.this.type
    Definition Classes
    HasAADToken
  154. def setDefaultInternalEndpoint(v: String): CognitiveServicesBase.this.type
    Definition Classes
    HasCustomCogServiceDomain
  155. def setEndpoint(v: String): CognitiveServicesBase.this.type
    Definition Classes
    HasCustomCogServiceDomain
  156. def setErrorCol(v: String): CognitiveServicesBase.this.type
    Definition Classes
    HasErrorCol
  157. def setHandler(v: UserDefinedFunction): CognitiveServicesBase.this.type
    Definition Classes
    HasHandler
  158. def setHandler(v: HandlerFunc): CognitiveServicesBase.this.type
    Definition Classes
    HasHandler
  159. def setOutputCol(value: String): CognitiveServicesBase.this.type

    Definition Classes
    HasOutputCol
  160. def setScalarParam[T](name: String, value: T): CognitiveServicesBase.this.type
    Definition Classes
    HasServiceParams
  161. def setScalarParam[T](p: ServiceParam[T], value: T): CognitiveServicesBase.this.type
    Definition Classes
    HasServiceParams
  162. def setSubscriptionKey(v: String): CognitiveServicesBase.this.type
    Definition Classes
    HasSubscriptionKey
  163. def setSubscriptionKeyCol(v: String): CognitiveServicesBase.this.type
    Definition Classes
    HasSubscriptionKey
  164. def setTimeout(value: Double): CognitiveServicesBase.this.type

    Definition Classes
    ConcurrencyParams
  165. def setUrl(value: String): CognitiveServicesBase.this.type

    Definition Classes
    HasURL
  166. def setVectorParam(name: String, value: String): CognitiveServicesBase.this.type
    Definition Classes
    HasServiceParams
  167. def setVectorParam[T](p: ServiceParam[T], value: String): CognitiveServicesBase.this.type
    Definition Classes
    HasServiceParams
  168. def shouldSkip(row: Row): Boolean
    Attributes
    protected
    Definition Classes
    HasServiceParams
  169. val subscriptionKey: ServiceParam[String]
    Definition Classes
    HasSubscriptionKey
  170. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  171. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  172. val timeout: Param[Double]
    Definition Classes
    ConcurrencyParams
  173. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  174. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    CognitiveServicesBaseNoHandler → Transformer
  175. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  176. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  177. def transformSchema(schema: StructType): StructType
    Definition Classes
    CognitiveServicesBaseNoHandler → PipelineStage
  178. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  179. val uid: String
    Definition Classes
    CognitiveServicesBaseNoHandler → SynapseMLLogging → Identifiable
  180. val url: Param[String]
    Definition Classes
    HasURL
  181. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  182. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  183. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  184. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasHandler

Inherited from CognitiveServicesBaseNoHandler

Inherited from SynapseMLLogging

Inherited from HasCustomCogServiceDomain

Inherited from HasUrlPath

Inherited from HasAADToken

Inherited from HasErrorCol

Inherited from HasSubscriptionKey

Inherited from HasServiceParams

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from HasURL

Inherited from HasOutputCol

Inherited from ConcurrencyParams

Inherited from Wrappable

Inherited from DotnetWrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

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

getParam

param

setParam

Ungrouped