@azure-rest/ai-anomaly-detector 1.0.0-beta.1 → 1.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/LICENSE +4 -4
  3. package/README.md +272 -17
  4. package/dist/browser/anomalyDetectorRest.d.ts +13 -0
  5. package/dist/browser/anomalyDetectorRest.d.ts.map +1 -0
  6. package/{dist-esm/src → dist/browser}/anomalyDetectorRest.js +13 -8
  7. package/dist/browser/anomalyDetectorRest.js.map +1 -0
  8. package/dist/browser/clientDefinitions.d.ts +95 -0
  9. package/dist/browser/clientDefinitions.d.ts.map +1 -0
  10. package/dist/browser/clientDefinitions.js +4 -0
  11. package/dist/browser/clientDefinitions.js.map +1 -0
  12. package/dist/browser/index.d.ts +11 -0
  13. package/dist/browser/index.d.ts.map +1 -0
  14. package/dist/browser/index.js +13 -0
  15. package/dist/browser/index.js.map +1 -0
  16. package/dist/browser/isUnexpected.d.ts +12 -0
  17. package/dist/browser/isUnexpected.d.ts.map +1 -0
  18. package/{dist-esm/src → dist/browser}/isUnexpected.js +5 -6
  19. package/dist/browser/isUnexpected.js.map +1 -0
  20. package/dist/browser/models.d.ts +252 -0
  21. package/dist/browser/models.d.ts.map +1 -0
  22. package/dist/browser/models.js +4 -0
  23. package/{dist-esm/src → dist/browser}/models.js.map +1 -1
  24. package/dist/browser/outputModels.d.ts +367 -0
  25. package/dist/browser/outputModels.d.ts.map +1 -0
  26. package/dist/browser/outputModels.js +4 -0
  27. package/{dist-esm/src → dist/browser}/outputModels.js.map +1 -1
  28. package/dist/browser/package.json +3 -0
  29. package/dist/browser/paginateHelper.d.ts +47 -0
  30. package/dist/browser/paginateHelper.d.ts.map +1 -0
  31. package/{dist-esm/src → dist/browser}/paginateHelper.js +2 -2
  32. package/dist/browser/paginateHelper.js.map +1 -0
  33. package/dist/browser/parameters.d.ts +46 -0
  34. package/dist/browser/parameters.d.ts.map +1 -0
  35. package/dist/browser/parameters.js +4 -0
  36. package/dist/browser/parameters.js.map +1 -0
  37. package/dist/browser/responses.d.ts +155 -0
  38. package/dist/browser/responses.d.ts.map +1 -0
  39. package/dist/browser/responses.js +4 -0
  40. package/dist/browser/responses.js.map +1 -0
  41. package/dist/commonjs/anomalyDetectorRest.d.ts +13 -0
  42. package/dist/commonjs/anomalyDetectorRest.d.ts.map +1 -0
  43. package/dist/commonjs/anomalyDetectorRest.js +34 -0
  44. package/dist/commonjs/anomalyDetectorRest.js.map +1 -0
  45. package/dist/commonjs/clientDefinitions.d.ts +95 -0
  46. package/dist/commonjs/clientDefinitions.d.ts.map +1 -0
  47. package/dist/commonjs/clientDefinitions.js +5 -0
  48. package/dist/commonjs/clientDefinitions.js.map +1 -0
  49. package/dist/commonjs/index.d.ts +11 -0
  50. package/dist/commonjs/index.d.ts.map +1 -0
  51. package/dist/commonjs/index.js +16 -0
  52. package/dist/commonjs/index.js.map +1 -0
  53. package/dist/commonjs/isUnexpected.d.ts +12 -0
  54. package/dist/commonjs/isUnexpected.d.ts.map +1 -0
  55. package/dist/commonjs/isUnexpected.js +81 -0
  56. package/dist/commonjs/isUnexpected.js.map +1 -0
  57. package/dist/commonjs/models.d.ts +252 -0
  58. package/dist/commonjs/models.d.ts.map +1 -0
  59. package/dist/commonjs/models.js +5 -0
  60. package/dist/commonjs/models.js.map +1 -0
  61. package/dist/commonjs/outputModels.d.ts +367 -0
  62. package/dist/commonjs/outputModels.d.ts.map +1 -0
  63. package/dist/commonjs/outputModels.js +5 -0
  64. package/dist/commonjs/outputModels.js.map +1 -0
  65. package/dist/commonjs/package.json +3 -0
  66. package/dist/commonjs/paginateHelper.d.ts +47 -0
  67. package/dist/commonjs/paginateHelper.d.ts.map +1 -0
  68. package/dist/commonjs/paginateHelper.js +106 -0
  69. package/dist/commonjs/paginateHelper.js.map +1 -0
  70. package/dist/commonjs/parameters.d.ts +46 -0
  71. package/dist/commonjs/parameters.d.ts.map +1 -0
  72. package/dist/commonjs/parameters.js +5 -0
  73. package/dist/commonjs/parameters.js.map +1 -0
  74. package/dist/commonjs/responses.d.ts +155 -0
  75. package/dist/commonjs/responses.d.ts.map +1 -0
  76. package/dist/commonjs/responses.js +5 -0
  77. package/dist/commonjs/responses.js.map +1 -0
  78. package/dist/commonjs/tsdoc-metadata.json +11 -0
  79. package/dist/esm/anomalyDetectorRest.d.ts +13 -0
  80. package/dist/esm/anomalyDetectorRest.d.ts.map +1 -0
  81. package/dist/esm/anomalyDetectorRest.js +31 -0
  82. package/dist/esm/anomalyDetectorRest.js.map +1 -0
  83. package/dist/esm/clientDefinitions.d.ts +95 -0
  84. package/dist/esm/clientDefinitions.d.ts.map +1 -0
  85. package/dist/esm/clientDefinitions.js +4 -0
  86. package/dist/esm/clientDefinitions.js.map +1 -0
  87. package/dist/esm/index.d.ts +11 -0
  88. package/dist/esm/index.d.ts.map +1 -0
  89. package/dist/esm/index.js +13 -0
  90. package/dist/esm/index.js.map +1 -0
  91. package/dist/esm/isUnexpected.d.ts +12 -0
  92. package/dist/esm/isUnexpected.d.ts.map +1 -0
  93. package/dist/esm/isUnexpected.js +78 -0
  94. package/dist/esm/isUnexpected.js.map +1 -0
  95. package/dist/esm/models.d.ts +252 -0
  96. package/dist/esm/models.d.ts.map +1 -0
  97. package/dist/esm/models.js +4 -0
  98. package/dist/esm/models.js.map +1 -0
  99. package/dist/esm/outputModels.d.ts +367 -0
  100. package/dist/esm/outputModels.d.ts.map +1 -0
  101. package/dist/esm/outputModels.js +4 -0
  102. package/dist/esm/outputModels.js.map +1 -0
  103. package/dist/esm/package.json +3 -0
  104. package/dist/esm/paginateHelper.d.ts +47 -0
  105. package/dist/esm/paginateHelper.d.ts.map +1 -0
  106. package/dist/esm/paginateHelper.js +103 -0
  107. package/dist/esm/paginateHelper.js.map +1 -0
  108. package/dist/esm/parameters.d.ts +46 -0
  109. package/dist/esm/parameters.d.ts.map +1 -0
  110. package/dist/esm/parameters.js +4 -0
  111. package/dist/esm/parameters.js.map +1 -0
  112. package/dist/esm/responses.d.ts +155 -0
  113. package/dist/esm/responses.d.ts.map +1 -0
  114. package/dist/esm/responses.js +4 -0
  115. package/dist/esm/responses.js.map +1 -0
  116. package/dist/react-native/anomalyDetectorRest.d.ts +13 -0
  117. package/dist/react-native/anomalyDetectorRest.d.ts.map +1 -0
  118. package/dist/react-native/anomalyDetectorRest.js +31 -0
  119. package/dist/react-native/anomalyDetectorRest.js.map +1 -0
  120. package/dist/react-native/clientDefinitions.d.ts +95 -0
  121. package/dist/react-native/clientDefinitions.d.ts.map +1 -0
  122. package/dist/react-native/clientDefinitions.js +4 -0
  123. package/dist/react-native/clientDefinitions.js.map +1 -0
  124. package/dist/react-native/index.d.ts +11 -0
  125. package/dist/react-native/index.d.ts.map +1 -0
  126. package/dist/react-native/index.js +13 -0
  127. package/dist/react-native/index.js.map +1 -0
  128. package/dist/react-native/isUnexpected.d.ts +12 -0
  129. package/dist/react-native/isUnexpected.d.ts.map +1 -0
  130. package/dist/react-native/isUnexpected.js +78 -0
  131. package/dist/react-native/isUnexpected.js.map +1 -0
  132. package/dist/react-native/models.d.ts +252 -0
  133. package/dist/react-native/models.d.ts.map +1 -0
  134. package/dist/react-native/models.js +4 -0
  135. package/dist/react-native/models.js.map +1 -0
  136. package/dist/react-native/outputModels.d.ts +367 -0
  137. package/dist/react-native/outputModels.d.ts.map +1 -0
  138. package/dist/react-native/outputModels.js +4 -0
  139. package/dist/react-native/outputModels.js.map +1 -0
  140. package/dist/react-native/package.json +3 -0
  141. package/dist/react-native/paginateHelper.d.ts +47 -0
  142. package/dist/react-native/paginateHelper.d.ts.map +1 -0
  143. package/dist/react-native/paginateHelper.js +103 -0
  144. package/dist/react-native/paginateHelper.js.map +1 -0
  145. package/dist/react-native/parameters.d.ts +46 -0
  146. package/dist/react-native/parameters.d.ts.map +1 -0
  147. package/dist/react-native/parameters.js +4 -0
  148. package/dist/react-native/parameters.js.map +1 -0
  149. package/dist/react-native/responses.d.ts +155 -0
  150. package/dist/react-native/responses.d.ts.map +1 -0
  151. package/dist/react-native/responses.js +4 -0
  152. package/dist/react-native/responses.js.map +1 -0
  153. package/package.json +86 -80
  154. package/review/{ai-anomaly-detector.api.md → ai-anomaly-detector-node.api.md} +9 -9
  155. package/dist/index.js +0 -216
  156. package/dist/index.js.map +0 -1
  157. package/dist-esm/src/anomalyDetectorRest.js.map +0 -1
  158. package/dist-esm/src/clientDefinitions.js +0 -4
  159. package/dist-esm/src/clientDefinitions.js.map +0 -1
  160. package/dist-esm/src/index.js +0 -13
  161. package/dist-esm/src/index.js.map +0 -1
  162. package/dist-esm/src/isUnexpected.js.map +0 -1
  163. package/dist-esm/src/models.js +0 -4
  164. package/dist-esm/src/outputModels.js +0 -4
  165. package/dist-esm/src/paginateHelper.js.map +0 -1
  166. package/dist-esm/src/parameters.js +0 -4
  167. package/dist-esm/src/parameters.js.map +0 -1
  168. package/dist-esm/src/responses.js +0 -4
  169. package/dist-esm/src/responses.js.map +0 -1
  170. package/types/ai-anomaly-detector.d.ts +0 -1086
@@ -1,1086 +0,0 @@
1
- import { Client } from '@azure-rest/core-client';
2
- import { ClientOptions } from '@azure-rest/core-client';
3
- import { HttpResponse } from '@azure-rest/core-client';
4
- import { KeyCredential } from '@azure/core-auth';
5
- import { PagedAsyncIterableIterator } from '@azure/core-paging';
6
- import { PathUncheckedResponse } from '@azure-rest/core-client';
7
- import { RawHttpHeaders } from '@azure/core-rest-pipeline';
8
- import { RequestParameters } from '@azure-rest/core-client';
9
- import { StreamableMethod } from '@azure-rest/core-client';
10
-
11
- /** An optional field, indicating the manner to align multiple variables. */
12
- export declare interface AlignPolicy {
13
- /**
14
- * An optional field, indicating how to align different variables to the same
15
- * time-range. Either Inner or Outer.
16
- */
17
- alignMode?: "Inner" | "Outer";
18
- /**
19
- * An optional field, indicating how missing values will be filled. One of
20
- * Previous, Subsequent, Linear, Zero, Fixed.
21
- *
22
- * Possible values: Previous, Subsequent, Linear, Zero, Fixed
23
- */
24
- fillNAMethod?: string;
25
- /** An optional field. Required when fillNAMethod is Fixed. */
26
- paddingValue?: number;
27
- }
28
-
29
- /** An optional field, indicating the manner to align multiple variables. */
30
- export declare interface AlignPolicyOutput {
31
- /**
32
- * An optional field, indicating how to align different variables to the same
33
- * time-range. Either Inner or Outer.
34
- */
35
- alignMode?: "Inner" | "Outer";
36
- /**
37
- * An optional field, indicating how missing values will be filled. One of
38
- * Previous, Subsequent, Linear, Zero, Fixed.
39
- *
40
- * Possible values: Previous, Subsequent, Linear, Zero, Fixed
41
- */
42
- fillNAMethod?: string;
43
- /** An optional field. Required when fillNAMethod is Fixed. */
44
- paddingValue?: number;
45
- }
46
-
47
- /** Response of getting a model. */
48
- export declare interface AnomalyDetectionModelOutput {
49
- /** Model identifier. */
50
- modelId: string;
51
- /** Date and time (UTC) when the model was created. */
52
- createdTime: string;
53
- /** Date and time (UTC) when the model was last updated. */
54
- lastUpdatedTime: string;
55
- /**
56
- * Training result of a model including its status, errors and diagnostics
57
- * information.
58
- */
59
- modelInfo?: ModelInfoOutput;
60
- }
61
-
62
- /** Error information returned by the API. */
63
- export declare interface AnomalyDetectorErrorOutput {
64
- /**
65
- * The error code.
66
- *
67
- * Possible values: InvalidCustomInterval, BadArgument, InvalidGranularity, InvalidPeriod, InvalidModelArgument, InvalidSeries, InvalidJsonFormat, RequiredGranularity, RequiredSeries, InvalidImputeMode, InvalidImputeFixedValue
68
- */
69
- code?: string;
70
- /** A message explaining the error reported by the service. */
71
- message?: string;
72
- }
73
-
74
- export declare type AnomalyDetectorRestClient = Client & {
75
- path: Routes;
76
- };
77
-
78
- export declare interface AnomalyDetectorRestClientOptions extends ClientOptions {
79
- ApiVersion?: string;
80
- }
81
-
82
- /** Interpretation of the anomalous timestamp. */
83
- export declare interface AnomalyInterpretationOutput {
84
- /** Variable. */
85
- variable?: string;
86
- /**
87
- * This score shows the percentage contributing to the anomalous timestamp. A
88
- * number between 0 and 1.
89
- */
90
- contributionScore?: number;
91
- /** Correlation changes among the anomalous variables */
92
- correlationChanges?: CorrelationChangesOutput;
93
- }
94
-
95
- /** Anomaly status and information. */
96
- export declare interface AnomalyStateOutput {
97
- /** The timestamp for this anomaly. */
98
- timestamp: string;
99
- /** The detailed value of this anomalous timestamp. */
100
- value?: AnomalyValueOutput;
101
- /** Error message for the current timestamp. */
102
- errors?: Array<ErrorResponseOutput>;
103
- }
104
-
105
- /** Detailed information of the anomalous timestamp. */
106
- export declare interface AnomalyValueOutput {
107
- /** True if an anomaly is detected at the current timestamp. */
108
- isAnomaly: boolean;
109
- /**
110
- * Indicates the significance of the anomaly. The higher the severity, the more
111
- * significant the anomaly is.
112
- */
113
- severity: number;
114
- /**
115
- * Raw anomaly score of severity, will help indicate the degree of abnormality as
116
- * well.
117
- */
118
- score: number;
119
- /** Interpretation of this anomalous timestamp. */
120
- interpretation?: Array<AnomalyInterpretationOutput>;
121
- }
122
-
123
- /** Correlation changes among the anomalous variables */
124
- export declare interface CorrelationChangesOutput {
125
- /** The correlated variables that have correlation changes under an anomaly. */
126
- changedVariables?: string[];
127
- }
128
-
129
- /**
130
- * Initialize a new instance of the class AnomalyDetectorRestClient class.
131
- * @param Endpoint type: string
132
- * @param credentials type: KeyCredential
133
- */
134
- declare function createClient(Endpoint: string, credentials: KeyCredential, options?: AnomalyDetectorRestClientOptions): AnomalyDetectorRestClient;
135
- export default createClient;
136
-
137
- export declare interface DeleteMultivariateModel {
138
- /** Delete an existing multivariate model according to the modelId */
139
- delete(options?: DeleteMultivariateModelParameters): StreamableMethod<DeleteMultivariateModel204Response | DeleteMultivariateModelDefaultResponse>;
140
- /**
141
- * Get detailed information of multivariate model, including the training status
142
- * and variables used in the model.
143
- */
144
- get(options?: GetMultivariateModelParameters): StreamableMethod<GetMultivariateModel200Response | GetMultivariateModelDefaultResponse>;
145
- }
146
-
147
- /** There is no content to send for this request, but the headers may be useful. */
148
- export declare interface DeleteMultivariateModel204Response extends HttpResponse {
149
- status: "204";
150
- }
151
-
152
- export declare interface DeleteMultivariateModelDefaultHeaders {
153
- /** Error code. */
154
- "x-ms-error-code"?: string;
155
- }
156
-
157
- export declare interface DeleteMultivariateModelDefaultResponse extends HttpResponse {
158
- status: string;
159
- body: ErrorResponseOutput;
160
- headers: RawHttpHeaders & DeleteMultivariateModelDefaultHeaders;
161
- }
162
-
163
- export declare type DeleteMultivariateModelParameters = RequestParameters;
164
-
165
- export declare interface DetectMultivariateBatchAnomaly {
166
- /**
167
- * Submit multivariate anomaly detection task with the modelId of trained model
168
- * and inference data, the input schema should be the same with the training
169
- * request. The request will complete asynchronously and return a resultId to
170
- * query the detection result.The request should be a source link to indicate an
171
- * externally accessible Azure storage Uri, either pointed to an Azure blob
172
- * storage folder, or pointed to a CSV file in Azure blob storage.
173
- */
174
- post(options: DetectMultivariateBatchAnomalyParameters): StreamableMethod<DetectMultivariateBatchAnomaly202Response | DetectMultivariateBatchAnomalyDefaultResponse>;
175
- }
176
-
177
- export declare interface DetectMultivariateBatchAnomaly202Headers {
178
- /** Id of the detection result. */
179
- "operation-id": string;
180
- /** Location of the detection result. */
181
- "operation-location": string;
182
- }
183
-
184
- /** The request has been accepted for processing, but processing has not yet completed. */
185
- export declare interface DetectMultivariateBatchAnomaly202Response extends HttpResponse {
186
- status: "202";
187
- body: MultivariateDetectionResultOutput;
188
- headers: RawHttpHeaders & DetectMultivariateBatchAnomaly202Headers;
189
- }
190
-
191
- export declare interface DetectMultivariateBatchAnomalyBodyParam {
192
- /** Request of multivariate anomaly detection. */
193
- body: MultivariateBatchDetectionOptions;
194
- }
195
-
196
- export declare interface DetectMultivariateBatchAnomalyDefaultHeaders {
197
- /** Error code. */
198
- "x-ms-error-code"?: string;
199
- }
200
-
201
- export declare interface DetectMultivariateBatchAnomalyDefaultResponse extends HttpResponse {
202
- status: string;
203
- body: ErrorResponseOutput;
204
- headers: RawHttpHeaders & DetectMultivariateBatchAnomalyDefaultHeaders;
205
- }
206
-
207
- export declare type DetectMultivariateBatchAnomalyParameters = DetectMultivariateBatchAnomalyBodyParam & RequestParameters;
208
-
209
- export declare interface DetectMultivariateLastAnomaly {
210
- /**
211
- * Submit multivariate anomaly detection task with the modelId of trained model
212
- * and inference data, and the inference data should be put into request body in a
213
- * JSON format. The request will complete synchronously and return the detection
214
- * immediately in the response body.
215
- */
216
- post(options: DetectMultivariateLastAnomalyParameters): StreamableMethod<DetectMultivariateLastAnomaly200Response | DetectMultivariateLastAnomalyDefaultResponse>;
217
- }
218
-
219
- /** The request has succeeded. */
220
- export declare interface DetectMultivariateLastAnomaly200Response extends HttpResponse {
221
- status: "200";
222
- body: MultivariateLastDetectionResultOutput;
223
- }
224
-
225
- export declare interface DetectMultivariateLastAnomalyBodyParam {
226
- /** Request of last detection. */
227
- body: MultivariateLastDetectionOptions;
228
- }
229
-
230
- export declare interface DetectMultivariateLastAnomalyDefaultHeaders {
231
- /** Error code. */
232
- "x-ms-error-code"?: string;
233
- }
234
-
235
- export declare interface DetectMultivariateLastAnomalyDefaultResponse extends HttpResponse {
236
- status: string;
237
- body: ErrorResponseOutput;
238
- headers: RawHttpHeaders & DetectMultivariateLastAnomalyDefaultHeaders;
239
- }
240
-
241
- export declare type DetectMultivariateLastAnomalyParameters = DetectMultivariateLastAnomalyBodyParam & RequestParameters;
242
-
243
- export declare interface DetectUnivariateChangePoint {
244
- /** Evaluate change point score of every series point */
245
- post(options: DetectUnivariateChangePointParameters): StreamableMethod<DetectUnivariateChangePoint200Response | DetectUnivariateChangePointDefaultResponse>;
246
- }
247
-
248
- /** The request has succeeded. */
249
- export declare interface DetectUnivariateChangePoint200Response extends HttpResponse {
250
- status: "200";
251
- body: UnivariateChangePointDetectionResultOutput;
252
- }
253
-
254
- export declare interface DetectUnivariateChangePointBodyParam {
255
- /** Method of univariate anomaly detection. */
256
- body: UnivariateChangePointDetectionOptions;
257
- }
258
-
259
- export declare interface DetectUnivariateChangePointDefaultHeaders {
260
- /** Error code. */
261
- "x-ms-error-code"?: string;
262
- }
263
-
264
- export declare interface DetectUnivariateChangePointDefaultResponse extends HttpResponse {
265
- status: string;
266
- body: AnomalyDetectorErrorOutput;
267
- headers: RawHttpHeaders & DetectUnivariateChangePointDefaultHeaders;
268
- }
269
-
270
- export declare type DetectUnivariateChangePointParameters = DetectUnivariateChangePointBodyParam & RequestParameters;
271
-
272
- export declare interface DetectUnivariateEntireSeries {
273
- /**
274
- * This operation generates a model with an entire series, each point is detected
275
- * with the same model. With this method, points before and after a certain point
276
- * are used to determine whether it is an anomaly. The entire detection can give
277
- * user an overall status of the time series.
278
- */
279
- post(options: DetectUnivariateEntireSeriesParameters): StreamableMethod<DetectUnivariateEntireSeries200Response | DetectUnivariateEntireSeriesDefaultResponse>;
280
- }
281
-
282
- /** The request has succeeded. */
283
- export declare interface DetectUnivariateEntireSeries200Response extends HttpResponse {
284
- status: "200";
285
- body: UnivariateEntireDetectionResultOutput;
286
- }
287
-
288
- export declare interface DetectUnivariateEntireSeriesBodyParam {
289
- /** Method of univariate anomaly detection. */
290
- body: UnivariateDetectionOptions;
291
- }
292
-
293
- export declare interface DetectUnivariateEntireSeriesDefaultHeaders {
294
- /** Error code. */
295
- "x-ms-error-code"?: string;
296
- }
297
-
298
- export declare interface DetectUnivariateEntireSeriesDefaultResponse extends HttpResponse {
299
- status: string;
300
- body: AnomalyDetectorErrorOutput;
301
- headers: RawHttpHeaders & DetectUnivariateEntireSeriesDefaultHeaders;
302
- }
303
-
304
- export declare type DetectUnivariateEntireSeriesParameters = DetectUnivariateEntireSeriesBodyParam & RequestParameters;
305
-
306
- export declare interface DetectUnivariateLastPoint {
307
- /**
308
- * This operation generates a model using the points that you sent into the API,
309
- * and based on all data to determine whether the last point is anomalous.
310
- */
311
- post(options: DetectUnivariateLastPointParameters): StreamableMethod<DetectUnivariateLastPoint200Response | DetectUnivariateLastPointDefaultResponse>;
312
- }
313
-
314
- /** The request has succeeded. */
315
- export declare interface DetectUnivariateLastPoint200Response extends HttpResponse {
316
- status: "200";
317
- body: UnivariateLastDetectionResultOutput;
318
- }
319
-
320
- export declare interface DetectUnivariateLastPointBodyParam {
321
- /** Method of univariate anomaly detection. */
322
- body: UnivariateDetectionOptions;
323
- }
324
-
325
- export declare interface DetectUnivariateLastPointDefaultHeaders {
326
- /** Error code. */
327
- "x-ms-error-code"?: string;
328
- }
329
-
330
- export declare interface DetectUnivariateLastPointDefaultResponse extends HttpResponse {
331
- status: string;
332
- body: AnomalyDetectorErrorOutput;
333
- headers: RawHttpHeaders & DetectUnivariateLastPointDefaultHeaders;
334
- }
335
-
336
- export declare type DetectUnivariateLastPointParameters = DetectUnivariateLastPointBodyParam & RequestParameters;
337
-
338
- /** Diagnostics information to help inspect the states of model or variable. */
339
- export declare interface DiagnosticsInfo {
340
- /** Model status. */
341
- modelState?: ModelState;
342
- /** Variable Status. */
343
- variableStates?: Array<VariableState>;
344
- }
345
-
346
- /** Diagnostics information to help inspect the states of model or variable. */
347
- export declare interface DiagnosticsInfoOutput {
348
- /** Model status. */
349
- modelState?: ModelStateOutput;
350
- /** Variable Status. */
351
- variableStates?: Array<VariableStateOutput>;
352
- }
353
-
354
- /** ErrorResponse contains code and message that shows the error information. */
355
- export declare interface ErrorResponse {
356
- /** The error code. */
357
- code: string;
358
- /** The message explaining the error reported by the service. */
359
- message: string;
360
- }
361
-
362
- /** ErrorResponse contains code and message that shows the error information. */
363
- export declare interface ErrorResponseOutput {
364
- /** The error code. */
365
- code: string;
366
- /** The message explaining the error reported by the service. */
367
- message: string;
368
- }
369
-
370
- /**
371
- * Helper type to extract the type of an array
372
- */
373
- export declare type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
374
-
375
- export declare interface GetMultivariateBatchDetectionResult {
376
- /**
377
- * For asynchronous inference, get multivariate anomaly detection result based on
378
- * resultId returned by the BatchDetectAnomaly api.
379
- */
380
- get(options?: GetMultivariateBatchDetectionResultParameters): StreamableMethod<GetMultivariateBatchDetectionResult200Response | GetMultivariateBatchDetectionResultDefaultResponse>;
381
- }
382
-
383
- /** The request has succeeded. */
384
- export declare interface GetMultivariateBatchDetectionResult200Response extends HttpResponse {
385
- status: "200";
386
- body: MultivariateDetectionResultOutput;
387
- }
388
-
389
- export declare interface GetMultivariateBatchDetectionResultDefaultHeaders {
390
- /** Error code. */
391
- "x-ms-error-code"?: string;
392
- }
393
-
394
- export declare interface GetMultivariateBatchDetectionResultDefaultResponse extends HttpResponse {
395
- status: string;
396
- body: ErrorResponseOutput;
397
- headers: RawHttpHeaders & GetMultivariateBatchDetectionResultDefaultHeaders;
398
- }
399
-
400
- export declare type GetMultivariateBatchDetectionResultParameters = RequestParameters;
401
-
402
- /** The request has succeeded. */
403
- export declare interface GetMultivariateModel200Response extends HttpResponse {
404
- status: "200";
405
- body: AnomalyDetectionModelOutput;
406
- }
407
-
408
- export declare interface GetMultivariateModelDefaultHeaders {
409
- /** Error code. */
410
- "x-ms-error-code"?: string;
411
- }
412
-
413
- export declare interface GetMultivariateModelDefaultResponse extends HttpResponse {
414
- status: string;
415
- body: ErrorResponseOutput;
416
- headers: RawHttpHeaders & GetMultivariateModelDefaultHeaders;
417
- }
418
-
419
- export declare type GetMultivariateModelParameters = RequestParameters;
420
-
421
- /**
422
- * The type of a custom function that defines how to get a page and a link to the next one if any.
423
- */
424
- export declare type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
425
- page: TPage;
426
- nextPageLink?: string;
427
- }>;
428
-
429
- export declare function isUnexpected(response: DetectUnivariateEntireSeries200Response | DetectUnivariateEntireSeriesDefaultResponse): response is DetectUnivariateEntireSeriesDefaultResponse;
430
-
431
- export declare function isUnexpected(response: DetectUnivariateLastPoint200Response | DetectUnivariateLastPointDefaultResponse): response is DetectUnivariateLastPointDefaultResponse;
432
-
433
- export declare function isUnexpected(response: DetectUnivariateChangePoint200Response | DetectUnivariateChangePointDefaultResponse): response is DetectUnivariateChangePointDefaultResponse;
434
-
435
- export declare function isUnexpected(response: GetMultivariateBatchDetectionResult200Response | GetMultivariateBatchDetectionResultDefaultResponse): response is GetMultivariateBatchDetectionResultDefaultResponse;
436
-
437
- export declare function isUnexpected(response: TrainMultivariateModel201Response | TrainMultivariateModelDefaultResponse): response is TrainMultivariateModelDefaultResponse;
438
-
439
- export declare function isUnexpected(response: ListMultivariateModels200Response | ListMultivariateModelsDefaultResponse): response is ListMultivariateModelsDefaultResponse;
440
-
441
- export declare function isUnexpected(response: DeleteMultivariateModel204Response | DeleteMultivariateModelDefaultResponse): response is DeleteMultivariateModelDefaultResponse;
442
-
443
- export declare function isUnexpected(response: GetMultivariateModel200Response | GetMultivariateModelDefaultResponse): response is GetMultivariateModelDefaultResponse;
444
-
445
- export declare function isUnexpected(response: DetectMultivariateBatchAnomaly202Response | DetectMultivariateBatchAnomalyDefaultResponse): response is DetectMultivariateBatchAnomalyDefaultResponse;
446
-
447
- export declare function isUnexpected(response: DetectMultivariateLastAnomaly200Response | DetectMultivariateLastAnomalyDefaultResponse): response is DetectMultivariateLastAnomalyDefaultResponse;
448
-
449
- /** The request has succeeded. */
450
- export declare interface ListMultivariateModels200Response extends HttpResponse {
451
- status: "200";
452
- body: ModelListOutput;
453
- }
454
-
455
- export declare interface ListMultivariateModelsDefaultHeaders {
456
- /** Error code. */
457
- "x-ms-error-code"?: string;
458
- }
459
-
460
- export declare interface ListMultivariateModelsDefaultResponse extends HttpResponse {
461
- status: string;
462
- body: ErrorResponseOutput;
463
- headers: RawHttpHeaders & ListMultivariateModelsDefaultHeaders;
464
- }
465
-
466
- export declare type ListMultivariateModelsParameters = ListMultivariateModelsQueryParam & RequestParameters;
467
-
468
- export declare interface ListMultivariateModelsQueryParam {
469
- queryParameters?: ListMultivariateModelsQueryParamProperties;
470
- }
471
-
472
- export declare interface ListMultivariateModelsQueryParamProperties {
473
- /** Skip indicates how many models will be skipped. */
474
- skip?: number;
475
- /** Top indicates how many models will be fetched. */
476
- top?: number;
477
- }
478
-
479
- /**
480
- * Training result of a model including its status, errors and diagnostics
481
- * information.
482
- */
483
- export declare interface ModelInfo {
484
- /**
485
- * Source link to the input data to indicate an accessible Azure storage Uri,
486
- * either pointed to an Azure blob storage folder, or pointed to a CSV file in
487
- * Azure blob storage based on you data schema selection.
488
- */
489
- dataSource: string;
490
- /**
491
- * Data schema of input data source: OneTable or MultiTable. The default
492
- * DataSchema is OneTable.
493
- *
494
- * Possible values: OneTable, MultiTable
495
- */
496
- dataSchema?: string;
497
- /**
498
- * A required field, indicating the start time of training data, which should be
499
- * date-time of ISO 8601 format.
500
- */
501
- startTime: Date | string;
502
- /**
503
- * A required field, indicating the end time of training data, which should be
504
- * date-time of ISO 8601 format.
505
- */
506
- endTime: Date | string;
507
- /**
508
- * An optional field. The display name of the model whose maximum length is 24
509
- * characters.
510
- */
511
- displayName?: string;
512
- /**
513
- * An optional field, indicating how many previous timestamps will be used to
514
- * detect whether the timestamp is anomaly or not.
515
- */
516
- slidingWindow?: number;
517
- /** An optional field, indicating the manner to align multiple variables. */
518
- alignPolicy?: AlignPolicy;
519
- /** Model status. One of CREATED, RUNNING, READY, and FAILED. */
520
- status?: "CREATED" | "RUNNING" | "READY" | "FAILED";
521
- /** Diagnostics information to help inspect the states of model or variable. */
522
- diagnosticsInfo?: DiagnosticsInfo;
523
- }
524
-
525
- /**
526
- * Training result of a model including its status, errors and diagnostics
527
- * information.
528
- */
529
- export declare interface ModelInfoOutput {
530
- /**
531
- * Source link to the input data to indicate an accessible Azure storage Uri,
532
- * either pointed to an Azure blob storage folder, or pointed to a CSV file in
533
- * Azure blob storage based on you data schema selection.
534
- */
535
- dataSource: string;
536
- /**
537
- * Data schema of input data source: OneTable or MultiTable. The default
538
- * DataSchema is OneTable.
539
- *
540
- * Possible values: OneTable, MultiTable
541
- */
542
- dataSchema?: string;
543
- /**
544
- * A required field, indicating the start time of training data, which should be
545
- * date-time of ISO 8601 format.
546
- */
547
- startTime: string;
548
- /**
549
- * A required field, indicating the end time of training data, which should be
550
- * date-time of ISO 8601 format.
551
- */
552
- endTime: string;
553
- /**
554
- * An optional field. The display name of the model whose maximum length is 24
555
- * characters.
556
- */
557
- displayName?: string;
558
- /**
559
- * An optional field, indicating how many previous timestamps will be used to
560
- * detect whether the timestamp is anomaly or not.
561
- */
562
- slidingWindow?: number;
563
- /** An optional field, indicating the manner to align multiple variables. */
564
- alignPolicy?: AlignPolicyOutput;
565
- /** Model status. One of CREATED, RUNNING, READY, and FAILED. */
566
- status?: "CREATED" | "RUNNING" | "READY" | "FAILED";
567
- /** Error messages when failed to create a model. */
568
- readonly errors?: Array<ErrorResponseOutput>;
569
- /** Diagnostics information to help inspect the states of model or variable. */
570
- diagnosticsInfo?: DiagnosticsInfoOutput;
571
- }
572
-
573
- /** Response of listing models. */
574
- export declare interface ModelListOutput {
575
- /** List of models. */
576
- models: Array<AnomalyDetectionModelOutput>;
577
- /** Number of trained multivariate models. */
578
- currentCount: number;
579
- /** Maximum number of models that can be trained for this Anomaly Detector resource. */
580
- maxCount: number;
581
- /** The link to fetch more models. */
582
- nextLink?: string;
583
- }
584
-
585
- /** Model status. */
586
- export declare interface ModelState {
587
- /**
588
- * This indicates the number of passes of the entire training dataset the
589
- * algorithm has completed.
590
- */
591
- epochIds?: number[];
592
- /**
593
- * List of metrics used to assess how the model fits the training data for each
594
- * epoch.
595
- */
596
- trainLosses?: number[];
597
- /**
598
- * List of metrics used to assess how the model fits the validation set for each
599
- * epoch.
600
- */
601
- validationLosses?: number[];
602
- /** Latency for each epoch. */
603
- latenciesInSeconds?: number[];
604
- }
605
-
606
- /** Model status. */
607
- export declare interface ModelStateOutput {
608
- /**
609
- * This indicates the number of passes of the entire training dataset the
610
- * algorithm has completed.
611
- */
612
- epochIds?: number[];
613
- /**
614
- * List of metrics used to assess how the model fits the training data for each
615
- * epoch.
616
- */
617
- trainLosses?: number[];
618
- /**
619
- * List of metrics used to assess how the model fits the validation set for each
620
- * epoch.
621
- */
622
- validationLosses?: number[];
623
- /** Latency for each epoch. */
624
- latenciesInSeconds?: number[];
625
- }
626
-
627
- /**
628
- * Detection request for batch inference. This is an asynchronous inference which
629
- * will need another API to get detection results.
630
- */
631
- export declare interface MultivariateBatchDetectionOptions {
632
- /**
633
- * Source link to the input data to indicate an accessible Azure storage Uri,
634
- * either pointed to an Azure blob storage folder, or pointed to a CSV file in
635
- * Azure blob storage based on you data schema selection. The data schema should
636
- * be exactly the same with those used in the training phase.
637
- */
638
- dataSource: string;
639
- /**
640
- * An optional field, which is used to specify the number of top contributed
641
- * variables for one anomalous timestamp in the response. The default number is
642
- * 10.
643
- */
644
- topContributorCount: number;
645
- /**
646
- * A required field, indicating the start time of data for detection, which should
647
- * be date-time of ISO 8601 format.
648
- */
649
- startTime: Date | string;
650
- /**
651
- * A required field, indicating the end time of data for detection, which should
652
- * be date-time of ISO 8601 format.
653
- */
654
- endTime: Date | string;
655
- }
656
-
657
- /**
658
- * Detection request for batch inference. This is an asynchronous inference which
659
- * will need another API to get detection results.
660
- */
661
- export declare interface MultivariateBatchDetectionOptionsOutput {
662
- /**
663
- * Source link to the input data to indicate an accessible Azure storage Uri,
664
- * either pointed to an Azure blob storage folder, or pointed to a CSV file in
665
- * Azure blob storage based on you data schema selection. The data schema should
666
- * be exactly the same with those used in the training phase.
667
- */
668
- dataSource: string;
669
- /**
670
- * An optional field, which is used to specify the number of top contributed
671
- * variables for one anomalous timestamp in the response. The default number is
672
- * 10.
673
- */
674
- topContributorCount: number;
675
- /**
676
- * A required field, indicating the start time of data for detection, which should
677
- * be date-time of ISO 8601 format.
678
- */
679
- startTime: string;
680
- /**
681
- * A required field, indicating the end time of data for detection, which should
682
- * be date-time of ISO 8601 format.
683
- */
684
- endTime: string;
685
- }
686
-
687
- /** Multivariate anomaly detection status. */
688
- export declare interface MultivariateBatchDetectionResultSummaryOutput {
689
- /** Status of detection results. One of CREATED, RUNNING, READY, and FAILED. */
690
- status: "CREATED" | "RUNNING" | "READY" | "FAILED";
691
- /** Error message when detection is failed. */
692
- errors?: Array<ErrorResponseOutput>;
693
- /** Variable Status. */
694
- variableStates?: Array<VariableStateOutput>;
695
- /**
696
- * Detection request for batch inference. This is an asynchronous inference which
697
- * will need another API to get detection results.
698
- */
699
- setupInfo: MultivariateBatchDetectionOptionsOutput;
700
- }
701
-
702
- /** Detection results for the given resultId. */
703
- export declare interface MultivariateDetectionResultOutput {
704
- /** Result identifier, which is used to fetch the results of an inference call. */
705
- resultId: string;
706
- /** Multivariate anomaly detection status. */
707
- summary: MultivariateBatchDetectionResultSummaryOutput;
708
- /** Detection result for each timestamp. */
709
- results: Array<AnomalyStateOutput>;
710
- }
711
-
712
- /** Request of last detection. */
713
- export declare interface MultivariateLastDetectionOptions {
714
- /**
715
- * This contains the inference data, including the name, timestamps(ISO 8601) and
716
- * values of variables.
717
- */
718
- variables: Array<VariableValues>;
719
- /**
720
- * An optional field, which is used to specify the number of top contributed
721
- * variables for one anomalous timestamp in the response. The default number is
722
- * 10.
723
- */
724
- topContributorCount: number;
725
- }
726
-
727
- /** Results of last detection. */
728
- export declare interface MultivariateLastDetectionResultOutput {
729
- /** Variable Status. */
730
- variableStates?: Array<VariableStateOutput>;
731
- /** Anomaly status and information. */
732
- results?: Array<AnomalyStateOutput>;
733
- }
734
-
735
- /**
736
- * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
737
- * @param client - Client to use for sending the next page requests
738
- * @param initialResponse - Initial response containing the nextLink and current page of elements
739
- * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
740
- * @returns - PagedAsyncIterableIterator to iterate the elements
741
- */
742
- export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
743
-
744
- /**
745
- * Helper type to infer the Type of the paged elements from the response type
746
- * This type is generated based on the swagger information for x-ms-pageable
747
- * specifically on the itemName property which indicates the property of the response
748
- * where the page items are found. The default value is `value`.
749
- * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
750
- */
751
- export declare type PaginateReturn<TResult> = TResult extends {
752
- body: {
753
- value?: infer TPage;
754
- };
755
- } | {
756
- body: {
757
- models?: infer TPage;
758
- };
759
- } ? GetArrayType<TPage> : Array<unknown>;
760
-
761
- /**
762
- * Options for the paging helper
763
- */
764
- export declare interface PagingOptions<TResponse> {
765
- /**
766
- * Custom function to extract pagination details for crating the PagedAsyncIterableIterator
767
- */
768
- customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
769
- }
770
-
771
- export declare interface Routes {
772
- /** Resource for '/timeseries/entire/detect' has methods for the following verbs: post */
773
- (path: "/timeseries/entire/detect"): DetectUnivariateEntireSeries;
774
- /** Resource for '/timeseries/last/detect' has methods for the following verbs: post */
775
- (path: "/timeseries/last/detect"): DetectUnivariateLastPoint;
776
- /** Resource for '/timeseries/changepoint/detect' has methods for the following verbs: post */
777
- (path: "/timeseries/changepoint/detect"): DetectUnivariateChangePoint;
778
- /** Resource for '/multivariate/detect-batch/\{resultId\}' has methods for the following verbs: get */
779
- (path: "/multivariate/detect-batch/{resultId}", resultId: string): GetMultivariateBatchDetectionResult;
780
- /** Resource for '/multivariate/models' has methods for the following verbs: post, get */
781
- (path: "/multivariate/models"): TrainMultivariateModel;
782
- /** Resource for '/multivariate/models/\{modelId\}' has methods for the following verbs: delete, get */
783
- (path: "/multivariate/models/{modelId}", modelId: string): DeleteMultivariateModel;
784
- /** Resource for '/multivariate/models/\{modelId\}:detect-batch' has methods for the following verbs: post */
785
- (path: "/multivariate/models/{modelId}:detect-batch", modelId: string): DetectMultivariateBatchAnomaly;
786
- /** Resource for '/multivariate/models/\{modelId\}:detect-last' has methods for the following verbs: post */
787
- (path: "/multivariate/models/{modelId}:detect-last", modelId: string): DetectMultivariateLastAnomaly;
788
- }
789
-
790
- /** The definition of input timeseries points. */
791
- export declare interface TimeSeriesPoint {
792
- /** Optional argument, timestamp of a data point (ISO8601 format). */
793
- timestamp?: Date | string;
794
- /** The measurement of that point, should be float. */
795
- value: number;
796
- }
797
-
798
- export declare interface TrainMultivariateModel {
799
- /**
800
- * Create and train a multivariate anomaly detection model. The request must
801
- * include a source parameter to indicate an externally accessible Azure blob
802
- * storage URI.There are two types of data input: An URI pointed to an Azure blob
803
- * storage folder which contains multiple CSV files, and each CSV file contains
804
- * two columns, timestamp and variable. Another type of input is an URI pointed to
805
- * a CSV file in Azure blob storage, which contains all the variables and a
806
- * timestamp column.
807
- */
808
- post(options: TrainMultivariateModelParameters): StreamableMethod<TrainMultivariateModel201Response | TrainMultivariateModelDefaultResponse>;
809
- /** List models of a resource. */
810
- get(options?: ListMultivariateModelsParameters): StreamableMethod<ListMultivariateModels200Response | ListMultivariateModelsDefaultResponse>;
811
- }
812
-
813
- export declare interface TrainMultivariateModel201Headers {
814
- /** Location and ID of the model. */
815
- location: string;
816
- }
817
-
818
- /** The request has succeeded and a new resource has been created as a result. */
819
- export declare interface TrainMultivariateModel201Response extends HttpResponse {
820
- status: "201";
821
- body: AnomalyDetectionModelOutput;
822
- headers: RawHttpHeaders & TrainMultivariateModel201Headers;
823
- }
824
-
825
- export declare interface TrainMultivariateModelBodyParam {
826
- /** Model information. */
827
- body: ModelInfo;
828
- }
829
-
830
- export declare interface TrainMultivariateModelDefaultHeaders {
831
- /** Error code. */
832
- "x-ms-error-code"?: string;
833
- }
834
-
835
- export declare interface TrainMultivariateModelDefaultResponse extends HttpResponse {
836
- status: string;
837
- body: ErrorResponseOutput;
838
- headers: RawHttpHeaders & TrainMultivariateModelDefaultHeaders;
839
- }
840
-
841
- export declare type TrainMultivariateModelParameters = TrainMultivariateModelBodyParam & RequestParameters;
842
-
843
- /** The request of change point detection. */
844
- export declare interface UnivariateChangePointDetectionOptions {
845
- /**
846
- * Time series data points. Points should be sorted by timestamp in ascending
847
- * order to match the change point detection result.
848
- */
849
- series: Array<TimeSeriesPoint>;
850
- /**
851
- * Can only be one of yearly, monthly, weekly, daily, hourly, minutely or
852
- * secondly. Granularity is used for verify whether input series is valid.
853
- */
854
- granularity: "yearly" | "monthly" | "weekly" | "daily" | "hourly" | "minutely" | "secondly" | "microsecond" | "none";
855
- /**
856
- * Custom Interval is used to set non-standard time interval, for example, if the
857
- * series is 5 minutes, request can be set as {"granularity":"minutely",
858
- * "customInterval":5}.
859
- */
860
- customInterval?: number;
861
- /**
862
- * Optional argument, periodic value of a time series. If the value is null or
863
- * does not present, the API will determine the period automatically.
864
- */
865
- period?: number;
866
- /**
867
- * Optional argument, advanced model parameter, a default stableTrendWindow will
868
- * be used in detection.
869
- */
870
- stableTrendWindow?: number;
871
- /**
872
- * Optional argument, advanced model parameter, between 0.0-1.0, the lower the
873
- * value is, the larger the trend error will be which means less change point will
874
- * be accepted.
875
- */
876
- threshold?: number;
877
- }
878
-
879
- /** The response of change point detection. */
880
- export declare interface UnivariateChangePointDetectionResultOutput {
881
- /**
882
- * Frequency extracted from the series, zero means no recurrent pattern has been
883
- * found.
884
- */
885
- readonly period?: number;
886
- /**
887
- * isChangePoint contains change point properties for each input point. True means
888
- * an anomaly either negative or positive has been detected. The index of the
889
- * array is consistent with the input series.
890
- */
891
- isChangePoint?: boolean[];
892
- /** the change point confidence of each point */
893
- confidenceScores?: number[];
894
- }
895
-
896
- /** The request of entire or last anomaly detection. */
897
- export declare interface UnivariateDetectionOptions {
898
- /**
899
- * Time series data points. Points should be sorted by timestamp in ascending
900
- * order to match the anomaly detection result. If the data is not sorted
901
- * correctly or there is duplicated timestamp, the API will not work. In such
902
- * case, an error message will be returned.
903
- */
904
- series: Array<TimeSeriesPoint>;
905
- /**
906
- * Optional argument, can be one of yearly, monthly, weekly, daily, hourly,
907
- * minutely, secondly, microsecond or none. If granularity is not present, it will
908
- * be none by default. If granularity is none, the timestamp property in time
909
- * series point can be absent.
910
- */
911
- granularity?: "yearly" | "monthly" | "weekly" | "daily" | "hourly" | "minutely" | "secondly" | "microsecond" | "none";
912
- /**
913
- * Custom Interval is used to set non-standard time interval, for example, if the
914
- * series is 5 minutes, request can be set as {"granularity":"minutely",
915
- * "customInterval":5}.
916
- */
917
- customInterval?: number;
918
- /**
919
- * Optional argument, periodic value of a time series. If the value is null or
920
- * does not present, the API will determine the period automatically.
921
- */
922
- period?: number;
923
- /** Optional argument, advanced model parameter, max anomaly ratio in a time series. */
924
- maxAnomalyRatio?: number;
925
- /**
926
- * Optional argument, advanced model parameter, between 0-99, the lower the value
927
- * is, the larger the margin value will be which means less anomalies will be
928
- * accepted.
929
- */
930
- sensitivity?: number;
931
- /**
932
- * Used to specify how to deal with missing values in the input series, it's used
933
- * when granularity is not "none".
934
- *
935
- * Possible values: auto, previous, linear, fixed, zero, notFill
936
- */
937
- imputeMode?: string;
938
- /**
939
- * Used to specify the value to fill, it's used when granularity is not "none"
940
- * and imputeMode is "fixed".
941
- */
942
- imputeFixedValue?: number;
943
- }
944
-
945
- /** The response of entire anomaly detection. */
946
- export declare interface UnivariateEntireDetectionResultOutput {
947
- /**
948
- * Frequency extracted from the series, zero means no recurrent pattern has been
949
- * found.
950
- */
951
- period: number;
952
- /**
953
- * ExpectedValues contain expected value for each input point. The index of the
954
- * array is consistent with the input series.
955
- */
956
- expectedValues: number[];
957
- /**
958
- * UpperMargins contain upper margin of each input point. UpperMargin is used to
959
- * calculate upperBoundary, which equals to expectedValue + (100 -
960
- * marginScale)*upperMargin. Anomalies in response can be filtered by
961
- * upperBoundary and lowerBoundary. By adjusting marginScale value, less
962
- * significant anomalies can be filtered in client side. The index of the array is
963
- * consistent with the input series.
964
- */
965
- upperMargins: number[];
966
- /**
967
- * LowerMargins contain lower margin of each input point. LowerMargin is used to
968
- * calculate lowerBoundary, which equals to expectedValue - (100 -
969
- * marginScale)*lowerMargin. Points between the boundary can be marked as normal
970
- * ones in client side. The index of the array is consistent with the input
971
- * series.
972
- */
973
- lowerMargins: number[];
974
- /**
975
- * IsAnomaly contains anomaly properties for each input point. True means an
976
- * anomaly either negative or positive has been detected. The index of the array
977
- * is consistent with the input series.
978
- */
979
- isAnomaly: boolean[];
980
- /**
981
- * IsNegativeAnomaly contains anomaly status in negative direction for each input
982
- * point. True means a negative anomaly has been detected. A negative anomaly
983
- * means the point is detected as an anomaly and its real value is smaller than
984
- * the expected one. The index of the array is consistent with the input series.
985
- */
986
- isNegativeAnomaly: boolean[];
987
- /**
988
- * IsPositiveAnomaly contain anomaly status in positive direction for each input
989
- * point. True means a positive anomaly has been detected. A positive anomaly
990
- * means the point is detected as an anomaly and its real value is larger than the
991
- * expected one. The index of the array is consistent with the input series.
992
- */
993
- isPositiveAnomaly: boolean[];
994
- /**
995
- * The severity score for each input point. The larger the value is, the more
996
- * sever the anomaly is. For normal points, the "severity" is always 0.
997
- */
998
- severity?: number[];
999
- }
1000
-
1001
- /** The response of last anomaly detection. */
1002
- export declare interface UnivariateLastDetectionResultOutput {
1003
- /**
1004
- * Frequency extracted from the series, zero means no recurrent pattern has been
1005
- * found.
1006
- */
1007
- period: number;
1008
- /** Suggested input series points needed for detecting the latest point. */
1009
- suggestedWindow: number;
1010
- /** Expected value of the latest point. */
1011
- expectedValue: number;
1012
- /**
1013
- * Upper margin of the latest point. UpperMargin is used to calculate
1014
- * upperBoundary, which equals to expectedValue + (100 - marginScale)*upperMargin.
1015
- * If the value of latest point is between upperBoundary and lowerBoundary, it
1016
- * should be treated as normal value. By adjusting marginScale value, anomaly
1017
- * status of latest point can be changed.
1018
- */
1019
- upperMargin: number;
1020
- /**
1021
- * Lower margin of the latest point. LowerMargin is used to calculate
1022
- * lowerBoundary, which equals to expectedValue - (100 - marginScale)*lowerMargin.
1023
- *
1024
- */
1025
- lowerMargin: number;
1026
- /**
1027
- * Anomaly status of the latest point, true means the latest point is an anomaly
1028
- * either in negative direction or positive direction.
1029
- */
1030
- isAnomaly: boolean;
1031
- /**
1032
- * Anomaly status in negative direction of the latest point. True means the latest
1033
- * point is an anomaly and its real value is smaller than the expected one.
1034
- */
1035
- isNegativeAnomaly: boolean;
1036
- /**
1037
- * Anomaly status in positive direction of the latest point. True means the latest
1038
- * point is an anomaly and its real value is larger than the expected one.
1039
- */
1040
- isPositiveAnomaly: boolean;
1041
- /**
1042
- * The severity score for the last input point. The larger the value is, the more
1043
- * sever the anomaly is. For normal points, the "severity" is always 0.
1044
- */
1045
- severity?: number;
1046
- }
1047
-
1048
- /** Variable Status. */
1049
- export declare interface VariableState {
1050
- /** Variable name in variable states. */
1051
- variable?: string;
1052
- /** Proportion of missing values that need to be filled by fillNAMethod. */
1053
- filledNARatio?: number;
1054
- /** Number of effective data points before applying fillNAMethod. */
1055
- effectiveCount?: number;
1056
- /** First valid timestamp with value of input data. */
1057
- firstTimestamp?: Date | string;
1058
- /** Last valid timestamp with value of input data. */
1059
- lastTimestamp?: Date | string;
1060
- }
1061
-
1062
- /** Variable Status. */
1063
- export declare interface VariableStateOutput {
1064
- /** Variable name in variable states. */
1065
- variable?: string;
1066
- /** Proportion of missing values that need to be filled by fillNAMethod. */
1067
- filledNARatio?: number;
1068
- /** Number of effective data points before applying fillNAMethod. */
1069
- effectiveCount?: number;
1070
- /** First valid timestamp with value of input data. */
1071
- firstTimestamp?: string;
1072
- /** Last valid timestamp with value of input data. */
1073
- lastTimestamp?: string;
1074
- }
1075
-
1076
- /** Variable values. */
1077
- export declare interface VariableValues {
1078
- /** Variable name of last detection request. */
1079
- variable: string;
1080
- /** Timestamps of last detection request */
1081
- timestamps: string[];
1082
- /** Values of variables. */
1083
- values: number[];
1084
- }
1085
-
1086
- export { }