AnomalyDetectorClient class
- Extends
Constructors
| Anomaly |
Initializes a new instance of the AnomalyDetectorClient class. |
Properties
| credentials | |
| endpoint |
Methods
Constructor Details
AnomalyDetectorClient(ServiceClientCredentials, string, msRest.ServiceClientOptions)
Initializes a new instance of the AnomalyDetectorClient class.
new AnomalyDetectorClient(credentials: ServiceClientCredentials, endpoint: string, options?: msRest.ServiceClientOptions)Parameters
- credentials
-
ServiceClientCredentials
Subscription credentials which uniquely identify client subscription.
- endpoint
-
string
Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).
- options
- msRest.ServiceClientOptions
Property Details
credentials
credentials: ServiceClientCredentialsProperty Value
ServiceClientCredentials
endpoint
endpoint: stringProperty Value
string
Method Details
changePointDetect(ChangePointDetectRequest, msRest.RequestOptionsBase)
Evaluate change point score of every series point
function changePointDetect(body: ChangePointDetectRequest, options?: msRest.RequestOptionsBase)Parameters
Time series points and granularity is needed. Advanced model parameters can also be set in the request if needed.
- options
- msRest.RequestOptionsBase
Returns
Promise<Models.ChangePointDetectResponse2>
Promise<Models.ChangePointDetectResponse2>
changePointDetect(ChangePointDetectRequest, RequestOptionsBase, ServiceCallback<ChangePointDetectResponse>)
function changePointDetect(body: ChangePointDetectRequest, options: RequestOptionsBase, callback: ServiceCallback<ChangePointDetectResponse>)Parameters
Time series points and granularity is needed. Advanced model parameters can also be set in the request if needed.
- options
-
RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<ChangePointDetectResponse>
The callback
changePointDetect(ChangePointDetectRequest, ServiceCallback<ChangePointDetectResponse>)
function changePointDetect(body: ChangePointDetectRequest, callback: ServiceCallback<ChangePointDetectResponse>)Parameters
Time series points and granularity is needed. Advanced model parameters can also be set in the request if needed.
- callback
-
ServiceCallback<ChangePointDetectResponse>
The callback
entireDetect(Request, msRest.RequestOptionsBase)
This operation generates a model using an entire series, each point is detected with the same model. With this method, points before and after a certain point are used to determine whether it is an anomaly. The entire detection can give user an overall status of the time series.
function entireDetect(body: Request, options?: msRest.RequestOptionsBase)Parameters
- body
- Request
Time series points and period if needed. Advanced model parameters can also be set in the request.
- options
- msRest.RequestOptionsBase
Returns
Promise<Models.EntireDetectResponse2>
Promise<Models.EntireDetectResponse2>
entireDetect(Request, RequestOptionsBase, ServiceCallback<EntireDetectResponse>)
function entireDetect(body: Request, options: RequestOptionsBase, callback: ServiceCallback<EntireDetectResponse>)Parameters
- body
- Request
Time series points and period if needed. Advanced model parameters can also be set in the request.
- options
-
RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<EntireDetectResponse>
The callback
entireDetect(Request, ServiceCallback<EntireDetectResponse>)
function entireDetect(body: Request, callback: ServiceCallback<EntireDetectResponse>)Parameters
- body
- Request
Time series points and period if needed. Advanced model parameters can also be set in the request.
- callback
-
ServiceCallback<EntireDetectResponse>
The callback
lastDetect(Request, msRest.RequestOptionsBase)
This operation generates a model using points before the latest one. With this method, only historical points are used to determine whether the target point is an anomaly. The latest point detecting operation matches the scenario of real-time monitoring of business metrics.
function lastDetect(body: Request, options?: msRest.RequestOptionsBase)Parameters
- body
- Request
Time series points and period if needed. Advanced model parameters can also be set in the request.
- options
- msRest.RequestOptionsBase
Returns
Promise<Models.LastDetectResponse2>
Promise<Models.LastDetectResponse2>
lastDetect(Request, RequestOptionsBase, ServiceCallback<LastDetectResponse>)
function lastDetect(body: Request, options: RequestOptionsBase, callback: ServiceCallback<LastDetectResponse>)Parameters
- body
- Request
Time series points and period if needed. Advanced model parameters can also be set in the request.
- options
-
RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<LastDetectResponse>
The callback
lastDetect(Request, ServiceCallback<LastDetectResponse>)
function lastDetect(body: Request, callback: ServiceCallback<LastDetectResponse>)Parameters
- body
- Request
Time series points and period if needed. Advanced model parameters can also be set in the request.
- callback
-
ServiceCallback<LastDetectResponse>
The callback
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Send an HTTP request that is populated using the provided OperationSpec.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>)Parameters
- operationArguments
-
OperationArguments
The arguments that the HTTP request's templated values will be populated from.
- operationSpec
-
OperationSpec
The OperationSpec to use to populate the httpRequest.
- callback
-
ServiceCallback<any>
The callback to call when the response is received.
Returns
Promise<RestResponse>
sendRequest(RequestPrepareOptions | WebResourceLike)
Send the provided httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike)Parameters
- options
-
RequestPrepareOptions | WebResourceLike
Returns
Promise<HttpOperationResponse>