Class

com.microsoft.ml.spark

CognitiveServicesBase

Related Doc: package spark

Permalink

abstract class CognitiveServicesBase extends CognitiveServicesBaseWithoutHandler with HasHandler

Linear Supertypes
HasHandler, CognitiveServicesBaseWithoutHandler, HasErrorCol, HasSubscriptionKey, HasServiceParams, ComplexParamsWritable, MLWritable, HasURL, HasOutputCol, HTTPParams, Wrappable, Transformer, PipelineStage, org.apache.spark.internal.Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. CognitiveServicesBase
  2. HasHandler
  3. CognitiveServicesBaseWithoutHandler
  4. HasErrorCol
  5. HasSubscriptionKey
  6. HasServiceParams
  7. ComplexParamsWritable
  8. MLWritable
  9. HasURL
  10. HasOutputCol
  11. HTTPParams
  12. Wrappable
  13. Transformer
  14. PipelineStage
  15. Logging
  16. Params
  17. Serializable
  18. Serializable
  19. Identifiable
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CognitiveServicesBase(uid: String)

    Permalink

Abstract Value Members

  1. abstract def getInternalInputParser(schema: StructType): HTTPInputParser

    Permalink
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseWithoutHandler
  2. abstract def getInternalOutputParser(schema: StructType): HTTPOutputParser

    Permalink
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseWithoutHandler

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. final def clear(param: Param[_]): CognitiveServicesBase.this.type

    Permalink
    Definition Classes
    Params
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val concurrency: Param[Int]

    Permalink
    Definition Classes
    HTTPParams
  9. val concurrentTimeout: Param[Double]

    Permalink
    Definition Classes
    HTTPParams
  10. def copy(extra: ParamMap): Transformer

    Permalink
    Definition Classes
    CognitiveServicesBaseWithoutHandler → Transformer → PipelineStage → Params
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    Params
  17. def explainParams(): String

    Permalink
    Definition Classes
    Params
  18. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  19. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  20. def finalize(): Unit

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

    Permalink
    Definition Classes
    Params
  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  23. def getConcurrency: Int

    Permalink

    Definition Classes
    HTTPParams
  24. def getConcurrentTimeout: Double

    Permalink

    Definition Classes
    HTTPParams
  25. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  26. def getErrorCol: String

    Permalink
    Definition Classes
    HasErrorCol
  27. def getHandler: HandlerFunc

    Permalink

    Definition Classes
    HasHandler
  28. def getInternalTransformer(schema: StructType): PipelineModel

    Permalink
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseWithoutHandler
  29. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  30. def getOutputCol: String

    Permalink

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

    Permalink
    Definition Classes
    Params
  32. def getRequiredParams: Array[ServiceParam[_]]

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

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

    Permalink
    Definition Classes
    HasServiceParams
  35. def getSubscriptionKey: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  36. def getSubscriptionKeyCol: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  37. def getUrl: String

    Permalink

    Definition Classes
    HasURL
  38. def getUrlParams: Array[ServiceParam[_]]

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasServiceParams
  46. def getVectorParamMap: Map[String, String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams
  47. val handler: UDFParam

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

    Permalink
  49. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  50. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  51. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  52. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

    Permalink
    Definition Classes
    Params
  55. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    Params
  57. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  65. def logName: String

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  71. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  72. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  73. val outputCol: Param[String]

    Permalink

    The name of the output column

    The name of the output column

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

    Permalink
    Definition Classes
    Params
  75. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  79. def setConcurrency(value: Int): CognitiveServicesBase.this.type

    Permalink

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

    Permalink

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  83. def setDefaultValue[T](p: ServiceParam[T], value: Option[T]): CognitiveServicesBase.this.type

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

    Permalink
    Definition Classes
    HasServiceParams
  85. def setErrorCol(v: String): CognitiveServicesBase.this.type

    Permalink
    Definition Classes
    HasErrorCol
  86. def setHandler(v: HandlerFunc): CognitiveServicesBase.this.type

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

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    HasSubscriptionKey
  92. def setUrl(value: String): CognitiveServicesBase.this.type

    Permalink

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

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

    Permalink
    Definition Classes
    HasServiceParams
  95. def shouldSkip(row: Row): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  98. def toString(): String

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

    Permalink
    Definition Classes
    CognitiveServicesBaseWithoutHandler → Transformer
  100. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

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

    Permalink
    Definition Classes
    CognitiveServicesBaseWithoutHandler → PipelineStage
  103. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    CognitiveServicesBaseWithoutHandler → Identifiable
  105. val url: Param[String]

    Permalink
    Definition Classes
    HasURL
  106. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasHandler

Inherited from HasErrorCol

Inherited from HasSubscriptionKey

Inherited from HasServiceParams

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from HasURL

Inherited from HasOutputCol

Inherited from HTTPParams

Inherited from Wrappable

Inherited from Transformer

Inherited from PipelineStage

Inherited from org.apache.spark.internal.Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters

Parameter setters

Parameter getters

Members