Package com.azure.ai.anomalydetector.models

Class UnivariateChangePointDetectionOptions

java.lang.Object
com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions
public final class UnivariateChangePointDetectionOptions extends Object
The request of change point detection.

  • Constructor Details

    • UnivariateChangePointDetectionOptions

      public UnivariateChangePointDetectionOptions(List<TimeSeriesPoint> series, TimeGranularity granularity)
      Creates an instance of UnivariateChangePointDetectionOptions class.
      Parameters:
      series - the series value to set.
      granularity - the granularity value to set.

  • Method Details

    • getSeries

      public List<TimeSeriesPoint> getSeries()
      Get the series property: Time series data points. Points should be sorted by timestamp in ascending order to match the change point detection result.
      Returns:
      the series value.

    • getGranularity

      public TimeGranularity getGranularity()
      Get the granularity property: Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid.
      Returns:
      the granularity value.

    • getCustomInterval

      public Integer getCustomInterval()
      Get the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {"granularity":"minutely", "customInterval":5}.
      Returns:
      the customInterval value.

    • setCustomInterval

      public UnivariateChangePointDetectionOptions setCustomInterval(Integer customInterval)
      Set the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {"granularity":"minutely", "customInterval":5}.
      Parameters:
      customInterval - the customInterval value to set.
      Returns:
      the UnivariateChangePointDetectionOptions object itself.

    • getPeriod

      public Integer getPeriod()
      Get the period property: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.
      Returns:
      the period value.

    • setPeriod

      public UnivariateChangePointDetectionOptions setPeriod(Integer period)
      Set the period property: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.
      Parameters:
      period - the period value to set.
      Returns:
      the UnivariateChangePointDetectionOptions object itself.

    • getStableTrendWindow

      public Integer getStableTrendWindow()
      Get the stableTrendWindow property: Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection.
      Returns:
      the stableTrendWindow value.

    • setStableTrendWindow

      public UnivariateChangePointDetectionOptions setStableTrendWindow(Integer stableTrendWindow)
      Set the stableTrendWindow property: Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection.
      Parameters:
      stableTrendWindow - the stableTrendWindow value to set.
      Returns:
      the UnivariateChangePointDetectionOptions object itself.

    • getThreshold

      public Double getThreshold()
      Get the threshold property: Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted.
      Returns:
      the threshold value.

    • setThreshold

      public UnivariateChangePointDetectionOptions setThreshold(Double threshold)
      Set the threshold property: Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted.
      Parameters:
      threshold - the threshold value to set.
      Returns:
      the UnivariateChangePointDetectionOptions object itself.