Microsoft Azure

Azure AI Services: Openapi

The Anomaly Detector API detects anomalies automatically in time series data. It supports both a stateless detection mode and a stateful detection mode. In…

AI & machine learning#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Anomaly Detector API detects anomalies automatically in time series data.
It supports both a stateless detection mode and a
stateful detection mode. In stateless mode, there are three functionalities. Entire
Detect is for detecting the whole series, with the model trained by the time series.
Last Detect is for detecting the last point, with the model trained by points before.
ChangePoint Detect is for detecting trend changes in the time series. In stateful
mode, the user can store time series. The stored time series will be used for
detection anomalies. In this mode, the user can still use the preceding three
functionalities by only giving a time range without preparing time series on the
client side. Besides the preceding three functionalities, the stateful model
provides group-based detection and labeling services. By using the labeling
service, the user can provide labels for each detection result. These labels will be
used for retuning or regenerating detection models. Inconsistency detection is
a kind of group-based detection that finds inconsistencies in
a set of time series. By using the anomaly detector service, business customers can
discover incidents and establish a logic flow for root cause analysis.

Endpoints 10

  • GETGet Multivariate Anomaly Detection Result/multivariate/detect-batch/:resultIdFor asynchronous inference, get a multivariate anomaly detection result based on the resultId value that the BatchDetectAnomaly API returns.
  • GETList Multivariate Models/multivariate/models?skip=0&top=0List models of a resource.
  • POSTTrain a Multivariate Anomaly Detection Model/multivariate/modelsCreate and train a multivariate anomaly detection model. The request must include a source parameter to indicate an Azure Blob Storage URI that's accessible…
  • GETGet Multivariate Model/multivariate/models/:modelIdGet detailed information about the multivariate model, including the training status and variables used in the model.
  • DELETEDelete Multivariate Model/multivariate/models/:modelIdDelete an existing multivariate model according to the modelId value.
  • POSTDetect Multivariate Anomaly/multivariate/models/:modelId:detect-batchSubmit a multivariate anomaly detection task with the modelId value of a trained model and inference data. The input schema should be the same with the…
  • POSTDetect anomalies in the last point of the request body/multivariate/models/:modelId:detect-lastSubmit a multivariate anomaly detection task with the modelId value of a trained model and inference data. The inference data should be put into the request…
  • POSTDetect change point for the entire series/timeseries/changepoint/detectEvaluate the change point score of every series point.
  • POSTDetect anomalies for the entire series in batch./timeseries/entire/detectThis 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…
  • POSTDetect anomaly status of the latest point in time series./timeseries/last/detectThis operation generates a model by using the points that you sent in to the API and based on all data to determine whether the last point is anomalous.

API details

Authentication
An API key in the Ocp-Apim-Subscription-Key header
Operations
10 operations on 8 pathsPOST 6GET 3DELETE 1
Response formats
application/json
Description format
Swagger 2.0, API version v1.1

How to test the Azure AI Services: Openapi in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure AI Services: Openapi collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Ocp-Apim-Subscription-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get Multivariate Anomaly Detection Result” (GET /multivariate/detect-batch/:resultId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure AI Services: Openapi?

The Anomaly Detector API detects anomalies automatically in time series data. It supports both a stateless detection mode and a stateful detection mode. In… It is listed under AI & machine learning and has 10 endpoints.

Who publishes the Azure AI Services: Openapi?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure AI Services: Openapi?

With an API key in the Ocp-Apim-Subscription-Key header.

How many endpoints does the Azure AI Services: Openapi have?

10 operations on 8 paths (6 POST, 3 GET, 1 DELETE).

Is forking the Azure AI Services: Openapi free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.