AnomalyDetectorClient class
- Extends
Constructors
| Anomaly |
Initializes a new instance of the AnomalyDetectorClient class. |
Inherited Properties
| credentials | |
| endpoint |
Methods
| change |
Evaluate change point score of every series point |
| change |
|
| change |
|
| entire |
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. |
| entire |
|
| entire |
|
| last |
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. |
| last |
|
| last |
Inherited Methods
| send |
Send an HTTP request that is populated using the provided OperationSpec. |
| send |
Send the provided httpRequest. |
Constructor Details
AnomalyDetectorClient(ServiceClientCredentials, string, ServiceClientOptions)
Initializes a new instance of the AnomalyDetectorClient class.
new AnomalyDetectorClient(credentials: ServiceClientCredentials, endpoint: string, options?: 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
- ServiceClientOptions
The parameter options
Inherited Property Details
credentials
credentials: ServiceClientCredentialsProperty Value
Inherited From AnomalyDetectorClientContext.credentials
endpoint
Method Details
changePointDetect(ChangePointDetectRequest, RequestOptionsBase)
Evaluate change point score of every series point
function changePointDetect(body: ChangePointDetectRequest, options?: RequestOptionsBase): Promise<ChangePointDetectResponse2>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
Returns
Promise<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
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
The callback
entireDetect(Request, 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?: RequestOptionsBase): Promise<EntireDetectResponse2>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
Returns
Promise<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
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
The callback
lastDetect(Request, 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?: RequestOptionsBase): Promise<LastDetectResponse2>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
Returns
Promise<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
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
The callback
Inherited Method Details
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>): Promise<RestResponse>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>
Inherited From AnomalyDetectorClientContext.sendOperationRequest
sendRequest(RequestPrepareOptions | WebResourceLike)
Send the provided httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Parameters
- options
Returns
Promise<HttpOperationResponse>
Inherited From AnomalyDetectorClientContext.sendRequest
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for