Class/Object

com.microsoft.ml.spark

RecognizeText

Related Docs: object RecognizeText | package spark

Permalink

class RecognizeText extends CognitiveServicesBaseWithoutHandler with HasImageInput with HasCognitiveServiceInput with HasInternalJsonOutputParser

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

Instance Constructors

  1. new RecognizeText()

    Permalink

  2. new RecognizeText(uid: String)

    Permalink

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. val backoffs: IntArrayParam

    Permalink

  7. final def clear(param: Param[_]): RecognizeText.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. def getBackoffs: Array[Int]

    Permalink

  25. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  26. def getConcurrency: Int

    Permalink

    Definition Classes
    HTTPParams

  27. def getConcurrentTimeout: Double

    Permalink

    Definition Classes
    HTTPParams

  28. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  29. def getErrorCol: String

    Permalink
    Definition Classes
    HasErrorCol

  30. def getImageBytes: Array[Byte]

    Permalink
    Definition Classes
    HasImageBytes

  31. def getImageBytesCol: String

    Permalink
    Definition Classes
    HasImageBytes

  32. def getImageUrl: String

    Permalink
    Definition Classes
    HasImageUrl

  33. def getImageUrlCol: String

    Permalink
    Definition Classes
    HasImageUrl

  34. def getInternalInputParser(schema: StructType): HTTPInputParser

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput

  35. def getInternalOutputParser(schema: StructType): HTTPOutputParser

    Permalink
    Attributes
    protected
    Definition Classes
    HasInternalJsonOutputParser

  36. def getInternalTransformer(schema: StructType): PipelineModel

    Permalink
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseWithoutHandler

  37. def getMaxPollingRetries: Int

    Permalink

  38. def getMode: String

    Permalink

  39. def getModeCol: String

    Permalink

  40. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params

  41. def getOutputCol: String

    Permalink

    Definition Classes
    HasOutputCol

  42. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params

  43. def getRequiredParams: Array[ServiceParam[_]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

  44. def getScalarParam[T](name: String): T

    Permalink
    Definition Classes
    HasServiceParams

  45. def getScalarParam[T](p: ServiceParam[T]): T

    Permalink
    Definition Classes
    HasServiceParams

  46. def getSubscriptionKey: String

    Permalink
    Definition Classes
    HasSubscriptionKey

  47. def getSubscriptionKeyCol: String

    Permalink
    Definition Classes
    HasSubscriptionKey

  48. def getTimeout: Double

    Permalink

    Definition Classes
    HTTPParams

  49. def getUrl: String

    Permalink

    Definition Classes
    HasURL

  50. def getUrlParams: Array[ServiceParam[_]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

  51. def getValue[T](row: Row, p: ServiceParam[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

  52. def getValueAny(row: Row, p: ServiceParam[_]): Any

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

  53. def getValueAnyOpt(row: Row, p: ServiceParam[_]): Option[Any]

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

  54. def getValueMap(row: Row, excludes: Set[ServiceParam[_]] = Set()): Map[String, Any]

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

  55. def getValueOpt[T](row: Row, p: ServiceParam[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

  56. def getVectorParam(name: String): String

    Permalink
    Definition Classes
    HasServiceParams

  57. def getVectorParam(p: ServiceParam[_]): String

    Permalink
    Definition Classes
    HasServiceParams

  58. def getVectorParamMap: Map[String, String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

  59. def handlingFunc(client: CloseableHttpClient, request: HTTPRequestData): HTTPResponseData

    Permalink
    Attributes
    protected
    Definition Classes
    RecognizeText → CognitiveServicesBaseWithoutHandler

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

    Permalink
    Definition Classes
    Params

  61. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  62. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  63. val imageBytes: ServiceParam[Array[Byte]]

    Permalink
    Definition Classes
    HasImageBytes

  64. val imageUrl: ServiceParam[String]

    Permalink
    Definition Classes
    HasImageUrl

  65. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  66. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  67. def inputFunc(schema: StructType): (Row) ⇒ Option[HttpRequestBase]

    Permalink
    Attributes
    protected
    Definition Classes
    HasImageInput → HasCognitiveServiceInput

  68. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  69. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  70. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  71. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  72. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  73. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  74. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  75. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  76. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  77. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  78. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  79. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  80. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  81. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  82. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  83. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  84. val maxPollingRetries: IntParam

    Permalink

  85. val mode: ServiceParam[String]

    Permalink

  86. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  87. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  88. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  89. val outputCol: Param[String]

    Permalink

    The name of the output column

    The name of the output column

    Definition Classes
    HasOutputCol

  90. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  91. def prepareEntity: (Row) ⇒ Option[AbstractHttpEntity]

    Permalink
    Attributes
    protected
    Definition Classes
    HasImageInput → HasCognitiveServiceInput

  92. def prepareMethod(): HttpRequestBase

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput

  93. def prepareUrl: (Row) ⇒ String

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput

  94. def responseDataType: DataType

    Permalink
    Attributes
    protected
    Definition Classes
    RecognizeText → HasInternalJsonOutputParser

  95. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )

  96. final def set(paramPair: ParamPair[_]): RecognizeText.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  97. final def set(param: String, value: Any): RecognizeText.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  98. final def set[T](param: Param[T], value: T): RecognizeText.this.type

    Permalink
    Definition Classes
    Params

  99. def setBackoffs(value: Array[Int]): RecognizeText.this.type

    Permalink

  100. def setConcurrency(value: Int): RecognizeText.this.type

    Permalink

    Definition Classes
    HTTPParams

  101. def setConcurrentTimeout(value: Double): RecognizeText.this.type

    Permalink

    Definition Classes
    HTTPParams

  102. final def setDefault(paramPairs: ParamPair[_]*): RecognizeText.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  103. final def setDefault[T](param: Param[T], value: T): RecognizeText.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  104. def setDefaultValue[T](p: ServiceParam[T], value: Option[T]): RecognizeText.this.type

    Permalink
    Definition Classes
    HasServiceParams

  105. def setDefaultValue[T](p: ServiceParam[T], value: T): RecognizeText.this.type

    Permalink
    Definition Classes
    HasServiceParams

  106. def setErrorCol(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasErrorCol

  107. def setImageBytes(v: Array[Byte]): RecognizeText.this.type

    Permalink
    Definition Classes
    HasImageBytes

  108. def setImageBytesCol(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasImageBytes

  109. def setImageUrl(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasImageUrl

  110. def setImageUrlCol(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasImageUrl

  111. def setLocation(v: String): RecognizeText.this.type

    Permalink

  112. def setMaxPollingRetries(value: Int): RecognizeText.this.type

    Permalink

  113. def setMode(v: String): RecognizeText.this.type

    Permalink

  114. def setModeCol(v: String): RecognizeText.this.type

    Permalink

  115. def setOutputCol(value: String): RecognizeText.this.type

    Permalink

    Definition Classes
    HasOutputCol

  116. def setScalarParam[T](name: String, value: T): RecognizeText.this.type

    Permalink
    Definition Classes
    HasServiceParams

  117. def setScalarParam[T](p: ServiceParam[T], value: T): RecognizeText.this.type

    Permalink
    Definition Classes
    HasServiceParams

  118. def setSubscriptionKey(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasSubscriptionKey

  119. def setSubscriptionKeyCol(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasSubscriptionKey

  120. def setTimeout(value: Double): RecognizeText.this.type

    Permalink

    Definition Classes
    HTTPParams

  121. def setUrl(value: String): RecognizeText.this.type

    Permalink

    Definition Classes
    HasURL

  122. def setVectorParam(name: String, value: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasServiceParams

  123. def setVectorParam[T](p: ServiceParam[T], value: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasServiceParams

  124. def shouldSkip(row: Row): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasImageInput → HasServiceParams

  125. val subscriptionKey: ServiceParam[String]

    Permalink
    Definition Classes
    HasSubscriptionKey

  126. val subscriptionKeyHeaderName: String

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput

  127. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  128. val timeout: Param[Double]

    Permalink
    Definition Classes
    HTTPParams

  129. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  130. def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    CognitiveServicesBaseWithoutHandler → Transformer

  131. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )

  132. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()

  133. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    CognitiveServicesBaseWithoutHandler → PipelineStage

  134. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  135. val uid: String

    Permalink
    Definition Classes
    RecognizeText → CognitiveServicesBaseWithoutHandler → Identifiable

  136. val url: Param[String]

    Permalink
    Definition Classes
    HasURL

  137. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  138. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  139. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  140. def write: MLWriter

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasInternalJsonOutputParser

Inherited from HasImageInput

Inherited from HasCognitiveServiceInput

Inherited from HasImageBytes

Inherited from HasImageUrl

Inherited from CognitiveServicesBaseWithoutHandler

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