EntireDetectResponse Class

The response of entire anomaly detection.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

EntireDetectResponse

Constructor

EntireDetectResponse(*, period: int, expected_values: List[float], upper_margins: List[float], lower_margins: List[float], is_anomaly: List[bool], is_negative_anomaly: List[bool], is_positive_anomaly: List[bool], severity: Optional[List[float]] = None, **kwargs)

Variables

period

int

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

expected_values

list[float]

Required. ExpectedValues contain expected value for each input point. The index of the array is consistent with the input series.

upper_margins

list[float]

Required. UpperMargins contain upper margin of each input point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)*upperMargin. Anomalies in response can be filtered by upperBoundary and lowerBoundary. By adjusting marginScale value, less significant anomalies can be filtered in client side. The index of the array is consistent with the input series.

lower_margins

list[float]

Required. LowerMargins contain lower margin of each input point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin. Points between the boundary can be marked as normal ones in client side. The index of the array is consistent with the input series.

is_anomaly

list[bool]

Required. IsAnomaly contains anomaly properties for each input point. True means an anomaly either negative or positive has been detected. The index of the array is consistent with the input series.

is_negative_anomaly

list[bool]

Required. IsNegativeAnomaly contains anomaly status in negative direction for each input point. True means a negative anomaly has been detected. A negative anomaly means the point is detected as an anomaly and its real value is smaller than the expected one. The index of the array is consistent with the input series.

is_positive_anomaly

list[bool]

Required. IsPositiveAnomaly contain anomaly status in positive direction for each input point. True means a positive anomaly has been detected. A positive anomaly means the point is detected as an anomaly and its real value is larger than the expected one. The index of the array is consistent with the input series.

severity

list[float]

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