Class AnomalyDetectorClient

Package version

Client class for interacting with Azure Anomaly Detector service.

Hierarchy

AnomalyDetectorClient

Index

Constructors

constructor

Methods

Constructors

constructor

new AnomalyDetectorClient(endpointUrl: string, credential: TokenCredential | KeyCredential, options?: AnomalyDetectorClientOptions): AnomalyDetectorClient

- Defined in AnomalyDetectorClient.ts:46
Creates an instance of AnomalyDetectorClient.

Example usage:
```
import { AnomalyDetectorClient, AzureKeyCredential } from "@azure/ai-anomaly-detector";

const client = new AnomalyDetectorClient(
   "<service endpoint>",
   new AzureKeyCredential("<api key>")
);
```
Parameters
- endpointUrl: string
- credential: TokenCredential | KeyCredential
  
  Used to authenticate requests to the service.
- Optional options: AnomalyDetectorClientOptions
Returns AnomalyDetectorClient

Methods

detectChangePoint

detectChangePoint(body: DetectChangePointRequest, options?: OperationOptions): Promise<AnomalyDetectorClientDetectChangePointResponse>

- Defined in AnomalyDetectorClient.ts:173
Evaluate change point score of every series point

Parameters
- body: DetectChangePointRequest
  
  Time series points and granularity is needed. Advanced model parameters can also be set in the request if needed.
- Optional options: OperationOptions
  
  The options parameters.
Returns Promise<AnomalyDetectorClientDetectChangePointResponse>

detectEntireSeries

detectEntireSeries(body: DetectRequest, options?: OperationOptions): Promise<AnomalyDetectorClientDetectEntireResponse>

- Defined in AnomalyDetectorClient.ts:111
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.

Parameters
- body: DetectRequest
  
  Time series points and period if needed. Advanced model parameters can also be set in the request.
- Optional options: OperationOptions
  
  The options parameters.
Returns Promise<AnomalyDetectorClientDetectEntireResponse>

detectLastPoint

detectLastPoint(body: DetectRequest, options?: OperationOptions): Promise<AnomalyDetectorClientDetectLastPointResponse>

- Defined in AnomalyDetectorClient.ts:143
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.

Parameters
- body: DetectRequest
  
  Time series points and period if needed. Advanced model parameters can also be set in the request.
- Optional options: OperationOptions
  
  The options parameters.
Returns Promise<AnomalyDetectorClientDetectLastPointResponse>

Generated using TypeDoc