Share via

DetectLastPointResponse interface

  • Reference
Package:
@azure/ai-anomaly-detector

The response of last anomaly detection.

Properties

expectedValue

Expected value of the latest point.
isAnomaly

Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction.
isNegativeAnomaly

Anomaly status in negative direction of the latest point. True means the latest point is an anomaly and its real value is smaller than the expected one.
isPositiveAnomaly

Anomaly status in positive direction of the latest point. True means the latest point is an anomaly and its real value is larger than the expected one.
lowerMargin

Lower margin of the latest point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin.
period

Frequency extracted from the series, zero means no recurrent pattern has been found.
severity

The severity score for the last input point. The larger the value is, the more sever the anomaly is. For normal points, the "severity" is always 0.
suggestedWindow

Suggested input series points needed for detecting the latest point.
upperMargin

Upper margin of the latest point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)*upperMargin. If the value of latest point is between upperBoundary and lowerBoundary, it should be treated as normal value. By adjusting marginScale value, anomaly status of latest point can be changed.

Property Details

expectedValue

Expected value of the latest point.

expectedValue: number

Property Value

number

isAnomaly

Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction.

isAnomaly: boolean

Property Value

boolean

isNegativeAnomaly

Anomaly status in negative direction of the latest point. True means the latest point is an anomaly and its real value is smaller than the expected one.

isNegativeAnomaly: boolean

Property Value

boolean

isPositiveAnomaly

Anomaly status in positive direction of the latest point. True means the latest point is an anomaly and its real value is larger than the expected one.

isPositiveAnomaly: boolean

Property Value

boolean

lowerMargin

Lower margin of the latest point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin.

lowerMargin: number

Property Value

number

period

Frequency extracted from the series, zero means no recurrent pattern has been found.

period: number

Property Value

number

severity

The severity score for the last input point. The larger the value is, the more sever the anomaly is. For normal points, the "severity" is always 0.

severity?: number

Property Value

number

suggestedWindow

Suggested input series points needed for detecting the latest point.

suggestedWindow: number

Property Value

number

upperMargin

Upper margin of the latest point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)*upperMargin. If the value of latest point is between upperBoundary and lowerBoundary, it should be treated as normal value. By adjusting marginScale value, anomaly status of latest point can be changed.

upperMargin: number

Property Value

number