Packages

c

com.microsoft.azure.synapse.ml.cognitive

FormRecognizerBase

abstract class FormRecognizerBase extends CognitiveServicesBaseNoHandler with HasCognitiveServiceInput with HasInternalJsonOutputParser with BasicAsyncReply with HasImageInput with HasSetLocation with HasSetLinkedService

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FormRecognizerBase
  2. HasSetLinkedService
  3. HasSetLocation
  4. HasUrlPath
  5. HasImageInput
  6. HasImageBytes
  7. HasImageUrl
  8. BasicAsyncReply
  9. HasAsyncReply
  10. HasInternalJsonOutputParser
  11. HasCognitiveServiceInput
  12. CognitiveServicesBaseNoHandler
  13. BasicLogging
  14. HasErrorCol
  15. HasSubscriptionKey
  16. HasServiceParams
  17. ComplexParamsWritable
  18. MLWritable
  19. HasURL
  20. HasOutputCol
  21. ConcurrencyParams
  22. Wrappable
  23. RWrappable
  24. PythonWrappable
  25. BaseWrappable
  26. Transformer
  27. PipelineStage
  28. Logging
  29. Params
  30. Serializable
  31. Serializable
  32. Identifiable
  33. AnyRef
  34. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FormRecognizerBase(uid: String)

Abstract Value Members

  1. abstract def responseDataType: DataType
    Attributes
    protected
    Definition Classes
    HasInternalJsonOutputParser
  2. abstract def urlPath: String
    Definition Classes
    HasUrlPath

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val backoffs: IntArrayParam
    Definition Classes
    HasAsyncReply
  7. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  8. final def clear(param: Param[_]): FormRecognizerBase.this.type
    Definition Classes
    Params
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  10. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  11. val concurrency: Param[Int]
    Definition Classes
    ConcurrencyParams
  12. val concurrentTimeout: Param[Double]
    Definition Classes
    ConcurrencyParams
  13. def contentType: (Row) ⇒ String
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  14. def copy(extra: ParamMap): Transformer
    Definition Classes
    CognitiveServicesBaseNoHandler → Transformer → PipelineStage → Params
  15. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  16. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  17. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  18. def emptyParamData[T](row: Row, p: ServiceParam[T]): Boolean
    Attributes
    protected
    Definition Classes
    HasServiceParams
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. val errorCol: Param[String]
    Definition Classes
    HasErrorCol
  22. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  23. def explainParams(): String
    Definition Classes
    Params
  24. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  25. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  26. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  28. def getBackoffs: Array[Int]

    Definition Classes
    HasAsyncReply
  29. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. def getConcurrency: Int

    Definition Classes
    ConcurrencyParams
  31. def getConcurrentTimeout: Double

    Definition Classes
    ConcurrencyParams
  32. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  33. def getErrorCol: String
    Definition Classes
    HasErrorCol
  34. def getImageBytes: Array[Byte]
    Definition Classes
    HasImageBytes
  35. def getImageBytesCol: String
    Definition Classes
    HasImageBytes
  36. def getImageUrl: String
    Definition Classes
    HasImageUrl
  37. def getImageUrlCol: String
    Definition Classes
    HasImageUrl
  38. def getInitialPollingDelay: Int

    Definition Classes
    HasAsyncReply
  39. def getInternalInputParser(schema: StructType): HTTPInputParser
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  40. def getInternalOutputParser(schema: StructType): HTTPOutputParser
    Attributes
    protected
    Definition Classes
    HasInternalJsonOutputParser
  41. def getInternalTransformer(schema: StructType): PipelineModel
    Attributes
    protected
    Definition Classes
    CognitiveServicesBaseNoHandler
  42. def getMaxPollingRetries: Int

    Definition Classes
    HasAsyncReply
  43. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  44. def getOutputCol: String

    Definition Classes
    HasOutputCol
  45. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  46. def getPollingDelay: Int

    Definition Classes
    HasAsyncReply
  47. def getRequiredParams: Array[ServiceParam[_]]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  48. def getScalarParam[T](name: String): T
    Definition Classes
    HasServiceParams
  49. def getScalarParam[T](p: ServiceParam[T]): T
    Definition Classes
    HasServiceParams
  50. def getSubscriptionKey: String
    Definition Classes
    HasSubscriptionKey
  51. def getSubscriptionKeyCol: String
    Definition Classes
    HasSubscriptionKey
  52. def getSuppressMaxRetriesExceededException: Boolean

    Definition Classes
    HasAsyncReply
  53. def getTimeout: Double

    Definition Classes
    ConcurrencyParams
  54. def getUrl: String

    Definition Classes
    HasURL
  55. def getUrlParams: Array[ServiceParam[_]]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  56. def getValue[T](row: Row, p: ServiceParam[T]): T
    Attributes
    protected
    Definition Classes
    HasServiceParams
  57. def getValueAny(row: Row, p: ServiceParam[_]): Any
    Attributes
    protected
    Definition Classes
    HasServiceParams
  58. def getValueAnyOpt(row: Row, p: ServiceParam[_]): Option[Any]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  59. def getValueMap(row: Row, excludes: Set[ServiceParam[_]] = Set()): Map[String, Any]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  60. def getValueOpt[T](row: Row, p: ServiceParam[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  61. def getVectorParam(name: String): String
    Definition Classes
    HasServiceParams
  62. def getVectorParam(p: ServiceParam[_]): String
    Definition Classes
    HasServiceParams
  63. def getVectorParamMap: Map[String, String]
    Attributes
    protected
    Definition Classes
    HasServiceParams
  64. def handlingFunc(client: CloseableHttpClient, request: HTTPRequestData): HTTPResponseData
    Attributes
    protected
    Definition Classes
    BasicAsyncReply → HasAsyncReply
  65. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  66. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  67. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  68. val imageBytes: ServiceParam[Array[Byte]]
    Definition Classes
    HasImageBytes
  69. val imageUrl: ServiceParam[String]
    Definition Classes
    HasImageUrl
  70. val initialPollingDelay: IntParam
    Definition Classes
    HasAsyncReply
  71. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  72. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def inputFunc(schema: StructType): (Row) ⇒ Option[HttpRequestBase]
    Attributes
    protected
    Definition Classes
    HasImageInput → HasCognitiveServiceInput
  74. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  75. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  76. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  77. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  78. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  79. def logBase(methodName: String): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  80. def logClass(): Unit
    Definition Classes
    BasicLogging
  81. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  85. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  86. def logFit[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  87. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  88. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  89. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  90. def logPredict[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  91. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  92. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  93. def logTrain[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  94. def logTransform[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  95. def logVerb[T](verb: String, f: ⇒ T): T
    Definition Classes
    BasicLogging
  96. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  97. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  98. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  99. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  100. val maxPollingRetries: IntParam
    Definition Classes
    HasAsyncReply
  101. def modifyPollingURI(originalURI: URI): URI
    Attributes
    protected
    Definition Classes
    BasicAsyncReply
  102. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  103. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  104. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  105. val outputCol: Param[String]

    The name of the output column

    The name of the output column

    Definition Classes
    HasOutputCol
  106. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  107. val pollingDelay: IntParam
    Definition Classes
    HasAsyncReply
  108. def prepareEntity: (Row) ⇒ Option[AbstractHttpEntity]
    Attributes
    protected
    Definition Classes
    FormRecognizerBase → HasImageInput → HasCognitiveServiceInput
  109. def prepareMethod(): HttpRequestBase
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  110. def prepareUrl: (Row) ⇒ String
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  111. def pyAdditionalMethods: String
    Definition Classes
    HasSetLinkedService → PythonWrappable
  112. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  113. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  114. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  115. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  116. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  117. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  118. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  119. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  120. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  121. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  122. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  123. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  124. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  125. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  126. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  127. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  128. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  129. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  130. def queryForResult(key: Option[String], client: CloseableHttpClient, location: URI): Option[HTTPResponseData]
    Attributes
    protected
    Definition Classes
    BasicAsyncReply → HasAsyncReply
  131. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  132. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  133. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  134. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  135. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  136. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  137. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  138. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  139. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  140. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  141. final def set(paramPair: ParamPair[_]): FormRecognizerBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  142. final def set(param: String, value: Any): FormRecognizerBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  143. final def set[T](param: Param[T], value: T): FormRecognizerBase.this.type
    Definition Classes
    Params
  144. def setBackoffs(value: Array[Int]): FormRecognizerBase.this.type

    Definition Classes
    HasAsyncReply
  145. def setConcurrency(value: Int): FormRecognizerBase.this.type

    Definition Classes
    ConcurrencyParams
  146. def setConcurrentTimeout(value: Option[Double]): FormRecognizerBase.this.type
    Definition Classes
    ConcurrencyParams
  147. def setConcurrentTimeout(value: Double): FormRecognizerBase.this.type

    Definition Classes
    ConcurrencyParams
  148. final def setDefault(paramPairs: ParamPair[_]*): FormRecognizerBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  149. final def setDefault[T](param: Param[T], value: T): FormRecognizerBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  150. def setErrorCol(v: String): FormRecognizerBase.this.type
    Definition Classes
    HasErrorCol
  151. def setImageBytes(v: Array[Byte]): FormRecognizerBase.this.type
    Definition Classes
    HasImageBytes
  152. def setImageBytesCol(v: String): FormRecognizerBase.this.type
    Definition Classes
    HasImageBytes
  153. def setImageUrl(v: String): FormRecognizerBase.this.type
    Definition Classes
    HasImageUrl
  154. def setImageUrlCol(v: String): FormRecognizerBase.this.type
    Definition Classes
    HasImageUrl
  155. def setInitialPollingDelay(value: Int): FormRecognizerBase.this.type

    Definition Classes
    HasAsyncReply
  156. def setLinkedService(v: String): FormRecognizerBase.this.type
    Definition Classes
    HasSetLinkedService
  157. def setLocation(v: String): FormRecognizerBase.this.type
    Definition Classes
    HasSetLocation
  158. def setMaxPollingRetries(value: Int): FormRecognizerBase.this.type

    Definition Classes
    HasAsyncReply
  159. def setOutputCol(value: String): FormRecognizerBase.this.type

    Definition Classes
    HasOutputCol
  160. def setPollingDelay(value: Int): FormRecognizerBase.this.type

    Definition Classes
    HasAsyncReply
  161. def setScalarParam[T](name: String, value: T): FormRecognizerBase.this.type
    Definition Classes
    HasServiceParams
  162. def setScalarParam[T](p: ServiceParam[T], value: T): FormRecognizerBase.this.type
    Definition Classes
    HasServiceParams
  163. def setSubscriptionKey(v: String): FormRecognizerBase.this.type
    Definition Classes
    HasSubscriptionKey
  164. def setSubscriptionKeyCol(v: String): FormRecognizerBase.this.type
    Definition Classes
    HasSubscriptionKey
  165. def setSuppressMaxRetriesExceededException(value: Boolean): FormRecognizerBase.this.type

    Definition Classes
    HasAsyncReply
  166. def setTimeout(value: Double): FormRecognizerBase.this.type

    Definition Classes
    ConcurrencyParams
  167. def setUrl(value: String): FormRecognizerBase.this.type

    Definition Classes
    HasURL
  168. def setVectorParam(name: String, value: String): FormRecognizerBase.this.type
    Definition Classes
    HasServiceParams
  169. def setVectorParam[T](p: ServiceParam[T], value: String): FormRecognizerBase.this.type
    Definition Classes
    HasServiceParams
  170. def shouldSkip(row: Row): Boolean
    Attributes
    protected
    Definition Classes
    HasImageInput → HasServiceParams
  171. val subscriptionKey: ServiceParam[String]
    Definition Classes
    HasSubscriptionKey
  172. val subscriptionKeyHeaderName: String
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  173. val suppressMaxRetriesExceededException: BooleanParam
    Definition Classes
    HasAsyncReply
  174. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  175. val timeout: Param[Double]
    Definition Classes
    ConcurrencyParams
  176. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  177. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    CognitiveServicesBaseNoHandler → Transformer
  178. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  179. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  180. def transformSchema(schema: StructType): StructType
    Definition Classes
    CognitiveServicesBaseNoHandler → PipelineStage
  181. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  182. val uid: String
    Definition Classes
    FormRecognizerBase → CognitiveServicesBaseNoHandler → BasicLogging → Identifiable
  183. val url: Param[String]
    Definition Classes
    HasURL
  184. val ver: String
    Definition Classes
    BasicLogging
  185. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  186. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  187. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  188. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasSetLinkedService

Inherited from HasSetLocation

Inherited from HasUrlPath

Inherited from HasImageInput

Inherited from HasImageBytes

Inherited from HasImageUrl

Inherited from BasicAsyncReply

Inherited from HasAsyncReply

Inherited from HasInternalJsonOutputParser

Inherited from HasCognitiveServiceInput

Inherited from CognitiveServicesBaseNoHandler

Inherited from BasicLogging

Inherited from HasErrorCol

Inherited from HasSubscriptionKey

Inherited from HasServiceParams

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from HasURL

Inherited from HasOutputCol

Inherited from ConcurrencyParams

Inherited from Wrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

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