Class/Object

com.microsoft.ml.spark.cognitive

AddDocuments

Related Docs: object AddDocuments | package cognitive

Permalink

class AddDocuments extends CognitiveServicesBase with HasCognitiveServiceInput with HasInternalJsonOutputParser with HasActionCol with HasServiceName with HasIndexName with HasBatchSize

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AddDocuments
  2. HasBatchSize
  3. HasIndexName
  4. HasServiceName
  5. HasActionCol
  6. HasInternalJsonOutputParser
  7. HasCognitiveServiceInput
  8. CognitiveServicesBase
  9. HasHandler
  10. CognitiveServicesBaseWithoutHandler
  11. HasErrorCol
  12. HasSubscriptionKey
  13. HasServiceParams
  14. ComplexParamsWritable
  15. MLWritable
  16. HasURL
  17. HasOutputCol
  18. HTTPParams
  19. Wrappable
  20. HasAdditionalPythonMethods
  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 AddDocuments()

    Permalink
  2. new AddDocuments(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. val actionCol: Param[String]

    Permalink
    Definition Classes
    HasActionCol
  6. def additionalPythonMethods(): String

    Permalink
    Definition Classes
    HasAdditionalPythonMethods
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. val batchSize: Param[Int]

    Permalink
    Definition Classes
    HasBatchSize
  9. final def clear(param: Param[_]): AddDocuments.this.type

    Permalink
    Definition Classes
    Params
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val concurrency: Param[Int]

    Permalink
    Definition Classes
    HTTPParams
  12. val concurrentTimeout: Param[Double]

    Permalink
    Definition Classes
    HTTPParams
  13. def contentType: (Row) ⇒ String

    Permalink
    Attributes
    protected
    Definition Classes
    HasCognitiveServiceInput
  14. def copy(extra: ParamMap): Transformer

    Permalink
    Definition Classes
    CognitiveServicesBaseWithoutHandler → Transformer → PipelineStage → Params
  15. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  16. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  17. def emptyParamData[T](row: Row, p: ServiceParam[T]): Boolean

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  27. def getActionCol: String

    Permalink
    Definition Classes
    HasActionCol
  28. def getBatchSize: Int

    Permalink

    Definition Classes
    HasBatchSize
  29. final def getClass(): Class[_]

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

    Permalink

    Definition Classes
    HTTPParams
  31. def getConcurrentTimeout: Double

    Permalink

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

    Permalink
    Definition Classes
    Params
  33. def getErrorCol: String

    Permalink
    Definition Classes
    HasErrorCol
  34. def getHandler: HandlerFunc

    Permalink

    Definition Classes
    HasHandler
  35. def getIndexName: String

    Permalink
    Definition Classes
    HasIndexName
  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
    AddDocumentsCognitiveServicesBaseWithoutHandler
  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 getServiceName: String

    Permalink
    Definition Classes
    HasServiceName
  46. def getSubscriptionKey: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  47. def getSubscriptionKeyCol: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  48. def getTimeout: Double

    Permalink

    Definition Classes
    HTTPParams
  49. def getUrl: String

    Permalink

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  64. val indexName: Param[String]

    Permalink
    Definition Classes
    HasIndexName
  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
    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. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    The name of the output column

    The name of the output column

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

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

    Permalink
    Definition Classes
    AddDocumentsHasCognitiveServiceInput
  90. def prepareMethod(): HttpRequestBase

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

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

    Permalink
  93. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  94. val serviceName: Param[String]

    Permalink
    Definition Classes
    HasServiceName
  95. final def set(paramPair: ParamPair[_]): AddDocuments.this.type

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

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

    Permalink
    Definition Classes
    Params
  98. def setActionCol(v: String): AddDocuments.this.type

    Permalink
    Definition Classes
    HasActionCol
  99. def setBatchSize(value: Int): AddDocuments.this.type

    Permalink

    Definition Classes
    HasBatchSize
  100. def setConcurrency(value: Int): AddDocuments.this.type

    Permalink

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

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    HasServiceParams
  106. def setErrorCol(v: String): AddDocuments.this.type

    Permalink
    Definition Classes
    HasErrorCol
  107. def setHandler(v: HandlerFunc): AddDocuments.this.type

    Permalink
    Definition Classes
    HasHandler
  108. def setIndexName(v: String): AddDocuments.this.type

    Permalink
    Definition Classes
    HasIndexName
  109. def setOutputCol(value: String): AddDocuments.this.type

    Permalink

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

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

    Permalink
    Definition Classes
    HasServiceParams
  112. def setServiceName(v: String): AddDocuments.this.type

    Permalink
    Definition Classes
    HasServiceName
  113. def setSubscriptionKey(v: String): AddDocuments.this.type

    Permalink
    Definition Classes
    HasSubscriptionKey
  114. def setSubscriptionKeyCol(v: String): AddDocuments.this.type

    Permalink
    Definition Classes
    HasSubscriptionKey
  115. def setTimeout(value: Double): AddDocuments.this.type

    Permalink

    Definition Classes
    HTTPParams
  116. def setUrl(value: String): AddDocuments.this.type

    Permalink

    Definition Classes
    HasURL
  117. def setVectorParam(name: String, value: String): AddDocuments.this.type

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

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

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

    Permalink
    Definition Classes
    HasSubscriptionKey
  121. val subscriptionKeyHeaderName: String

    Permalink
    Definition Classes
    AddDocumentsHasCognitiveServiceInput
  122. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AddDocumentsCognitiveServicesBaseWithoutHandler → Identifiable
  131. val url: Param[String]

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

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

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

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

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasBatchSize

Inherited from HasIndexName

Inherited from HasServiceName

Inherited from HasActionCol

Inherited from HasCognitiveServiceInput

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