DetectRequest interface

Package:

@azure/ai-anomaly-detector

The request of entire or last anomaly detection.

Properties

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}.
granularity	Optional argument, can be one of yearly, monthly, weekly, daily, hourly, minutely, secondly, microsecond or none. If granularity is not present, it will be none by default. If granularity is none, the timestamp property in time series point can be absent.
imputeFixedValue	Used to specify the value to fill, it's used when granularity is not "none" and imputeMode is "fixed".
imputeMode	Used to specify how to deal with missing values in the input series, it's used when granularity is not "none".
maxAnomalyRatio	Optional argument, advanced model parameter, max anomaly ratio in a time series.
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.
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.
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.

Property Details

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}.

customInterval?: number

Property Value

number

granularity

Optional argument, can be one of yearly, monthly, weekly, daily, hourly, minutely, secondly, microsecond or none. If granularity is not present, it will be none by default. If granularity is none, the timestamp property in time series point can be absent.

granularity?: TimeGranularity

Property Value

TimeGranularity

imputeFixedValue

Used to specify the value to fill, it's used when granularity is not "none" and imputeMode is "fixed".

imputeFixedValue?: number

Property Value

number

imputeMode

Used to specify how to deal with missing values in the input series, it's used when granularity is not "none".

imputeMode?: string

Property Value

string

maxAnomalyRatio

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

maxAnomalyRatio?: number

Property Value

number

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.

period?: number

Property Value

number

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.

sensitivity?: number

Property Value

number

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.

series: TimeSeriesPoint[]

Property Value

TimeSeriesPoint[]