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 with HasSetLocation

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OCR
  2. HasSetLocation
  3. HasInternalJsonOutputParser
  4. HasDetectOrientation
  5. HasImageInput
  6. HasCognitiveServiceInput
  7. HasImageBytes
  8. HasImageUrl
  9. HasLanguage
  10. CognitiveServicesBase
  11. HasHandler
  12. CognitiveServicesBaseWithoutHandler
  13. HasErrorCol
  14. HasSubscriptionKey
  15. HasServiceParams
  16. ComplexParamsWritable
  17. MLWritable
  18. HasURL
  19. HasOutputCol
  20. HTTPParams
  21. Wrappable
  22. Transformer
  23. PipelineStage
  24. Logging
  25. Params
  26. Serializable
  27. Serializable
  28. Identifiable
  29. AnyRef
  30. 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. def additionalPythonMethods(): String

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

    Permalink
    Definition Classes
    Any
  7. final def clear(param: Param[_]): OCR.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. val detectOrientation: ServiceParam[Boolean]

    Permalink
    Definition Classes
    HasDetectOrientation
  16. def emptyParamData[T](row: Row, p: ServiceParam[T]): Boolean

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasDetectOrientation
  31. def getDetectOrientationCol: String

    Permalink
    Definition Classes
    HasDetectOrientation
  32. def getErrorCol: String

    Permalink
    Definition Classes
    HasErrorCol
  33. def getHandler: HandlerFunc

    Permalink

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

    Permalink
    Definition Classes
    HasImageBytes
  35. def getImageBytesCol: String

    Permalink
    Definition Classes
    HasImageBytes
  36. def getImageUrl: String

    Permalink
    Definition Classes
    HasImageUrl
  37. def getImageUrlCol: String

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseWithoutHandler
  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 getRequiredParams: Array[ServiceParam[_]]

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

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

    Permalink
    Definition Classes
    HasServiceParams
  47. def getSubscriptionKey: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  48. def getSubscriptionKeyCol: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  49. def getTimeout: Double

    Permalink

    Definition Classes
    HTTPParams
  50. def getUrl: String

    Permalink

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  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. val language: ServiceParam[String]

    Permalink
    Definition Classes
    HasLanguage
  75. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    The name of the output column

    The name of the output column

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

    Permalink
    Definition Classes
    Params
  92. def prepareEntity: (Row) ⇒ Option[AbstractHttpEntity]

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

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

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

    Permalink
    Definition Classes
    OCRHasInternalJsonOutputParser
  96. def save(path: String): Unit

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

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

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

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

    Permalink

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

    Permalink

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    OCRHasSetLocation
  118. def setOutputCol(value: String): OCR.this.type

    Permalink

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

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

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

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

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

    Permalink

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

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    HasSubscriptionKey
  129. val subscriptionKeyHeaderName: String

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasSetLocation

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