DetectAnomalies implements DetectAnomalies More...

Inheritance diagram for Synapse.ML.Cognitive.DetectAnomalies:

Collaboration diagram for Synapse.ML.Cognitive.DetectAnomalies:

Public Member Functions
	DetectAnomalies ()
	Creates a DetectAnomalies without any parameters. More...

	DetectAnomalies (string uid)
	Creates a DetectAnomalies with a UID that is used to give the DetectAnomalies a unique ID. More...

DetectAnomalies	SetConcurrency (int value)
	Sets value for concurrency More...

DetectAnomalies	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...

DetectAnomalies	SetCustomInterval (int value)
	Sets value for customInterval More...

DetectAnomalies	SetCustomIntervalCol (string value)
	Sets value for customInterval column More...

DetectAnomalies	SetErrorCol (string value)
	Sets value for errorCol More...

DetectAnomalies	SetGranularity (string value)
	Sets value for granularity More...

DetectAnomalies	SetGranularityCol (string value)
	Sets value for granularity column More...

DetectAnomalies	SetHandler (object value)
	Sets value for handler More...

DetectAnomalies	SetImputeFixedValue (double value)
	Sets value for imputeFixedValue More...

DetectAnomalies	SetImputeFixedValueCol (string value)
	Sets value for imputeFixedValue column More...

DetectAnomalies	SetImputeMode (string value)
	Sets value for imputeMode More...

DetectAnomalies	SetImputeModeCol (string value)
	Sets value for imputeMode column More...

DetectAnomalies	SetMaxAnomalyRatio (double value)
	Sets value for maxAnomalyRatio More...

DetectAnomalies	SetMaxAnomalyRatioCol (string value)
	Sets value for maxAnomalyRatio column More...

DetectAnomalies	SetOutputCol (string value)
	Sets value for outputCol More...

DetectAnomalies	SetPeriod (int value)
	Sets value for period More...

DetectAnomalies	SetPeriodCol (string value)
	Sets value for period column More...

DetectAnomalies	SetSensitivity (int value)
	Sets value for sensitivity More...

DetectAnomalies	SetSensitivityCol (string value)
	Sets value for sensitivity column More...

DetectAnomalies	SetSeries (TimeSeriesPoint[] value)
	Sets value for series More...

DetectAnomalies	SetSeriesCol (string value)
	Sets value for series column More...

DetectAnomalies	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...

DetectAnomalies	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...

DetectAnomalies	SetTimeout (double value)
	Sets value for timeout More...

DetectAnomalies	SetUrl (string value)
	Sets value for url More...

int	GetConcurrency ()
	Gets concurrency value More...

double	GetConcurrentTimeout ()
	Gets concurrentTimeout value More...

int	GetCustomInterval ()
	Gets customInterval value More...

string	GetErrorCol ()
	Gets errorCol value More...

string	GetGranularity ()
	Gets granularity value More...

object	GetHandler ()
	Gets handler value More...

double	GetImputeFixedValue ()
	Gets imputeFixedValue value More...

string	GetImputeMode ()
	Gets imputeMode value More...

double	GetMaxAnomalyRatio ()
	Gets maxAnomalyRatio value More...

string	GetOutputCol ()
	Gets outputCol value More...

int	GetPeriod ()
	Gets period value More...

int	GetSensitivity ()
	Gets sensitivity value More...

TimeSeriesPoint []	GetSeries ()
	Gets series value More...

string	GetSubscriptionKey ()
	Gets subscriptionKey value More...

double	GetTimeout ()
	Gets timeout value More...

string	GetUrl ()
	Gets url value More...

void	Save (string path)
	Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More...

JavaMLWriter	Write ()
	Returns a JavaMLWriter instance for this ML instance.

JavaMLReader< DetectAnomalies >	Read ()
	Get the corresponding JavaMLReader instance. More...

DetectAnomalies	SetLocation (string value)
	Sets value for location More...

DetectAnomalies	SetLinkedService (string value)
	Sets value for linkedService More...

Static Public Member Functions
static DetectAnomalies	Load (string path)
	Loads the DetectAnomalies that was previously saved using Save(string). More...

Detailed Description

DetectAnomalies implements DetectAnomalies

Constructor & Destructor Documentation

◆ DetectAnomalies() [1/2]

Synapse.ML.Cognitive.DetectAnomalies.DetectAnomalies ( )

inline

Creates a DetectAnomalies without any parameters.

◆ DetectAnomalies() [2/2]

Synapse.ML.Cognitive.DetectAnomalies.DetectAnomalies ( string uid )

inline

Creates a DetectAnomalies with a UID that is used to give the DetectAnomalies a unique ID.

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetConcurrency()

int Synapse.ML.Cognitive.DetectAnomalies.GetConcurrency ( )

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Cognitive.DetectAnomalies.GetConcurrentTimeout ( )

Gets concurrentTimeout value

Returns: concurrentTimeout: max number seconds to wait on futures if concurrency >= 1

◆ GetCustomInterval()

int Synapse.ML.Cognitive.DetectAnomalies.GetCustomInterval ( )

Gets customInterval value

Returns: customInterval: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as granularity=minutely, customInterval=5.

◆ GetErrorCol()

string Synapse.ML.Cognitive.DetectAnomalies.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetGranularity()

string Synapse.ML.Cognitive.DetectAnomalies.GetGranularity ( )

Gets granularity value

Returns: granularity: Can only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid.

◆ GetHandler()

object Synapse.ML.Cognitive.DetectAnomalies.GetHandler ( )

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetImputeFixedValue()

double Synapse.ML.Cognitive.DetectAnomalies.GetImputeFixedValue ( )

Gets imputeFixedValue value

Returns: imputeFixedValue: Optional argument, fixed value to use when imputeMode is set to "fixed"

◆ GetImputeMode()

string Synapse.ML.Cognitive.DetectAnomalies.GetImputeMode ( )

Gets imputeMode value

Returns: imputeMode: Optional argument, impute mode of a time series. Possible values: auto, previous, linear, fixed, zero, notFill

◆ GetMaxAnomalyRatio()

double Synapse.ML.Cognitive.DetectAnomalies.GetMaxAnomalyRatio ( )

Gets maxAnomalyRatio value

Returns: maxAnomalyRatio: Optional argument, advanced model parameter, max anomaly ratio in a time series.

◆ GetOutputCol()

string Synapse.ML.Cognitive.DetectAnomalies.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetPeriod()

int Synapse.ML.Cognitive.DetectAnomalies.GetPeriod ( )

Gets period value

Returns: period: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.

◆ GetSensitivity()

int Synapse.ML.Cognitive.DetectAnomalies.GetSensitivity ( )

Gets sensitivity value

Returns: sensitivity: Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted

◆ GetSeries()

TimeSeriesPoint [] Synapse.ML.Cognitive.DetectAnomalies.GetSeries ( )

inline

Gets series value

Returns: series: Time series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned.

◆ GetSubscriptionKey()

string Synapse.ML.Cognitive.DetectAnomalies.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetTimeout()

double Synapse.ML.Cognitive.DetectAnomalies.GetTimeout ( )

Gets timeout value

Returns: timeout: number of seconds to wait before closing the connection

◆ GetUrl()

string Synapse.ML.Cognitive.DetectAnomalies.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ Load()

static DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.Load ( string path )

static

Loads the DetectAnomalies that was previously saved using Save(string).

Parameters

path	The path the previous DetectAnomalies was saved to

Returns: New DetectAnomalies object, loaded from path.

◆ Read()

JavaMLReader<DetectAnomalies> Synapse.ML.Cognitive.DetectAnomalies.Read ( )

Get the corresponding JavaMLReader instance.

Returns: an JavaMLReader<DetectAnomalies> instance for this ML instance.

◆ Save()

void Synapse.ML.Cognitive.DetectAnomalies.Save ( string path )

Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.

Parameters

path	The path to save the object to

◆ SetConcurrency()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetConcurrency ( int value )

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New DetectAnomalies object

◆ SetConcurrentTimeout()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetConcurrentTimeout ( double value )

Sets value for concurrentTimeout

Parameters

value max number seconds to wait on futures if concurrency >= 1

Returns: New DetectAnomalies object

◆ SetCustomInterval()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetCustomInterval ( int value )

Sets value for customInterval

Parameters

value Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as granularity=minutely, customInterval=5.

Returns: New DetectAnomalies object

◆ SetCustomIntervalCol()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetCustomIntervalCol ( string value )

Sets value for customInterval column

Parameters

value Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as granularity=minutely, customInterval=5.

Returns: New DetectAnomalies object

◆ SetErrorCol()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New DetectAnomalies object

◆ SetGranularity()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetGranularity ( string value )

Sets value for granularity

Parameters

value Can only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid.

Returns: New DetectAnomalies object

◆ SetGranularityCol()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetGranularityCol ( string value )

Sets value for granularity column

Parameters

value Can only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid.

Returns: New DetectAnomalies object

◆ SetHandler()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetHandler ( object value )

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New DetectAnomalies object

◆ SetImputeFixedValue()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetImputeFixedValue ( double value )

Sets value for imputeFixedValue

Parameters

value Optional argument, fixed value to use when imputeMode is set to "fixed"

Returns: New DetectAnomalies object

◆ SetImputeFixedValueCol()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetImputeFixedValueCol ( string value )

Sets value for imputeFixedValue column

Parameters

value Optional argument, fixed value to use when imputeMode is set to "fixed"

Returns: New DetectAnomalies object

◆ SetImputeMode()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetImputeMode ( string value )

Sets value for imputeMode

Parameters

value Optional argument, impute mode of a time series. Possible values: auto, previous, linear, fixed, zero, notFill

Returns: New DetectAnomalies object

◆ SetImputeModeCol()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetImputeModeCol ( string value )

Sets value for imputeMode column

Parameters

value Optional argument, impute mode of a time series. Possible values: auto, previous, linear, fixed, zero, notFill

Returns: New DetectAnomalies object

◆ SetLinkedService()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetLinkedService ( string value )

Sets value for linkedService

Parameters

value linkedService name

Returns: New DetectAnomalies object

◆ SetLocation()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetLocation ( string value )

Sets value for location

Parameters

value Location of the cognitive service

Returns: New DetectAnomalies object

◆ SetMaxAnomalyRatio()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetMaxAnomalyRatio ( double value )

Sets value for maxAnomalyRatio

Parameters

value Optional argument, advanced model parameter, max anomaly ratio in a time series.

Returns: New DetectAnomalies object

◆ SetMaxAnomalyRatioCol()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetMaxAnomalyRatioCol ( string value )

Sets value for maxAnomalyRatio column

Parameters

value Optional argument, advanced model parameter, max anomaly ratio in a time series.

Returns: New DetectAnomalies object

◆ SetOutputCol()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New DetectAnomalies object

◆ SetPeriod()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetPeriod ( int value )

Sets value for period

Parameters

value Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.

Returns: New DetectAnomalies object

◆ SetPeriodCol()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetPeriodCol ( string value )

Sets value for period column

Parameters

value Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.

Returns: New DetectAnomalies object

◆ SetSensitivity()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetSensitivity ( int value )

Sets value for sensitivity

Parameters

value Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted

Returns: New DetectAnomalies object

◆ SetSensitivityCol()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetSensitivityCol ( string value )

Sets value for sensitivity column

Parameters

value Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted

Returns: New DetectAnomalies object

◆ SetSeries()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetSeries ( TimeSeriesPoint [] value )

Sets value for series

Parameters

value Time series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned.

Returns: New DetectAnomalies object

◆ SetSeriesCol()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetSeriesCol ( string value )

Sets value for series column

Parameters

value Time series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned.

Returns: New DetectAnomalies object

◆ SetSubscriptionKey()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New DetectAnomalies object

◆ SetSubscriptionKeyCol()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New DetectAnomalies object

◆ SetTimeout()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetTimeout ( double value )

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New DetectAnomalies object

◆ SetUrl()

DetectAnomalies Synapse.ML.Cognitive.DetectAnomalies.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New DetectAnomalies object

The documentation for this class was generated from the following file:

synapse/ml/cognitive/DetectAnomalies.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DetectAnomalies() [1/2]

◆ DetectAnomalies() [2/2]

Member Function Documentation

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCustomInterval()

◆ GetErrorCol()

◆ GetGranularity()

◆ GetHandler()

◆ GetImputeFixedValue()

◆ GetImputeMode()

◆ GetMaxAnomalyRatio()

◆ GetOutputCol()

◆ GetPeriod()

◆ GetSensitivity()

◆ GetSeries()

◆ GetSubscriptionKey()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCustomInterval()

◆ SetCustomIntervalCol()

◆ SetErrorCol()

◆ SetGranularity()

◆ SetGranularityCol()

◆ SetHandler()

◆ SetImputeFixedValue()

◆ SetImputeFixedValueCol()

◆ SetImputeMode()

◆ SetImputeModeCol()

◆ SetLinkedService()

◆ SetLocation()

◆ SetMaxAnomalyRatio()

◆ SetMaxAnomalyRatioCol()

◆ SetOutputCol()

◆ SetPeriod()

◆ SetPeriodCol()

◆ SetSensitivity()

◆ SetSensitivityCol()

◆ SetSeries()

◆ SetSeriesCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetTimeout()

◆ SetUrl()