Skip to content

Commit f208d60

Browse files
authored
Merge pull request #177284 from ChenCheng368/patch-1
Add detector's module API argument descriptions
2 parents 3cb41ee + 6a0cd91 commit f208d60

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

articles/cognitive-services/Anomaly-Detector/includes/quickstarts/anomaly-detector-client-library-python.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,14 @@ Create a `DetectRequest` object with your time series, and the `TimeGranularity`
113113
request = DetectRequest(series=series, granularity=TimeGranularity.daily)
114114
```
115115

116+
Input argument descriptions:
117+
'series': required in request. must be array/list type, and have more than 12 points and no more than 8640 points. must sorted by timestamp in ascending order and cannot have duplicated timestamp.
118+
'granularity': required in request. can only be one of the following: ['daily', 'minutely', 'hourly', 'weekly', 'monthly', 'yearly', 'secondly'].
119+
'customInterval': must be an integer > 0.
120+
'period': must be an integer >= 0.
121+
'maxAnomalyRatio': must be less than 50% of the series points (0 < maxAnomalyRatio < 0.5).
122+
'sensitivity': must be an integer between 0 and 99.
123+
116124
## Detect anomalies in the entire data set
117125

118126
Call the API to detect anomalies through the entire time series data using the client's `detect_entire_series` method. Store the returned [EntireDetectResponse](/python/api/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.entiredetectresponse) object. Iterate through the response's `is_anomaly` list, and print the index of any `true` values. These values correspond to the index of anomalous data points, if any were found.

0 commit comments

Comments
 (0)