Class/Object

com.microsoft.ml.spark.cognitive

RecognizeText

Related Docs: object RecognizeText | package cognitive

Permalink

class RecognizeText extends CognitiveServicesBaseWithoutHandler with HasImageInput with HasCognitiveServiceInput with HasInternalJsonOutputParser

Linear Supertypes
Ordering
  1. Alphabetic
  2. 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 contentType: (Row) ⇒ String

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  12. def copy(extra: ParamMap): Transformer

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  25. def getBackoffs: Array[Int]

    Permalink

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

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

    Permalink

    Definition Classes
    HTTPParams
  28. def getConcurrentTimeout: Double

    Permalink

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

    Permalink
    Definition Classes
    Params
  30. def getErrorCol: String

    Permalink
    Definition Classes
    HasErrorCol
  31. def getImageBytes: Array[Byte]

    Permalink
    Definition Classes
    HasImageBytes
  32. def getImageBytesCol: String

    Permalink
    Definition Classes
    HasImageBytes
  33. def getImageUrl: String

    Permalink
    Definition Classes
    HasImageUrl
  34. def getImageUrlCol: String

    Permalink
    Definition Classes
    HasImageUrl
  35. def getInternalInputParser(schema: StructType): HTTPInputParser

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  36. def getInternalOutputParser(schema: StructType): HTTPOutputParser

    Permalink
    Attributes
    protected
    Definition Classes
    HasInternalJsonOutputParser
  37. def getInternalTransformer(schema: StructType): PipelineModel

    Permalink
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseWithoutHandler
  38. def getMaxPollingRetries: Int

    Permalink

  39. def getMode: String

    Permalink
  40. def getModeCol: String

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

    Permalink
    Definition Classes
    Params
  42. def getOutputCol: String

    Permalink

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

    Permalink
    Definition Classes
    Params
  44. def getPollingDelay: Int

    Permalink

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

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

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

    Permalink
    Definition Classes
    HasServiceParams
  48. def getSubscriptionKey: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  49. def getSubscriptionKeyCol: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  50. def getTimeout: Double

    Permalink

    Definition Classes
    HTTPParams
  51. def getUrl: String

    Permalink

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams
  61. def handlingFunc(client: CloseableHttpClient, request: HTTPRequestData): HTTPResponseData

    Permalink
    Attributes
    protected
    Definition Classes
    RecognizeTextCognitiveServicesBaseWithoutHandler
  62. final def hasDefault[T](param: Param[T]): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  65. val imageBytes: ServiceParam[Array[Byte]]

    Permalink
    Definition Classes
    HasImageBytes
  66. val imageUrl: ServiceParam[String]

    Permalink
    Definition Classes
    HasImageUrl
  67. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  69. def inputFunc(schema: StructType): (Row) ⇒ Option[HttpRequestBase]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  86. val maxPollingRetries: IntParam

    Permalink
  87. val mode: ServiceParam[String]

    Permalink
  88. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink

    The name of the output column

    The name of the output column

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

    Permalink
    Definition Classes
    Params
  93. val pollingDelay: IntParam

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasImageInputHasCognitiveServiceInput
  95. def prepareMethod(): HttpRequestBase

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  96. def prepareUrl: (Row) ⇒ String

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  97. def responseDataType: DataType

    Permalink
    Attributes
    protected
    Definition Classes
    RecognizeTextHasInternalJsonOutputParser
  98. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  102. def setBackoffs(value: Array[Int]): RecognizeText.this.type

    Permalink

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

    Permalink

    Definition Classes
    HTTPParams
  104. def setConcurrentTimeout(value: Double): RecognizeText.this.type

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    HasServiceParams
  109. def setErrorCol(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasErrorCol
  110. def setImageBytes(v: Array[Byte]): RecognizeText.this.type

    Permalink
    Definition Classes
    HasImageBytes
  111. def setImageBytesCol(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasImageBytes
  112. def setImageUrl(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasImageUrl
  113. def setImageUrlCol(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasImageUrl
  114. def setLocation(v: String): RecognizeText.this.type

    Permalink
  115. def setMaxPollingRetries(value: Int): RecognizeText.this.type

    Permalink

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

    Permalink
  117. def setModeCol(v: String): RecognizeText.this.type

    Permalink
  118. def setOutputCol(value: String): RecognizeText.this.type

    Permalink

    Definition Classes
    HasOutputCol
  119. def setPollingDelay(value: Int): RecognizeText.this.type

    Permalink

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

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

    Permalink
    Definition Classes
    HasServiceParams
  122. def setSubscriptionKey(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasSubscriptionKey
  123. def setSubscriptionKeyCol(v: String): RecognizeText.this.type

    Permalink
    Definition Classes
    HasSubscriptionKey
  124. def setTimeout(value: Double): RecognizeText.this.type

    Permalink

    Definition Classes
    HTTPParams
  125. def setUrl(value: String): RecognizeText.this.type

    Permalink

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasImageInputHasServiceParams
  129. val subscriptionKey: ServiceParam[String]

    Permalink
    Definition Classes
    HasSubscriptionKey
  130. val subscriptionKeyHeaderName: String

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  131. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    RecognizeTextCognitiveServicesBaseWithoutHandler → Identifiable
  140. val url: Param[String]

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

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

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

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

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasImageInput

Inherited from HasCognitiveServiceInput

Inherited from HasImageBytes

Inherited from HasImageUrl

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