|
| 1 | +### YamlMime:UniversalReference |
| 2 | +items: |
| 3 | + - uid: '@azure/cognitiveservices-anomalydetector.AnomalyDetectorClient' |
| 4 | + name: AnomalyDetectorClient |
| 5 | + fullName: AnomalyDetectorClient |
| 6 | + children: |
| 7 | + - >- |
| 8 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.constructor |
| 9 | + - >- |
| 10 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.entireDetect |
| 11 | + - >- |
| 12 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.entireDetect_2 |
| 13 | + - >- |
| 14 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.entireDetect_1 |
| 15 | + - >- |
| 16 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.lastDetect |
| 17 | + - >- |
| 18 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.lastDetect_2 |
| 19 | + - >- |
| 20 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.lastDetect_1 |
| 21 | + langs: |
| 22 | + - typeScript |
| 23 | + type: class |
| 24 | + summary: '' |
| 25 | + extends: |
| 26 | + name: '@azure/cognitiveservices-anomalydetector.AnomalyDetectorClientContext' |
| 27 | + package: '@azure/cognitiveservices-anomalydetector' |
| 28 | + - uid: '@azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.constructor' |
| 29 | + name: >- |
| 30 | + AnomalyDetectorClient(ServiceClientCredentials, string, |
| 31 | + msRest.ServiceClientOptions) |
| 32 | + children: [] |
| 33 | + type: constructor |
| 34 | + langs: |
| 35 | + - typeScript |
| 36 | + summary: Initializes a new instance of the AnomalyDetectorClient class. |
| 37 | + syntax: |
| 38 | + content: >- |
| 39 | + new AnomalyDetectorClient(credentials: ServiceClientCredentials, |
| 40 | + endpoint: string, options?: msRest.ServiceClientOptions) |
| 41 | + parameters: |
| 42 | + - id: credentials |
| 43 | + type: |
| 44 | + - ServiceClientCredentials |
| 45 | + description: >- |
| 46 | + Subscription credentials which uniquely identify client |
| 47 | + subscription. |
| 48 | + - id: endpoint |
| 49 | + type: |
| 50 | + - string |
| 51 | + description: >- |
| 52 | + Supported Cognitive Services endpoints (protocol and hostname, for |
| 53 | + example: |
| 54 | +
|
| 55 | + https://westus2.api.cognitive.microsoft.com). |
| 56 | + - id: options |
| 57 | + type: |
| 58 | + - msRest.ServiceClientOptions |
| 59 | + description: '' |
| 60 | + optional: true |
| 61 | + package: '@azure/cognitiveservices-anomalydetector' |
| 62 | + - uid: >- |
| 63 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.entireDetect |
| 64 | + name: 'entireDetect(Request, msRest.RequestOptionsBase)' |
| 65 | + children: [] |
| 66 | + type: method |
| 67 | + langs: |
| 68 | + - typeScript |
| 69 | + summary: >- |
| 70 | + This operation generates a model using an entire series, each point is |
| 71 | + detected with the same |
| 72 | +
|
| 73 | + model. With this method, points before and after a certain point are used |
| 74 | + to determine whether |
| 75 | +
|
| 76 | + it is an anomaly. The entire detection can give user an overall status of |
| 77 | + the time series. |
| 78 | + syntax: |
| 79 | + content: >- |
| 80 | + function entireDetect(body: Request, options?: |
| 81 | + msRest.RequestOptionsBase) |
| 82 | + parameters: |
| 83 | + - id: body |
| 84 | + type: |
| 85 | + - '@azure/cognitiveservices-anomalydetector.Request' |
| 86 | + description: >- |
| 87 | + Time series points and period if needed. Advanced model parameters |
| 88 | + can also be set |
| 89 | +
|
| 90 | + in the request. |
| 91 | + - id: options |
| 92 | + type: |
| 93 | + - msRest.RequestOptionsBase |
| 94 | + description: '' |
| 95 | + optional: true |
| 96 | + return: |
| 97 | + type: |
| 98 | + - Promise<Models.EntireDetectResponse2> |
| 99 | + package: '@azure/cognitiveservices-anomalydetector' |
| 100 | + - uid: >- |
| 101 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.entireDetect_2 |
| 102 | + name: >- |
| 103 | + entireDetect(Request, RequestOptionsBase, |
| 104 | + ServiceCallback<EntireDetectResponse>) |
| 105 | + children: [] |
| 106 | + type: method |
| 107 | + langs: |
| 108 | + - typeScript |
| 109 | + summary: '' |
| 110 | + syntax: |
| 111 | + content: >- |
| 112 | + function entireDetect(body: Request, options: RequestOptionsBase, |
| 113 | + callback: ServiceCallback<EntireDetectResponse>) |
| 114 | + parameters: |
| 115 | + - id: body |
| 116 | + type: |
| 117 | + - '@azure/cognitiveservices-anomalydetector.Request' |
| 118 | + description: >- |
| 119 | + Time series points and period if needed. Advanced model parameters |
| 120 | + can also be set |
| 121 | +
|
| 122 | + in the request. |
| 123 | + - id: options |
| 124 | + type: |
| 125 | + - RequestOptionsBase |
| 126 | + description: The optional parameters |
| 127 | + - id: callback |
| 128 | + type: |
| 129 | + - >- |
| 130 | + ServiceCallback<@azure/cognitiveservices-anomalydetector.EntireDetectResponse> |
| 131 | + description: | |
| 132 | + The callback |
| 133 | + return: |
| 134 | + type: |
| 135 | + - Promise<Models.EntireDetectResponse2> |
| 136 | + package: '@azure/cognitiveservices-anomalydetector' |
| 137 | + - uid: >- |
| 138 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.entireDetect_1 |
| 139 | + name: 'entireDetect(Request, ServiceCallback<EntireDetectResponse>)' |
| 140 | + children: [] |
| 141 | + type: method |
| 142 | + langs: |
| 143 | + - typeScript |
| 144 | + summary: '' |
| 145 | + syntax: |
| 146 | + content: >- |
| 147 | + function entireDetect(body: Request, callback: |
| 148 | + ServiceCallback<EntireDetectResponse>) |
| 149 | + parameters: |
| 150 | + - id: body |
| 151 | + type: |
| 152 | + - '@azure/cognitiveservices-anomalydetector.Request' |
| 153 | + description: >- |
| 154 | + Time series points and period if needed. Advanced model parameters |
| 155 | + can also be set |
| 156 | +
|
| 157 | + in the request. |
| 158 | + - id: callback |
| 159 | + type: |
| 160 | + - >- |
| 161 | + ServiceCallback<@azure/cognitiveservices-anomalydetector.EntireDetectResponse> |
| 162 | + description: | |
| 163 | + The callback |
| 164 | + return: |
| 165 | + type: |
| 166 | + - Promise<Models.EntireDetectResponse2> |
| 167 | + package: '@azure/cognitiveservices-anomalydetector' |
| 168 | + - uid: '@azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.lastDetect' |
| 169 | + name: 'lastDetect(Request, msRest.RequestOptionsBase)' |
| 170 | + children: [] |
| 171 | + type: method |
| 172 | + langs: |
| 173 | + - typeScript |
| 174 | + summary: >- |
| 175 | + This operation generates a model using points before the latest one. With |
| 176 | + this method, only |
| 177 | +
|
| 178 | + historical points are used to determine whether the target point is an |
| 179 | + anomaly. The latest point |
| 180 | +
|
| 181 | + detecting operation matches the scenario of real-time monitoring of |
| 182 | + business metrics. |
| 183 | + syntax: |
| 184 | + content: 'function lastDetect(body: Request, options?: msRest.RequestOptionsBase)' |
| 185 | + parameters: |
| 186 | + - id: body |
| 187 | + type: |
| 188 | + - '@azure/cognitiveservices-anomalydetector.Request' |
| 189 | + description: >- |
| 190 | + Time series points and period if needed. Advanced model parameters |
| 191 | + can also be set |
| 192 | +
|
| 193 | + in the request. |
| 194 | + - id: options |
| 195 | + type: |
| 196 | + - msRest.RequestOptionsBase |
| 197 | + description: '' |
| 198 | + optional: true |
| 199 | + return: |
| 200 | + type: |
| 201 | + - Promise<Models.LastDetectResponse2> |
| 202 | + package: '@azure/cognitiveservices-anomalydetector' |
| 203 | + - uid: >- |
| 204 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.lastDetect_2 |
| 205 | + name: >- |
| 206 | + lastDetect(Request, RequestOptionsBase, |
| 207 | + ServiceCallback<LastDetectResponse>) |
| 208 | + children: [] |
| 209 | + type: method |
| 210 | + langs: |
| 211 | + - typeScript |
| 212 | + summary: '' |
| 213 | + syntax: |
| 214 | + content: >- |
| 215 | + function lastDetect(body: Request, options: RequestOptionsBase, |
| 216 | + callback: ServiceCallback<LastDetectResponse>) |
| 217 | + parameters: |
| 218 | + - id: body |
| 219 | + type: |
| 220 | + - '@azure/cognitiveservices-anomalydetector.Request' |
| 221 | + description: >- |
| 222 | + Time series points and period if needed. Advanced model parameters |
| 223 | + can also be set |
| 224 | +
|
| 225 | + in the request. |
| 226 | + - id: options |
| 227 | + type: |
| 228 | + - RequestOptionsBase |
| 229 | + description: The optional parameters |
| 230 | + - id: callback |
| 231 | + type: |
| 232 | + - >- |
| 233 | + ServiceCallback<@azure/cognitiveservices-anomalydetector.LastDetectResponse> |
| 234 | + description: | |
| 235 | + The callback |
| 236 | + return: |
| 237 | + type: |
| 238 | + - Promise<Models.LastDetectResponse2> |
| 239 | + package: '@azure/cognitiveservices-anomalydetector' |
| 240 | + - uid: >- |
| 241 | + @azure/cognitiveservices-anomalydetector.AnomalyDetectorClient.lastDetect_1 |
| 242 | + name: 'lastDetect(Request, ServiceCallback<LastDetectResponse>)' |
| 243 | + children: [] |
| 244 | + type: method |
| 245 | + langs: |
| 246 | + - typeScript |
| 247 | + summary: '' |
| 248 | + syntax: |
| 249 | + content: >- |
| 250 | + function lastDetect(body: Request, callback: |
| 251 | + ServiceCallback<LastDetectResponse>) |
| 252 | + parameters: |
| 253 | + - id: body |
| 254 | + type: |
| 255 | + - '@azure/cognitiveservices-anomalydetector.Request' |
| 256 | + description: >- |
| 257 | + Time series points and period if needed. Advanced model parameters |
| 258 | + can also be set |
| 259 | +
|
| 260 | + in the request. |
| 261 | + - id: callback |
| 262 | + type: |
| 263 | + - >- |
| 264 | + ServiceCallback<@azure/cognitiveservices-anomalydetector.LastDetectResponse> |
| 265 | + description: | |
| 266 | + The callback |
| 267 | + return: |
| 268 | + type: |
| 269 | + - Promise<Models.LastDetectResponse2> |
| 270 | + package: '@azure/cognitiveservices-anomalydetector' |
| 271 | +references: |
| 272 | + - uid: '@azure/cognitiveservices-anomalydetector.AnomalyDetectorClientContext' |
| 273 | + name: AnomalyDetectorClientContext |
| 274 | + spec.typeScript: |
| 275 | + - name: AnomalyDetectorClientContext |
| 276 | + fullName: AnomalyDetectorClientContext |
| 277 | + uid: '@azure/cognitiveservices-anomalydetector.AnomalyDetectorClientContext' |
| 278 | + - uid: '@azure/cognitiveservices-anomalydetector.Request' |
| 279 | + name: Request |
| 280 | + spec.typeScript: |
| 281 | + - name: Request |
| 282 | + fullName: Request |
| 283 | + uid: '@azure/cognitiveservices-anomalydetector.Request' |
| 284 | + - uid: >- |
| 285 | + ServiceCallback<@azure/cognitiveservices-anomalydetector.EntireDetectResponse> |
| 286 | + name: EntireDetectResponse> |
| 287 | + spec.typeScript: |
| 288 | + - name: ServiceCallback< |
| 289 | + fullName: ServiceCallback< |
| 290 | + - name: EntireDetectResponse |
| 291 | + fullName: EntireDetectResponse |
| 292 | + uid: '@azure/cognitiveservices-anomalydetector.EntireDetectResponse' |
| 293 | + - name: '>' |
| 294 | + fullName: '>' |
| 295 | + - uid: >- |
| 296 | + ServiceCallback<@azure/cognitiveservices-anomalydetector.LastDetectResponse> |
| 297 | + name: LastDetectResponse> |
| 298 | + spec.typeScript: |
| 299 | + - name: ServiceCallback< |
| 300 | + fullName: ServiceCallback< |
| 301 | + - name: LastDetectResponse |
| 302 | + fullName: LastDetectResponse |
| 303 | + uid: '@azure/cognitiveservices-anomalydetector.LastDetectResponse' |
| 304 | + - name: '>' |
| 305 | + fullName: '>' |
0 commit comments