Class/Object

com.microsoft.ml.spark

OCR

Related Docs: object OCR | package spark

Permalink

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

Linear Supertypes
HasInternalJsonOutputParser, HasDetectOrientation, HasImageInput, HasCognitiveServiceInput, HasImageBytes, HasImageUrl, HasLanguage, CognitiveServicesBase, HasHandler, 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. 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 copy(extra: ParamMap): Transformer

    Permalink
    Definition Classes
    CognitiveServicesBaseWithoutHandler → Transformer → PipelineStage → Params

  11. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  12. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  13. val detectOrientation: ServiceParam[Boolean]

    Permalink
    Definition Classes
    HasDetectOrientation

  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 getDetectOrientation: Boolean

    Permalink
    Definition Classes
    HasDetectOrientation

  29. def getDetectOrientationCol: String

    Permalink
    Definition Classes
    HasDetectOrientation

  30. def getErrorCol: String

    Permalink
    Definition Classes
    HasErrorCol

  31. def getHandler: HandlerFunc

    Permalink

    Definition Classes
    HasHandler

  32. def getImageBytes: Array[Byte]

    Permalink
    Definition Classes
    HasImageBytes

  33. def getImageBytesCol: String

    Permalink
    Definition Classes
    HasImageBytes

  34. def getImageUrl: String

    Permalink
    Definition Classes
    HasImageUrl

  35. def getImageUrlCol: String

    Permalink
    Definition Classes
    HasImageUrl

  36. def getInternalInputParser(schema: StructType): HTTPInputParser

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput

  37. def getInternalOutputParser(schema: StructType): HTTPOutputParser

    Permalink
    Attributes
    protected
    Definition Classes
    HasInternalJsonOutputParser

  38. def getInternalTransformer(schema: StructType): PipelineModel

    Permalink
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseWithoutHandler

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

    Permalink
    Definition Classes
    Params

  40. def getOutputCol: String

    Permalink

    Definition Classes
    HasOutputCol

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

    Permalink
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

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

    Permalink
    Definition Classes
    HasServiceParams

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

    Permalink
    Definition Classes
    HasServiceParams

  45. def getSubscriptionKey: String

    Permalink
    Definition Classes
    HasSubscriptionKey

  46. def getSubscriptionKeyCol: String

    Permalink
    Definition Classes
    HasSubscriptionKey

  47. def getTimeout: Double

    Permalink

    Definition Classes
    HTTPParams

  48. def getUrl: String

    Permalink

    Definition Classes
    HasURL

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

  55. def getVectorParam(name: String): String

    Permalink
    Definition Classes
    HasServiceParams

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

    Permalink
    Definition Classes
    HasServiceParams

  57. def getVectorParamMap: Map[String, String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams

  58. val handler: UDFParam

    Permalink
    Definition Classes
    HasHandler

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

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

    Permalink
    Definition Classes
    HasLanguage

  73. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  80. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Definition Classes
    AnyRef

  86. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  87. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  88. val outputCol: Param[String]

    Permalink

    The name of the output column

    The name of the output column

    Definition Classes
    HasOutputCol

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

    Permalink
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasImageInput → HasCognitiveServiceInput

  91. def prepareMethod(): HttpRequestBase

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput

  92. def prepareUrl: (Row) ⇒ String

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput

  93. def responseDataType: DataType

    Permalink
    Definition Classes
    OCR → HasInternalJsonOutputParser

  94. def save(path: String): Unit

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

  95. final def set(paramPair: ParamPair[_]): OCR.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  96. final def set(param: String, value: Any): OCR.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    Params

  98. def setConcurrency(value: Int): OCR.this.type

    Permalink

    Definition Classes
    HTTPParams

  99. def setConcurrentTimeout(value: Double): OCR.this.type

    Permalink

    Definition Classes
    HTTPParams

  100. final def setDefault(paramPairs: ParamPair[_]*): OCR.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  102. def setDefaultLanguage(v: String): OCR.this.type

    Permalink

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

    Permalink
    Definition Classes
    HasServiceParams

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

    Permalink
    Definition Classes
    HasServiceParams

  105. def setDetectOrientation(v: Boolean): OCR.this.type

    Permalink
    Definition Classes
    HasDetectOrientation

  106. def setDetectOrientationCol(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasDetectOrientation

  107. def setErrorCol(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasErrorCol

  108. def setHandler(v: HandlerFunc): OCR.this.type

    Permalink
    Definition Classes
    HasHandler

  109. def setImageBytes(v: Array[Byte]): OCR.this.type

    Permalink
    Definition Classes
    HasImageBytes

  110. def setImageBytesCol(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasImageBytes

  111. def setImageUrl(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasImageUrl

  112. def setImageUrlCol(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasImageUrl

  113. def setLanguage(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasLanguage

  114. def setLanguageCol(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasLanguage

  115. def setLocation(v: String): OCR.this.type

    Permalink

  116. def setOutputCol(value: String): OCR.this.type

    Permalink

    Definition Classes
    HasOutputCol

  117. def setScalarParam[T](name: String, value: T): OCR.this.type

    Permalink
    Definition Classes
    HasServiceParams

  118. def setScalarParam[T](p: ServiceParam[T], value: T): OCR.this.type

    Permalink
    Definition Classes
    HasServiceParams

  119. def setSubscriptionKey(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasSubscriptionKey

  120. def setSubscriptionKeyCol(v: String): OCR.this.type

    Permalink
    Definition Classes
    HasSubscriptionKey

  121. def setTimeout(value: Double): OCR.this.type

    Permalink

    Definition Classes
    HTTPParams

  122. def setUrl(value: String): OCR.this.type

    Permalink

    Definition Classes
    HasURL

  123. def setVectorParam(name: String, value: String): OCR.this.type

    Permalink
    Definition Classes
    HasServiceParams

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

    Permalink
    Definition Classes
    HasServiceParams

  125. def shouldSkip(row: Row): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasImageInput → HasServiceParams

  126. val subscriptionKey: ServiceParam[String]

    Permalink
    Definition Classes
    HasSubscriptionKey

  127. val subscriptionKeyHeaderName: String

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput

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

    Permalink
    Definition Classes
    AnyRef

  129. val timeout: Param[Double]

    Permalink
    Definition Classes
    HTTPParams

  130. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

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

    Permalink
    Definition Classes
    CognitiveServicesBaseWithoutHandler → Transformer

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

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

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

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

  134. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    CognitiveServicesBaseWithoutHandler → PipelineStage

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

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  136. val uid: String

    Permalink
    Definition Classes
    OCR → CognitiveServicesBaseWithoutHandler → Identifiable

  137. val url: Param[String]

    Permalink
    Definition Classes
    HasURL

  138. final def wait(): Unit

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

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

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

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

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

  141. def write: MLWriter

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasInternalJsonOutputParser

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