Class

com.microsoft.ml.spark.cognitive

CognitiveServicesBase

Related Doc: package cognitive

Permalink

abstract class CognitiveServicesBase extends CognitiveServicesBaseWithoutHandler with HasHandler

Linear Supertypes
HasHandler, CognitiveServicesBaseWithoutHandler, HasErrorCol, HasSubscriptionKey, HasServiceParams, ComplexParamsWritable, MLWritable, HasURL, HasOutputCol, HTTPParams, Wrappable, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. 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. def additionalPythonMethods(): String

    Permalink
    Definition Classes
    Wrappable
  6. final def asInstanceOf[T0]: T0

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  14. def emptyParamData[T](row: Row, p: ServiceParam[T]): Boolean

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Definition Classes
    HTTPParams
  26. def getConcurrentTimeout: Double

    Permalink

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

    Permalink
    Definition Classes
    Params
  28. def getErrorCol: String

    Permalink
    Definition Classes
    HasErrorCol
  29. def getHandler: HandlerFunc

    Permalink

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

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

    Permalink
    Definition Classes
    Params
  32. def getOutputCol: String

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    HasServiceParams
  37. def getSubscriptionKey: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  38. def getSubscriptionKeyCol: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  39. def getTimeout: Double

    Permalink

    Definition Classes
    HTTPParams
  40. def getUrl: String

    Permalink

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    The name of the output column

    The name of the output column

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

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

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

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

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

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

    Permalink

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

    Permalink

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

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

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

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

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

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

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

    Permalink

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

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

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

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

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

    Permalink

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

    Permalink

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  102. val timeout: Param[Double]

    Permalink
    Definition Classes
    HTTPParams
  103. def toString(): String

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  114. 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 Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped