azure.ai.anomalydetector.operations package

class azure.ai.anomalydetector.operations.AnomalyDetectorClientOperationsMixin[source]
delete_multivariate_model(model_id: str, **kwargs: Any)None[source]

Delete Multivariate Model.

Delete an existing multivariate model according to the modelId.

Parameters

model_id (str) – Model identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

detect_anomaly(model_id: str, detection_request: ‘_models.DetectionRequest’, **kwargs: Any)None[source]

Detect Multivariate Anomaly.

Submit detection multivariate anomaly task with the trained model of modelId, the input schema should be the same with the training request. Thus request will be complete asynchronously and will return a resultId for querying the detection result.The request should be a source link to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be as follows: the first column is timestamp and the second column is value.

Parameters
  • model_id (str) – Model identifier.

  • detection_request (DetectionRequest) – Detect anomaly request.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

detect_change_point(body: ‘_models.ChangePointDetectRequest’, **kwargs: Any) → ’_models.ChangePointDetectResponse’[source]

Detect change point for the entire series.

Evaluate change point score of every series point.

Parameters

body (ChangePointDetectRequest) – Time series points and granularity is needed. Advanced model parameters can also be set in the request if needed.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ChangePointDetectResponse, or the result of cls(response)

Return type

ChangePointDetectResponse

Raises

~azure.core.exceptions.HttpResponseError

detect_entire_series(body: ‘_models.DetectRequest’, **kwargs: Any) → ’_models.EntireDetectResponse’[source]

Detect anomalies for the entire series in batch.

This operation generates a model with 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EntireDetectResponse, or the result of cls(response)

Return type

EntireDetectResponse

Raises

~azure.core.exceptions.HttpResponseError

detect_last_point(body: ‘_models.DetectRequest’, **kwargs: Any) → ’_models.LastDetectResponse’[source]

Detect anomaly status of the latest point in time series.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LastDetectResponse, or the result of cls(response)

Return type

LastDetectResponse

Raises

~azure.core.exceptions.HttpResponseError

export_model(model_id: str, **kwargs: Any) → IO[source]

Export Multivariate Anomaly Detection Model as Zip file.

Export multivariate anomaly detection model based on modelId.

Parameters

model_id (str) – Model identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

IO

Raises

~azure.core.exceptions.HttpResponseError

get_detection_result(result_id: str, **kwargs: Any) → ’_models.DetectionResult’[source]

Get Multivariate Anomaly Detection Result.

Get multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api.

Parameters

result_id (str) – Result identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DetectionResult, or the result of cls(response)

Return type

DetectionResult

Raises

~azure.core.exceptions.HttpResponseError

get_multivariate_model(model_id: str, **kwargs: Any) → ’_models.Model’[source]

Get Multivariate Model.

Get detailed information of multivariate model, including the training status and variables used in the model.

Parameters

model_id (str) – Model identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Model, or the result of cls(response)

Return type

Model

Raises

~azure.core.exceptions.HttpResponseError

list_multivariate_model(skip: Optional[int] = 0, top: Optional[int] = 5, **kwargs: Any) → Iterable[‘_models.ModelList’][source]

List Multivariate Models.

List models of a subscription.

Parameters
  • skip (int) – $skip indicates how many models will be skipped.

  • top (int) – $top indicates how many models will be fetched.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ModelList or the result of cls(response)

Return type

ItemPaged[ModelList]

Raises

~azure.core.exceptions.HttpResponseError

train_multivariate_model(model_request: ‘_models.ModelInfo’, **kwargs: Any)None[source]

Train a Multivariate Anomaly Detection Model.

Create and train a multivariate anomaly detection model. The request must include a source parameter to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be in a single CSV file in which the first column is timestamp and the second column is value.

Parameters

model_request (ModelInfo) – Training request.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError