Package com.azure.ai.anomalydetector.models

Class EntireDetectResponse

java.lang.Object
com.azure.ai.anomalydetector.models.EntireDetectResponse
public final class EntireDetectResponse extends Object
The response of entire anomaly detection.

  • Constructor Details

    • EntireDetectResponse

      public EntireDetectResponse()

  • Method Details

    • getPeriod

      public int getPeriod()
      Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found.
      Returns:
      the period value.

    • setPeriod

      public EntireDetectResponse setPeriod(int period)
      Set the period property: Frequency extracted from the series, zero means no recurrent pattern has been found.
      Parameters:
      period - the period value to set.
      Returns:
      the EntireDetectResponse object itself.

    • getExpectedValues

      public List<Float> getExpectedValues()
      Get the expectedValues property: ExpectedValues contain expected value for each input point. The index of the array is consistent with the input series.
      Returns:
      the expectedValues value.

    • setExpectedValues

      public EntireDetectResponse setExpectedValues(List<Float> expectedValues)
      Set the expectedValues property: ExpectedValues contain expected value for each input point. The index of the array is consistent with the input series.
      Parameters:
      expectedValues - the expectedValues value to set.
      Returns:
      the EntireDetectResponse object itself.

    • getUpperMargins

      public List<Float> getUpperMargins()
      Get the upperMargins property: 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.
      Returns:
      the upperMargins value.

    • setUpperMargins

      public EntireDetectResponse setUpperMargins(List<Float> upperMargins)
      Set the upperMargins property: 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.
      Parameters:
      upperMargins - the upperMargins value to set.
      Returns:
      the EntireDetectResponse object itself.

    • getLowerMargins

      public List<Float> getLowerMargins()
      Get the lowerMargins property: 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.
      Returns:
      the lowerMargins value.

    • setLowerMargins

      public EntireDetectResponse setLowerMargins(List<Float> lowerMargins)
      Set the lowerMargins property: 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.
      Parameters:
      lowerMargins - the lowerMargins value to set.
      Returns:
      the EntireDetectResponse object itself.

    • getIsAnomaly

      public List<Boolean> getIsAnomaly()
      Get the isAnomaly property: 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.
      Returns:
      the isAnomaly value.

    • setIsAnomaly

      public EntireDetectResponse setIsAnomaly(List<Boolean> isAnomaly)
      Set the isAnomaly property: 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.
      Parameters:
      isAnomaly - the isAnomaly value to set.
      Returns:
      the EntireDetectResponse object itself.

    • getIsNegativeAnomaly

      public List<Boolean> getIsNegativeAnomaly()
      Get the isNegativeAnomaly property: 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.
      Returns:
      the isNegativeAnomaly value.

    • setIsNegativeAnomaly

      public EntireDetectResponse setIsNegativeAnomaly(List<Boolean> isNegativeAnomaly)
      Set the isNegativeAnomaly property: 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.
      Parameters:
      isNegativeAnomaly - the isNegativeAnomaly value to set.
      Returns:
      the EntireDetectResponse object itself.

    • getIsPositiveAnomaly

      public List<Boolean> getIsPositiveAnomaly()
      Get the isPositiveAnomaly property: 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.
      Returns:
      the isPositiveAnomaly value.

    • setIsPositiveAnomaly

      public EntireDetectResponse setIsPositiveAnomaly(List<Boolean> isPositiveAnomaly)
      Set the isPositiveAnomaly property: 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.
      Parameters:
      isPositiveAnomaly - the isPositiveAnomaly value to set.
      Returns:
      the EntireDetectResponse object itself.

    • getSeverity

      public List<Float> getSeverity()
      Get the severity property: 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.
      Returns:
      the severity value.

    • setSeverity

      public EntireDetectResponse setSeverity(List<Float> severity)
      Set the severity property: 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.
      Parameters:
      severity - the severity value to set.
      Returns:
      the EntireDetectResponse object itself.