Package com.azure.ai.anomalydetector.models

Class LastDetectResponse

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    LastDetectResponse()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    getExpectedValue()
    Get the expectedValue property: Expected value of the latest point.
    float
    getLowerMargin()
    Get the lowerMargin property: Lower margin of the latest point.
    int
    getPeriod()
    Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found.
    Float
    getSeverity()
    Get the severity property: The severity score for the last input point.
    int
    getSuggestedWindow()
    Get the suggestedWindow property: Suggested input series points needed for detecting the latest point.
    float
    getUpperMargin()
    Get the upperMargin property: Upper margin of the latest point.
    boolean
    isAnomaly()
    Get the isAnomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction.
    boolean
    isNegativeAnomaly()
    Get the isNegativeAnomaly property: Anomaly status in negative direction of the latest point.
    boolean
    isPositiveAnomaly()
    Get the isPositiveAnomaly property: Anomaly status in positive direction of the latest point.
    LastDetectResponse
    setExpectedValue(float expectedValue)
    Set the expectedValue property: Expected value of the latest point.
    LastDetectResponse
    setIsAnomaly(boolean isAnomaly)
    Set the isAnomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction.
    LastDetectResponse
    setIsNegativeAnomaly(boolean isNegativeAnomaly)
    Set the isNegativeAnomaly property: Anomaly status in negative direction of the latest point.
    LastDetectResponse
    setIsPositiveAnomaly(boolean isPositiveAnomaly)
    Set the isPositiveAnomaly property: Anomaly status in positive direction of the latest point.
    LastDetectResponse
    setLowerMargin(float lowerMargin)
    Set the lowerMargin property: Lower margin of the latest point.
    LastDetectResponse
    setPeriod(int period)
    Set the period property: Frequency extracted from the series, zero means no recurrent pattern has been found.
    LastDetectResponse
    setSeverity(Float severity)
    Set the severity property: The severity score for the last input point.
    LastDetectResponse
    setSuggestedWindow(int suggestedWindow)
    Set the suggestedWindow property: Suggested input series points needed for detecting the latest point.
    LastDetectResponse
    setUpperMargin(float upperMargin)
    Set the upperMargin property: Upper margin of the latest point.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • LastDetectResponse

      public LastDetectResponse()

  • 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 LastDetectResponse 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 LastDetectResponse object itself.

    • getSuggestedWindow

      public int getSuggestedWindow()
      Get the suggestedWindow property: Suggested input series points needed for detecting the latest point.
      Returns:
      the suggestedWindow value.

    • setSuggestedWindow

      public LastDetectResponse setSuggestedWindow(int suggestedWindow)
      Set the suggestedWindow property: Suggested input series points needed for detecting the latest point.
      Parameters:
      suggestedWindow - the suggestedWindow value to set.
      Returns:
      the LastDetectResponse object itself.

    • getExpectedValue

      public float getExpectedValue()
      Get the expectedValue property: Expected value of the latest point.
      Returns:
      the expectedValue value.

    • setExpectedValue

      public LastDetectResponse setExpectedValue(float expectedValue)
      Set the expectedValue property: Expected value of the latest point.
      Parameters:
      expectedValue - the expectedValue value to set.
      Returns:
      the LastDetectResponse object itself.

    • getUpperMargin

      public float getUpperMargin()
      Get the upperMargin property: 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.
      Returns:
      the upperMargin value.

    • setUpperMargin

      public LastDetectResponse setUpperMargin(float upperMargin)
      Set the upperMargin property: 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.
      Parameters:
      upperMargin - the upperMargin value to set.
      Returns:
      the LastDetectResponse object itself.

    • getLowerMargin

      public float getLowerMargin()
      Get the lowerMargin property: Lower margin of the latest point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin.
      Returns:
      the lowerMargin value.

    • setLowerMargin

      public LastDetectResponse setLowerMargin(float lowerMargin)
      Set the lowerMargin property: Lower margin of the latest point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin.
      Parameters:
      lowerMargin - the lowerMargin value to set.
      Returns:
      the LastDetectResponse object itself.

    • isAnomaly

      public boolean isAnomaly()
      Get the isAnomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction.
      Returns:
      the isAnomaly value.

    • setIsAnomaly

      public LastDetectResponse setIsAnomaly(boolean isAnomaly)
      Set the isAnomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction.
      Parameters:
      isAnomaly - the isAnomaly value to set.
      Returns:
      the LastDetectResponse object itself.

    • isNegativeAnomaly

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

    • setIsNegativeAnomaly

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

    • isPositiveAnomaly

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

    • setIsPositiveAnomaly

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

    • getSeverity

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

    • setSeverity

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