EntireDetectResponse Class

EntireDetectResponse.

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

Inheritance
EntireDetectResponse

Constructor

EntireDetectResponse(*, period: int, expected_values, upper_margins, lower_margins, is_anomaly, is_negative_anomaly, is_positive_anomaly, **kwargs) -> None

Parameters

period
int
Required

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

expected_values
list[float]
Required

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

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

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

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

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

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.