CognitiveServicesBase

abstract class CognitiveServicesBase extends CognitiveServicesBaseNoHandler with HasHandler

Linear Supertypes

HasHandler, CognitiveServicesBaseNoHandler, SynapseMLLogging, HasCustomCogServiceDomain, HasUrlPath, HasAADToken, HasErrorCol, HasSubscriptionKey, HasServiceParams, ComplexParamsWritable, MLWritable, HasURL, HasOutputCol, ConcurrencyParams, Wrappable, DotnetWrappable, RWrappable, PythonWrappable, BaseWrappable, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

CognitiveServicesBase
HasHandler
CognitiveServicesBaseNoHandler
SynapseMLLogging
HasCustomCogServiceDomain
HasUrlPath
HasAADToken
HasErrorCol
HasSubscriptionKey
HasServiceParams
ComplexParamsWritable
MLWritable
HasURL
HasOutputCol
ConcurrencyParams
Wrappable
DotnetWrappable
RWrappable
PythonWrappable
BaseWrappable
Transformer
PipelineStage
Logging
Params
Serializable
Serializable
Identifiable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new CognitiveServicesBase(uid: String)

Abstract Value Members

abstract def getInternalInputParser(schema: StructType): HTTPInputParser

Attributes
protected
Definition Classes
CognitiveServicesBaseNoHandler
abstract def getInternalOutputParser(schema: StructType): HTTPOutputParser

Attributes
protected
Definition Classes
CognitiveServicesBaseNoHandler
abstract def urlPath: String

Definition Classes
HasUrlPath

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T

Attributes
protected
Definition Classes
Params
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val AADToken: ServiceParam[String]

Definition Classes
HasAADToken
final def asInstanceOf[T0]: T0

Definition Classes
Any
lazy val classNameHelper: String

Attributes
protected
Definition Classes
BaseWrappable
final def clear(param: Param[_]): CognitiveServicesBase.this.type

Definition Classes
Params
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def companionModelClassName: String

Attributes
protected
Definition Classes
BaseWrappable
val concurrency: Param[Int]

Definition Classes
ConcurrencyParams
val concurrentTimeout: Param[Double]

Definition Classes
ConcurrencyParams
def copy(extra: ParamMap): Transformer

Definition Classes
CognitiveServicesBaseNoHandler → Transformer → PipelineStage → Params
def copyValues[T <: Params](to: T, extra: ParamMap): T

Attributes
protected
Definition Classes
Params
lazy val copyrightLines: String

Attributes
protected
Definition Classes
BaseWrappable
final def defaultCopy[T <: Params](extra: ParamMap): T

Attributes
protected
Definition Classes
Params
def dotnetAdditionalMethods: String

Definition Classes
HasCustomCogServiceDomain → DotnetWrappable
def dotnetClass(): String

Attributes
protected
Definition Classes
DotnetWrappable
lazy val dotnetClassName: String

Attributes
protected
Definition Classes
DotnetWrappable
lazy val dotnetClassNameString: String

Attributes
protected
Definition Classes
DotnetWrappable
lazy val dotnetClassWrapperName: String

Attributes
protected
Definition Classes
DotnetWrappable
lazy val dotnetCopyrightLines: String

Attributes
protected
Definition Classes
DotnetWrappable
def dotnetExtraEstimatorImports: String

Attributes
protected
Definition Classes
DotnetWrappable
def dotnetExtraMethods: String

Attributes
protected
Definition Classes
DotnetWrappable
lazy val dotnetInternalWrapper: Boolean

Attributes
protected
Definition Classes
DotnetWrappable
def dotnetMLReadWriteMethods: String

Attributes
protected
Definition Classes
DotnetWrappable
lazy val dotnetNamespace: String

Attributes
protected
Definition Classes
DotnetWrappable
lazy val dotnetObjectBaseClass: String

Attributes
protected
Definition Classes
DotnetWrappable
def dotnetParamGetter(p: Param[_]): String

Attributes
protected
Definition Classes
DotnetWrappable
def dotnetParamGetters: String

Attributes
protected
Definition Classes
DotnetWrappable
def dotnetParamSetter(p: Param[_]): String

Attributes
protected
Definition Classes
DotnetWrappable
def dotnetParamSetters: String

Attributes
protected
Definition Classes
DotnetWrappable
def dotnetWrapAsTypeMethod: String

Attributes
protected
Definition Classes
DotnetWrappable
def emptyParamData[T](row: Row, p: ServiceParam[T]): Boolean

Attributes
protected
Definition Classes
HasServiceParams
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val errorCol: Param[String]

Definition Classes
HasErrorCol
def explainParam(param: Param[_]): String

Definition Classes
Params
def explainParams(): String

Definition Classes
Params
final def extractParamMap(): ParamMap

Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap

Definition Classes
Params
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def get[T](param: Param[T]): Option[T]

Definition Classes
Params
def getAADToken: String

Definition Classes
HasAADToken
def getAADTokenCol: String

Definition Classes
HasAADToken
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def getConcurrency: Int

Definition Classes
ConcurrencyParams
def getConcurrentTimeout: Double

Definition Classes
ConcurrencyParams
final def getDefault[T](param: Param[T]): Option[T]

Definition Classes
Params
def getErrorCol: String

Definition Classes
HasErrorCol
def getHandler: HandlerFunc

Definition Classes
HasHandler
def getInternalServiceType: String

Definition Classes
HasCustomCogServiceDomain
def getInternalTransformer(schema: StructType): PipelineModel

Attributes
protected
Definition Classes
CognitiveServicesBaseNoHandler
final def getOrDefault[T](param: Param[T]): T

Definition Classes
Params
def getOutputCol: String

Definition Classes
HasOutputCol
def getParam(paramName: String): Param[Any]

Definition Classes
Params
def getParamInfo(p: Param[_]): ParamInfo[_]

Definition Classes
BaseWrappable
def getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]

Attributes
protected
Definition Classes
SynapseMLLogging
def getRequiredParams: Array[ServiceParam[_]]

Attributes
protected
Definition Classes
HasServiceParams
def getScalarParam[T](name: String): T

Definition Classes
HasServiceParams
def getScalarParam[T](p: ServiceParam[T]): T

Definition Classes
HasServiceParams
def getSubscriptionKey: String

Definition Classes
HasSubscriptionKey
def getSubscriptionKeyCol: String

Definition Classes
HasSubscriptionKey
def getTimeout: Double

Definition Classes
ConcurrencyParams
def getUrl: String

Definition Classes
HasCustomCogServiceDomain → HasURL
def getUrlParams: Array[ServiceParam[_]]

Attributes
protected
Definition Classes
HasServiceParams
def getValue[T](row: Row, p: ServiceParam[T]): T

Attributes
protected
Definition Classes
HasServiceParams
def getValueAny(row: Row, p: ServiceParam[_]): Any

Attributes
protected
Definition Classes
HasServiceParams
def getValueAnyOpt(row: Row, p: ServiceParam[_]): Option[Any]

Attributes
protected
Definition Classes
HasServiceParams
def getValueMap(row: Row, excludes: Set[ServiceParam[_]] = Set()): Map[String, Any]

Attributes
protected
Definition Classes
HasServiceParams
def getValueOpt[T](row: Row, p: ServiceParam[T]): Option[T]

Attributes
protected
Definition Classes
HasServiceParams
def getVectorParam(name: String): String

Definition Classes
HasServiceParams
def getVectorParam(p: ServiceParam[_]): String

Definition Classes
HasServiceParams
def getVectorParamMap: Map[String, String]

Attributes
protected
Definition Classes
HasServiceParams
val handler: UDFParam

Definition Classes
HasHandler
def handlingFunc(client: CloseableHttpClient, request: HTTPRequestData): HTTPResponseData

Definition Classes
HasHandler
final def hasDefault[T](param: Param[T]): Boolean

Definition Classes
Params
def hasParam(paramName: String): Boolean

Definition Classes
Params
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

Attributes
protected
Definition Classes
Logging
def initializeLogIfNecessary(isInterpreter: Boolean): Unit

Attributes
protected
Definition Classes
Logging
final def isDefined(param: Param[_]): Boolean

Definition Classes
Params
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def isSet(param: Param[_]): Boolean

Definition Classes
Params
def isTraceEnabled(): Boolean

Attributes
protected
Definition Classes
Logging
def log: Logger

Attributes
protected
Definition Classes
Logging
def logBase(info: Map[String, String], featureName: Option[String]): Unit

Attributes
protected
Definition Classes
SynapseMLLogging
def logBase(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], featureName: Option[String]): Unit

Attributes
protected
Definition Classes
SynapseMLLogging
def logClass(featureName: String): Unit

Definition Classes
SynapseMLLogging
def logDebug(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logDebug(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logError(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logErrorBase(methodName: String, e: Exception): Unit

Attributes
protected
Definition Classes
SynapseMLLogging
def logFit[T](f: ⇒ T, columns: Int): T

Definition Classes
SynapseMLLogging
def logInfo(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logInfo(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logName: String

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logTrace(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def logTransform[T](f: ⇒ T, columns: Int): T

Definition Classes
SynapseMLLogging
def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T

Definition Classes
SynapseMLLogging
def logWarning(msg: ⇒ String, throwable: Throwable): Unit

Attributes
protected
Definition Classes
Logging
def logWarning(msg: ⇒ String): Unit

Attributes
protected
Definition Classes
Logging
def makeDotnetFile(conf: CodegenConfig): Unit

Definition Classes
DotnetWrappable
def makePyFile(conf: CodegenConfig): Unit

Definition Classes
PythonWrappable
def makeRFile(conf: CodegenConfig): Unit

Definition Classes
RWrappable
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
val outputCol: Param[String]
The name of the output column
The name of the output column

Definition Classes
HasOutputCol
lazy val params: Array[Param[_]]

Definition Classes
Params
def pyAdditionalMethods: String

Definition Classes
HasCustomCogServiceDomain → PythonWrappable
lazy val pyClassDoc: String

Attributes
protected
Definition Classes
PythonWrappable
lazy val pyClassName: String

Attributes
protected
Definition Classes
PythonWrappable
def pyExtraEstimatorImports: String

Attributes
protected
Definition Classes
PythonWrappable
def pyExtraEstimatorMethods: String

Attributes
protected
Definition Classes
PythonWrappable
lazy val pyInheritedClasses: Seq[String]

Attributes
protected
Definition Classes
PythonWrappable
def pyInitFunc(): String

Definition Classes
PythonWrappable
lazy val pyInternalWrapper: Boolean

Attributes
protected
Definition Classes
PythonWrappable
lazy val pyObjectBaseClass: String

Attributes
protected
Definition Classes
PythonWrappable
def pyParamArg[T](p: Param[T]): String

Attributes
protected
Definition Classes
PythonWrappable
def pyParamDefault[T](p: Param[T]): Option[String]

Attributes
protected
Definition Classes
PythonWrappable
def pyParamGetter(p: Param[_]): String

Attributes
protected
Definition Classes
PythonWrappable
def pyParamSetter(p: Param[_]): String

Attributes
protected
Definition Classes
PythonWrappable
def pyParamsArgs: String

Attributes
protected
Definition Classes
PythonWrappable
def pyParamsDefaults: String

Attributes
protected
Definition Classes
PythonWrappable
lazy val pyParamsDefinitions: String

Attributes
protected
Definition Classes
PythonWrappable
def pyParamsGetters: String

Attributes
protected
Definition Classes
PythonWrappable
def pyParamsSetters: String

Attributes
protected
Definition Classes
PythonWrappable
def pythonClass(): String

Attributes
protected
Definition Classes
PythonWrappable
def rClass(): String

Attributes
protected
Definition Classes
RWrappable
def rDocString: String

Attributes
protected
Definition Classes
RWrappable
def rExtraBodyLines: String

Attributes
protected
Definition Classes
RWrappable
def rExtraInitLines: String

Attributes
protected
Definition Classes
RWrappable
lazy val rFuncName: String

Attributes
protected
Definition Classes
RWrappable
lazy val rInternalWrapper: Boolean

Attributes
protected
Definition Classes
RWrappable
def rParamArg[T](p: Param[T]): String

Attributes
protected
Definition Classes
RWrappable
def rParamsArgs: String

Attributes
protected
Definition Classes
RWrappable
def rSetterLines: String

Attributes
protected
Definition Classes
RWrappable
def save(path: String): Unit

Definition Classes
MLWritable
Annotations
@Since( "1.6.0" ) @throws( ... )
final def set(paramPair: ParamPair[_]): CognitiveServicesBase.this.type

Attributes
protected
Definition Classes
Params
final def set(param: String, value: Any): CognitiveServicesBase.this.type

Attributes
protected
Definition Classes
Params
final def set[T](param: Param[T], value: T): CognitiveServicesBase.this.type

Definition Classes
Params
def setAADToken(v: String): CognitiveServicesBase.this.type

Definition Classes
HasAADToken
def setAADTokenCol(v: String): CognitiveServicesBase.this.type

Definition Classes
HasAADToken
def setConcurrency(value: Int): CognitiveServicesBase.this.type

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

Definition Classes
ConcurrencyParams
def setConcurrentTimeout(value: Double): CognitiveServicesBase.this.type

Definition Classes
ConcurrencyParams
def setCustomServiceName(v: String): CognitiveServicesBase.this.type

Definition Classes
HasCustomCogServiceDomain
final def setDefault(paramPairs: ParamPair[_]*): CognitiveServicesBase.this.type

Attributes
protected
Definition Classes
Params
final def setDefault[T](param: Param[T], value: T): CognitiveServicesBase.this.type

Attributes
protected[org.apache.spark.ml]
Definition Classes
Params
def setDefaultAADToken(v: String): CognitiveServicesBase.this.type

Definition Classes
HasAADToken
def setDefaultInternalEndpoint(v: String): CognitiveServicesBase.this.type

Definition Classes
HasCustomCogServiceDomain
def setEndpoint(v: String): CognitiveServicesBase.this.type

Definition Classes
HasCustomCogServiceDomain
def setErrorCol(v: String): CognitiveServicesBase.this.type

Definition Classes
HasErrorCol
def setHandler(v: UserDefinedFunction): CognitiveServicesBase.this.type

Definition Classes
HasHandler
def setHandler(v: HandlerFunc): CognitiveServicesBase.this.type

Definition Classes
HasHandler
def setOutputCol(value: String): CognitiveServicesBase.this.type

Definition Classes
HasOutputCol
def setScalarParam[T](name: String, value: T): CognitiveServicesBase.this.type

Definition Classes
HasServiceParams
def setScalarParam[T](p: ServiceParam[T], value: T): CognitiveServicesBase.this.type

Definition Classes
HasServiceParams
def setSubscriptionKey(v: String): CognitiveServicesBase.this.type

Definition Classes
HasSubscriptionKey
def setSubscriptionKeyCol(v: String): CognitiveServicesBase.this.type

Definition Classes
HasSubscriptionKey
def setTimeout(value: Double): CognitiveServicesBase.this.type

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

Definition Classes
HasURL
def setVectorParam(name: String, value: String): CognitiveServicesBase.this.type

Definition Classes
HasServiceParams
def setVectorParam[T](p: ServiceParam[T], value: String): CognitiveServicesBase.this.type

Definition Classes
HasServiceParams
def shouldSkip(row: Row): Boolean

Attributes
protected
Definition Classes
HasServiceParams
val subscriptionKey: ServiceParam[String]

Definition Classes
HasSubscriptionKey
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val thisStage: Params

Attributes
protected
Definition Classes
BaseWrappable
val timeout: Param[Double]

Definition Classes
ConcurrencyParams
def toString(): String

Definition Classes
Identifiable → AnyRef → Any
def transform(dataset: Dataset[_]): DataFrame

Definition Classes
CognitiveServicesBaseNoHandler → Transformer
def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

Definition Classes
Transformer
Annotations
@Since( "2.0.0" )
def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

Definition Classes
Transformer
Annotations
@Since( "2.0.0" ) @varargs()
def transformSchema(schema: StructType): StructType

Definition Classes
CognitiveServicesBaseNoHandler → PipelineStage
def transformSchema(schema: StructType, logging: Boolean): StructType

Attributes
protected
Definition Classes
PipelineStage
Annotations
@DeveloperApi()
val uid: String

Definition Classes
CognitiveServicesBaseNoHandler → SynapseMLLogging → Identifiable
val url: Param[String]

Definition Classes
HasURL
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def write: MLWriter

Definition Classes
ComplexParamsWritable → MLWritable

Packages

CognitiveServicesBase

abstract class CognitiveServicesBase extends CognitiveServicesBaseNoHandler with HasHandler

Instance Constructors

Abstract Value Members

Concrete Value Members

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

Packages

CognitiveServicesBase 

abstract class CognitiveServicesBase extends CognitiveServicesBaseNoHandler with HasHandler

Instance Constructors

Abstract Value Members

Concrete Value Members

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

CognitiveServicesBase