Class/Object

com.microsoft.ml.spark

RecognizeText

Related Docs: object RecognizeText | package spark

Permalink

class RecognizeText extends CognitiveServicesBaseWithoutHandler with HasImageUrl with HasCognitiveServiceInput with HasInternalJsonOutputParser

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Definition Classes
    HTTPParams
  24. def getConcurrentTimeout: Double

    Permalink

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

    Permalink
    Definition Classes
    Params
  26. def getErrorCol: String

    Permalink
    Definition Classes
    HasErrorCol
  27. def getImageUrl: String

    Permalink
    Definition Classes
    HasImageUrl
  28. def getImageUrlCol: String

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseWithoutHandler
  32. def getMode: String

    Permalink
  33. def getModeCol: String

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

    Permalink
    Definition Classes
    Params
  35. def getOutputCol: String

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    HasServiceParams
  40. def getSubscriptionKey: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  41. def getSubscriptionKeyCol: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  42. def getUrl: String

    Permalink

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  76. val mode: ServiceParam[String]

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

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

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

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

    Permalink

    The name of the output column

    The name of the output column

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    RecognizeTextHasCognitiveServiceInput
  83. def prepareMethod(): HttpRequestBase

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  90. def setConcurrency(value: Int): RecognizeText.this.type

    Permalink

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

    Permalink

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

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

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

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

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

    Permalink
    Definition Classes
    HasErrorCol
  97. def setImageUrl(v: String): RecognizeText.this.type

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

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

    Permalink
  100. def setMode(v: String): RecognizeText.this.type

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

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

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    HasSubscriptionKey
  107. def setUrl(value: String): RecognizeText.this.type

    Permalink

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasCognitiveServiceInput

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