Class/Object

com.microsoft.ml.spark

AddDocuments

Related Docs: object AddDocuments | package spark

Permalink

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

Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. 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. Transformer
  21. PipelineStage
  22. Logging
  23. Params
  24. Serializable
  25. Serializable
  26. Identifiable
  27. AnyRef
  28. 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. final def asInstanceOf[T0]: T0

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

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

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

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

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

    Permalink
    Definition Classes
    HTTPParams
  12. def copy(extra: ParamMap): Transformer

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  25. def getActionCol: String

    Permalink
    Definition Classes
    HasActionCol
  26. def getBatchSize: Int

    Permalink

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

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

    Permalink

    Definition Classes
    HTTPParams
  29. def getConcurrentTimeout: Double

    Permalink

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

    Permalink
    Definition Classes
    Params
  31. def getErrorCol: String

    Permalink
    Definition Classes
    HasErrorCol
  32. def getHandler: HandlerFunc

    Permalink

    Definition Classes
    HasHandler
  33. def getIndexName: String

    Permalink
    Definition Classes
    HasIndexName
  34. def getInternalInputParser(schema: StructType): HTTPInputParser

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

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

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

    Permalink
    Definition Classes
    Params
  38. def getOutputCol: String

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    HasServiceParams
  43. def getServiceName: String

    Permalink
    Definition Classes
    HasServiceName
  44. def getSubscriptionKey: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  45. def getSubscriptionKeyCol: String

    Permalink
    Definition Classes
    HasSubscriptionKey
  46. def getTimeout: Double

    Permalink

    Definition Classes
    HTTPParams
  47. def getUrl: String

    Permalink

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasIndexName
  63. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    The name of the output column

    The name of the output column

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

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

    Permalink

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

    Permalink

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

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

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

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

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

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

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

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

    Permalink

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

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

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

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

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

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

    Permalink

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

    Permalink

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

    Permalink
    Definition Classes
    HasServiceParams
  116. def setVectorParam[T](p: ServiceParam[T], value: String): AddDocuments.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. val subscriptionKeyHeaderName: String

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. 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 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