Class/Object

com.microsoft.ml.spark.cognitive

OCR

Related Docs: object OCR | package cognitive

Permalink

class OCR extends CognitiveServicesBase with HasLanguage with HasImageInput with HasDetectOrientation with HasCognitiveServiceInput with HasInternalJsonOutputParser

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OCR
  2. HasInternalJsonOutputParser
  3. HasDetectOrientation
  4. HasImageInput
  5. HasCognitiveServiceInput
  6. HasImageBytes
  7. HasImageUrl
  8. HasLanguage
  9. CognitiveServicesBase
  10. HasHandler
  11. CognitiveServicesBaseWithoutHandler
  12. HasErrorCol
  13. HasSubscriptionKey
  14. HasServiceParams
  15. ComplexParamsWritable
  16. MLWritable
  17. HasURL
  18. HasOutputCol
  19. HTTPParams
  20. Wrappable
  21. Transformer
  22. PipelineStage
  23. Logging
  24. Params
  25. Serializable
  26. Serializable
  27. Identifiable
  28. AnyRef
  29. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OCR()

    Permalink
  2. new OCR(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. final def clear(param: Param[_]): OCR.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 contentType: (Row) ⇒ String

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  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. val detectOrientation: ServiceParam[Boolean]

    Permalink
    Definition Classes
    HasDetectOrientation
  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. 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 getDetectOrientation: Boolean

    Permalink
    Definition Classes
    HasDetectOrientation
  30. def getDetectOrientationCol: String

    Permalink
    Definition Classes
    HasDetectOrientation
  31. def getErrorCol: String

    Permalink
    Definition Classes
    HasErrorCol
  32. def getHandler: HandlerFunc

    Permalink

    Definition Classes
    HasHandler
  33. def getImageBytes: Array[Byte]

    Permalink
    Definition Classes
    HasImageBytes
  34. def getImageBytesCol: String

    Permalink
    Definition Classes
    HasImageBytes
  35. def getImageUrl: String

    Permalink
    Definition Classes
    HasImageUrl
  36. def getImageUrlCol: String

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseWithoutHandler
  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. val handler: UDFParam

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  73. val language: ServiceParam[String]

    Permalink
    Definition Classes
    HasLanguage
  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. 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
    HasImageInputHasCognitiveServiceInput
  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
    Definition Classes
    OCRHasInternalJsonOutputParser
  95. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  99. def setConcurrency(value: Int): OCR.this.type

    Permalink

    Definition Classes
    HTTPParams
  100. def setConcurrentTimeout(value: Double): OCR.this.type

    Permalink

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  103. def setDefaultLanguage(v: String): OCR.this.type

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

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

    Permalink
    Definition Classes
    HasServiceParams
  106. def setDetectOrientation(v: Boolean): OCR.this.type

    Permalink
    Definition Classes
    HasDetectOrientation
  107. def setDetectOrientationCol(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasDetectOrientation
  108. def setErrorCol(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasErrorCol
  109. def setHandler(v: HandlerFunc): OCR.this.type

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

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

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

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

    Permalink
    Definition Classes
    HasImageUrl
  114. def setLanguage(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasLanguage
  115. def setLanguageCol(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasLanguage
  116. def setLocation(v: String): OCR.this.type

    Permalink
  117. def setOutputCol(value: String): OCR.this.type

    Permalink

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

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

    Permalink
    Definition Classes
    HasServiceParams
  120. def setSubscriptionKey(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasSubscriptionKey
  121. def setSubscriptionKeyCol(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasSubscriptionKey
  122. def setTimeout(value: Double): OCR.this.type

    Permalink

    Definition Classes
    HTTPParams
  123. def setUrl(value: String): OCR.this.type

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    HasSubscriptionKey
  128. val subscriptionKeyHeaderName: String

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    OCRCognitiveServicesBaseWithoutHandler → Identifiable
  138. val url: Param[String]

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

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

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

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

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasDetectOrientation

Inherited from HasImageInput

Inherited from HasCognitiveServiceInput

Inherited from HasImageBytes

Inherited from HasImageUrl

Inherited from HasLanguage

Inherited from CognitiveServicesBase

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