com.microsoft.azure.synapse.ml.cognitive

HasCognitiveServiceInput

trait HasCognitiveServiceInput extends HasURL with HasSubscriptionKey with HasAADToken with HasCustomAuthHeader with SynapseMLLogging

Linear Supertypes

SynapseMLLogging, Logging, HasCustomAuthHeader, HasAADToken, HasSubscriptionKey, HasServiceParams, HasURL, Params, Serializable, Serializable, Identifiable, AnyRef, Any

Known Subclasses

AnomalyDetectorBase, DetectAnomalies, DetectLastAnomaly, DetectLastMultivariateAnomaly, SimpleDetectAnomalies, BingImageSearch, DetectFace, FindSimilarFace, GroupFaces, IdentifyFaces, VerifyFaces, AnalyzeBusinessCards, AnalyzeCustomModel, AnalyzeDocument, AnalyzeIDDocuments, AnalyzeInvoices, AnalyzeLayout, AnalyzeReceipts, FormRecognizerBase, GetCustomModel, ListCustomModels, AnalyzeText, OpenAIChatCompletion, OpenAICompletion, OpenAIEmbedding, AddDocuments, SpeakerEmotionInference, SpeechToText, BreakSentence, Detect, DictionaryExamples, DictionaryLookup, DocumentTranslator, TextAsOnlyEntity, Translate, Transliterate, AnalyzeImage, DescribeImage, GenerateThumbnails, HasImageInput, OCR, ReadImage, RecognizeDomainSpecificContent, RecognizeText, TagImage

Ordering

Alphabetic
By Inheritance

Inherited

HasCognitiveServiceInput
SynapseMLLogging
Logging
HasCustomAuthHeader
HasAADToken
HasSubscriptionKey
HasServiceParams
HasURL
Params
Serializable
Serializable
Identifiable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract def copy(extra: ParamMap): Params

Definition Classes
Params
abstract def prepareEntity: (Row) ⇒ Option[AbstractHttpEntity]

Attributes
protected
abstract val uid: String

Definition Classes
SynapseMLLogging

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T

Attributes
protected
Definition Classes
Params
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val AADToken: ServiceParam[String]

Definition Classes
HasAADToken
val CustomAuthHeader: ServiceParam[String]

Definition Classes
HasCustomAuthHeader
val aadHeaderName: String

Attributes
protected
def addHeaders(req: HttpRequestBase, subscriptionKey: Option[String], aadToken: Option[String], contentType: String = "", customAuthHeader: Option[String] = None): Unit

Attributes
protected
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def clear(param: Param[_]): HasCognitiveServiceInput.this.type

Definition Classes
Params
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def contentType: (Row) ⇒ String

Attributes
protected
def copyValues[T <: Params](to: T, extra: ParamMap): T

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

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

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def explainParam(param: Param[_]): String

Definition Classes
Params
def explainParams(): String

Definition Classes
Params
final def extractParamMap(): ParamMap

Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap

Definition Classes
Params
def finalize(): Unit

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

Definition Classes
Params
def getAADToken: String

Definition Classes
HasAADToken
def getAADTokenCol: String

Definition Classes
HasAADToken
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def getCustomAuthHeader: String

Definition Classes
HasCustomAuthHeader
def getCustomAuthHeaderCol: String

Definition Classes
HasCustomAuthHeader
final def getDefault[T](param: Param[T]): Option[T]

Definition Classes
Params
def getInternalInputParser(schema: StructType): HTTPInputParser

Attributes
protected
final def getOrDefault[T](param: Param[T]): T

Definition Classes
Params
def getParam(paramName: String): Param[Any]

Definition Classes
Params
def getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]

Attributes
protected
Definition Classes
SynapseMLLogging
def getRequiredParams: Array[ServiceParam[_]]

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

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

Definition Classes
HasServiceParams
def getSubscriptionKey: String

Definition Classes
HasSubscriptionKey
def getSubscriptionKeyCol: String

Definition Classes
HasSubscriptionKey
def getUrl: String

Definition Classes
HasCognitiveServiceInput → HasURL
def getUrlParams: Array[ServiceParam[_]]

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

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

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

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

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

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

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

Definition Classes
HasServiceParams
def getVectorParamMap: Map[String, String]

Attributes
protected
Definition Classes
HasServiceParams
final def hasDefault[T](param: Param[T]): Boolean

Definition Classes
Params
def hasParam(paramName: String): Boolean

Definition Classes
Params
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

Attributes
protected
final def isDefined(param: Param[_]): Boolean

Definition Classes
Params
final def isInstanceOf[T0]: Boolean

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

Definition Classes
Params
def isTraceEnabled(): Boolean

Attributes
protected
Definition Classes
Logging
def log: Logger

Attributes
protected
Definition Classes
Logging
def logBase(info: Map[String, String], featureName: Option[String]): Unit

Attributes
protected
Definition Classes
SynapseMLLogging
def logBase(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], featureName: Option[String]): Unit

Attributes
protected
Definition Classes
SynapseMLLogging
def logClass(featureName: String): Unit

Definition Classes
SynapseMLLogging
def logDebug(msg: ⇒ String, throwable: Throwable): Unit

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

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

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

Attributes
protected
Definition Classes
Logging
def logErrorBase(methodName: String, e: Exception): Unit

Attributes
protected
Definition Classes
SynapseMLLogging
def logFit[T](f: ⇒ T, columns: Int): T

Definition Classes
SynapseMLLogging
def logInfo(msg: ⇒ String, throwable: Throwable): Unit

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

Attributes
protected
Definition Classes
Logging
def logName: String

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

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

Attributes
protected
Definition Classes
Logging
def logTransform[T](f: ⇒ T, columns: Int): T

Definition Classes
SynapseMLLogging
def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T

Definition Classes
SynapseMLLogging
def logWarning(msg: ⇒ String, throwable: Throwable): Unit

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
def paramNameToPayloadName(p: Param[_]): String

Attributes
protected
lazy val params: Array[Param[_]]

Definition Classes
Params
def prepareMethod(): HttpRequestBase

Attributes
protected
def prepareUrl: (Row) ⇒ String

Attributes
protected
def prepareUrlRoot: (Row) ⇒ String

Attributes
protected
final def set(paramPair: ParamPair[_]): HasCognitiveServiceInput.this.type

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

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

Definition Classes
Params
def setAADToken(v: String): HasCognitiveServiceInput.this.type

Definition Classes
HasAADToken
def setAADTokenCol(v: String): HasCognitiveServiceInput.this.type

Definition Classes
HasAADToken
def setCustomAuthHeader(v: String): HasCognitiveServiceInput.this.type

Definition Classes
HasCustomAuthHeader
def setCustomAuthHeaderCol(v: String): HasCognitiveServiceInput.this.type

Definition Classes
HasCustomAuthHeader
final def setDefault(paramPairs: ParamPair[_]*): HasCognitiveServiceInput.this.type

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

Attributes
protected
Definition Classes
Params
def setDefaultAADToken(v: String): HasCognitiveServiceInput.this.type

Definition Classes
HasAADToken
def setDefaultCustomAuthHeader(v: String): HasCognitiveServiceInput.this.type

Definition Classes
HasCustomAuthHeader
def setScalarParam[T](name: String, value: T): HasCognitiveServiceInput.this.type

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

Definition Classes
HasServiceParams
def setSubscriptionKey(v: String): HasCognitiveServiceInput.this.type

Definition Classes
HasSubscriptionKey
def setSubscriptionKeyCol(v: String): HasCognitiveServiceInput.this.type

Definition Classes
HasSubscriptionKey
def setUrl(value: String): HasCognitiveServiceInput.this.type

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

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

Definition Classes
HasServiceParams
def shouldSkip(row: Row): Boolean

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

Definition Classes
HasSubscriptionKey
val subscriptionKeyHeaderName: String

Attributes
protected
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Identifiable → AnyRef → Any
val url: Param[String]

Definition Classes
HasURL
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()

Packages

HasCognitiveServiceInput

trait HasCognitiveServiceInput extends HasURL with HasSubscriptionKey with HasAADToken with HasCustomAuthHeader with SynapseMLLogging

Abstract Value Members

Concrete Value Members

Inherited from SynapseMLLogging

Inherited from Logging

Inherited from HasCustomAuthHeader

Inherited from HasAADToken

Inherited from HasSubscriptionKey

Inherited from HasServiceParams

Inherited from HasURL

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

setParam

Ungrouped

Packages

HasCognitiveServiceInput 

trait HasCognitiveServiceInput extends HasURL with HasSubscriptionKey with HasAADToken with HasCustomAuthHeader with SynapseMLLogging

Abstract Value Members

Concrete Value Members

Inherited from SynapseMLLogging

Inherited from Logging

Inherited from HasCustomAuthHeader

Inherited from HasAADToken

Inherited from HasSubscriptionKey

Inherited from HasServiceParams

Inherited from HasURL

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

setParam

Ungrouped

HasCognitiveServiceInput