Class/Object

com.microsoft.ml.spark

OCR

Related Docs: object OCR | package spark

Permalink

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  23. final def getClass(): Class[_]

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

    Permalink

    Definition Classes
    HTTPParams
  25. def getConcurrentTimeout: Double

    Permalink

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

    Permalink
    Definition Classes
    Params
  27. def getDetectOrientation: Boolean

    Permalink
    Definition Classes
    HasDetectOrientation
  28. def getDetectOrientationCol: String

    Permalink
    Definition Classes
    HasDetectOrientation
  29. def getErrorCol: String

    Permalink
    Definition Classes
    HasErrorCol
  30. def getHandler: HandlerFunc

    Permalink

    Definition Classes
    HasHandler
  31. def getImageUrl: String

    Permalink
    Definition Classes
    HasImageUrl
  32. def getImageUrlCol: String

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseWithoutHandler
  36. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  37. def getOutputCol: String

    Permalink

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

    Permalink
    Definition Classes
    Params
  39. def getRequiredParams: Array[ServiceParam[_]]

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

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

    Permalink
    Definition Classes
    HasServiceParams
  42. def getSubscriptionKey: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  43. def getSubscriptionKeyCol: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  44. def getUrl: String

    Permalink

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  59. val imageUrl: ServiceParam[String]

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasLanguage
  68. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    The name of the output column

    The name of the output column

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

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

    Permalink
    Definition Classes
    OCRHasCognitiveServiceInput
  86. def prepareMethod(): HttpRequestBase

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

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

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

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

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

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

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

    Permalink

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

    Permalink

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasHandler
  104. def setImageUrl(v: String): OCR.this.type

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

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

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

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

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

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    HasSubscriptionKey
  114. def setUrl(value: String): OCR.this.type

    Permalink

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasServiceParams
  118. val subscriptionKey: ServiceParam[String]

    Permalink
    Definition Classes
    HasSubscriptionKey
  119. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  120. def toString(): String

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasCognitiveServiceInput

Inherited from HasDetectOrientation

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