ChangePointDetectRequest Class

The request of change point detection.

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

Inheritance

Model

ChangePointDetectRequest

Constructor

ChangePointDetectRequest(*, series: List[azure.ai.anomalydetector.models._models_py3.TimeSeriesPoint], granularity: Union[str, azure.ai.anomalydetector.models._anomaly_detector_client_enums.TimeGranularity], custom_interval: Optional[int] = None, period: Optional[int] = None, stable_trend_window: Optional[int] = None, threshold: Optional[float] = None, **kwargs)

Variables

series

list[TimeSeriesPoint]

Required. Time series data points. Points should be sorted by timestamp in ascending order to match the change point detection result.

granularity

str or TimeGranularity

Required. Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid. Possible values include: "yearly", "monthly", "weekly", "daily", "hourly", "minutely", "secondly", "microsecond", "none".

custom_interval

int

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}.

period

int

Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.

stable_trend_window

int

Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection.

threshold

float

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.