Skip to content

Commit 9344877

Browse files
authored
Merge pull request #96428 from aahill/ad-qs-update
[CogSvcs] UX testing updates
2 parents b2c7065 + 12c22ee commit 9344877

9 files changed

+86
-111
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Next steps for Anomaly Detector quickstarts
3+
titleSuffix: Azure Cognitive Services
4+
services: cognitive-services
5+
author: aahill
6+
manager: nitinme
7+
ms.service: cognitive-services
8+
ms.topic: include
9+
ms.date: 11/19/2019
10+
ms.author: aahi
11+
---
12+
13+
## Clean up resources
14+
15+
If you want to clean up and remove a Cognitive Services subscription, you can delete the resource or resource group. Deleting the resource group also deletes any other resources associated with the resource group.
16+
17+
* [Portal](../../cognitive-services-apis-create-account.md#clean-up-resources)
18+
* [Azure CLI](../../cognitive-services-apis-create-account-cli.md#clean-up-resources)
19+
20+
## Next steps
21+
22+
Concepts:
23+
24+
* [What is the Anomaly Detector API?](../overview.md)
25+
* [Anomaly detection methods](../how-to/identify-anomalies.md)
26+
* [Best practices when using the Anomaly Detector API.](../concepts/anomaly-detection-best-practices.md)
27+
28+
Tutorials:
29+
30+
* [Visualize anomalies as a batch using Power BI](../tutorials/batch-anomaly-detection-powerbi.md)
31+
* [Anomaly detection on streaming data using Azure Databricks](../tutorials/anomaly-detection-streaming-databricks.md)

articles/cognitive-services/Anomaly-Detector/quickstarts/detect-data-anomalies-csharp-sdk.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: anomaly-detector
1010
ms.topic: quickstart
11-
ms.date: 10/15/2019
11+
ms.date: 11/19/2019
1212
ms.author: aahi
1313
---
1414

@@ -21,12 +21,13 @@ Use the Anomaly Detector client library for .NET to:
2121
* Detect anomalies throughout your time series dataset, as a batch request
2222
* Detect the anomaly status of the latest data point in your time series
2323

24-
[Library reference documentation](https://docs.microsoft.com/dotnet/api/Microsoft.Azure.CognitiveServices.AnomalyDetector?view=azure-dotnet-preview) | [Library source code](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/cognitiveservices/AnomalyDetector) | [Package (NuGet)](https://www.nuget.org/packages/Microsoft.Azure.CognitiveServices.AnomalyDetector/) | [Code samples](https://github.com/Azure-Samples/anomalydetector)
24+
[Library reference documentation](https://docs.microsoft.com/dotnet/api/Microsoft.Azure.CognitiveServices.AnomalyDetector?view=azure-dotnet-preview) | [Library source code](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/cognitiveservices/AnomalyDetector) | [Package (NuGet)](https://www.nuget.org/packages/Microsoft.Azure.CognitiveServices.AnomalyDetector/) | [Find the code on GitHub](https://github.com/Azure-Samples/AnomalyDetector/blob/master/quickstarts/sdk/csharp-sdk-sample.cs)
2525

2626
## Prerequisites
2727

2828
* Azure subscription - [Create one for free](https://azure.microsoft.com/free/)
2929
* The current version of [.NET Core](https://dotnet.microsoft.com/download/dotnet-core)
30+
* An Anomaly detector key and endpoint
3031

3132
## Setting up
3233

@@ -132,18 +133,4 @@ Run the application with the `dotnet run` command from your application director
132133
dotnet run
133134
```
134135

135-
## Clean up resources
136-
137-
If you want to clean up and remove a Cognitive Services subscription, you can delete the resource or resource group. Deleting the resource group also deletes any other resources associated with the resource group.
138-
139-
* [Portal](../../cognitive-services-apis-create-account.md#clean-up-resources)
140-
* [Azure CLI](../../cognitive-services-apis-create-account-cli.md#clean-up-resources)
141-
142-
## Next steps
143-
144-
> [!div class="nextstepaction"]
145-
>[Streaming anomaly detection with Azure Databricks](../tutorials/anomaly-detection-streaming-databricks.md)
146-
147-
* What is the [Anomaly Detector API?](../overview.md)
148-
* [Best practices](../concepts/anomaly-detection-best-practices.md) when using the Anomaly Detector API.
149-
* The source code for this sample can be found on [GitHub](https://github.com/Azure-Samples/AnomalyDetector/blob/master/quickstarts/sdk/csharp-sdk-sample.cs).
136+
[!INCLUDE [anomaly-detector-next-steps](../includes/quickstart-cleanup-next-steps.md)]

articles/cognitive-services/Anomaly-Detector/quickstarts/detect-data-anomalies-csharp.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: anomaly-detector
1010
ms.topic: quickstart
11-
ms.date: 10/14/2019
11+
ms.date: 11/19/2019
1212
ms.author: aahi
1313
---
1414

1515
# Quickstart: Detect anomalies in your time series data using the Anomaly Detector REST API and C#
1616

1717
Use this quickstart to start using the Anomaly Detector API's two detection modes to detect anomalies in your time series data. This C# application sends two API requests containing JSON-formatted time series data, and gets the responses.
1818

19-
| API request | Application output |
20-
|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
19+
| API request | Application output |
20+
|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
2121
| Detect anomalies as a batch | The JSON response containing the anomaly status (and other data) for each data point in the time series data, and the positions of any detected anomalies. |
22-
| Detect the anomaly status of the latest data point | The JSON response containing the anomaly status (and other data) for the latest data point in the time series data. |
22+
| Detect the anomaly status of the latest data point | The JSON response containing the anomaly status (and other data) for the latest data point in the time series data. |
2323

24-
While this application is written in C#, the API is a RESTful web service compatible with most programming languages.
24+
While this application is written in C#, the API is a RESTful web service compatible with most programming languages. You can find the source code for this quickstart on [GitHub](https://github.com/Azure-Samples/AnomalyDetector/blob/master/quickstarts/csharp-detect-anomalies.cs).
2525

2626
## Prerequisites
2727

2828
- Any edition of [Visual Studio 2017 or later](https://visualstudio.microsoft.com/downloads/),
29-
29+
- An Anomaly detector key and endpoint
3030
- The [Json.NET](https://www.newtonsoft.com/json) framework, available as a NuGet package. To install Newtonsoft.Json as a NuGet package in Visual Studio:
3131

3232
1. Right click your project in **Solution Explorer**.
@@ -50,11 +50,11 @@ Use this quickstart to start using the Anomaly Detector API's two detection mode
5050

5151
2. Create variables for your subscription key and your endpoint. Below are the URIs you can use for anomaly detection. These will be appended to your service endpoint later to create the API request URLs.
5252

53-
|Detection method |URI |
54-
|---------|---------|
55-
|Batch detection | `/anomalydetector/v1.0/timeseries/entire/detect` |
56-
|Detection on the latest data point | `/anomalydetector/v1.0/timeseries/last/detect` |
57-
53+
| Detection method | URI |
54+
|------------------------------------|--------------------------------------------------|
55+
| Batch detection | `/anomalydetector/v1.0/timeseries/entire/detect` |
56+
| Detection on the latest data point | `/anomalydetector/v1.0/timeseries/last/detect` |
57+
5858
[!code-csharp[initial variables for endpoint, key and data file](~/samples-anomaly-detector/quickstarts/csharp-detect-anomalies.cs?name=vars)]
5959

6060
## Create a function to send requests
@@ -86,8 +86,8 @@ Use this quickstart to start using the Anomaly Detector API's two detection mode
8686

8787
2. Deserialize the JSON object, and write it to the console.
8888

89-
[!code-csharp[Detect anomalies latest](~/samples-anomaly-detector/quickstarts/csharp-detect-anomalies.cs?name=detectAnomaliesLatest)]
90-
89+
[!code-csharp[Detect anomalies latest](~/samples-anomaly-detector/quickstarts/csharp-detect-anomalies.cs?name=detectAnomaliesLatest)]
90+
9191
## Load your time series data and send the request
9292

9393
1. In the main method of your application, load your JSON time series data with `File.ReadAllText()`.
@@ -102,11 +102,4 @@ A successful response is returned in JSON format. Click the links below to view
102102
* [Example batch detection response](https://github.com/Azure-Samples/anomalydetector/blob/master/example-data/batch-response.json)
103103
* [Example latest point detection response](https://github.com/Azure-Samples/anomalydetector/blob/master/example-data/latest-point-response.json)
104104

105-
## Next steps
106-
107-
> [!div class="nextstepaction"]
108-
>[Streaming anomaly detection with Azure Databricks](../tutorials/anomaly-detection-streaming-databricks.md)
109-
110-
* What is the [Anomaly Detector API?](../overview.md)
111-
* [Best practices](../concepts/anomaly-detection-best-practices.md) when using the Anomaly Detector API.
112-
* The source code for this sample can be found on [GitHub](https://github.com/Azure-Samples/AnomalyDetector/blob/master/quickstarts/sdk/csharp-sdk-sample.cs).
105+
[!INCLUDE [anomaly-detector-next-steps](../includes/quickstart-cleanup-next-steps.md)]

articles/cognitive-services/Anomaly-Detector/quickstarts/detect-data-anomalies-java.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: anomaly-detector
1010
ms.topic: quickstart
11-
ms.date: 07/26/2019
11+
ms.date: 11/19/2019
1212
ms.author: aahi
1313
---
1414

@@ -21,12 +21,12 @@ Use this quickstart to start using the Anomaly Detector API's two detection mode
2121
| Detect anomalies as a batch | The JSON response containing the anomaly status (and other data) for each data point in the time series data, and the positions of any detected anomalies. |
2222
| Detect the anomaly status of the latest data point | The JSON response containing the anomaly status (and other data) for the latest data point in the time series data. |
2323

24-
While this application is written in Java, the API is a RESTful web service compatible with most programming languages.
24+
While this application is written in Java, the API is a RESTful web service compatible with most programming languages. You can find the source code for this quickstart on [GitHub](https://github.com/Azure-Samples/AnomalyDetector/blob/master/quickstarts/java-detect-anomalies.java).
2525

2626
## Prerequisites
2727

2828
- The [Java™ Development Kit(JDK) 7](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) or later.
29-
29+
- An Anomaly detector key and endpoint
3030
- Import these libraries from the Maven Repository
3131
- [JSON in Java](https://mvnrepository.com/artifact/org.json/json) package
3232
- [Apache HttpClient](https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient) package
@@ -66,7 +66,7 @@ Use this quickstart to start using the Anomaly Detector API's two detection mode
6666

6767
6. Create an `HttpEntity` object to store the response content. Get the content with `getEntity()`. If the response isn't empty, return it.
6868

69-
[!code-java[API request method](~/samples-anomaly-detector/quickstarts/java-detect-anomalies.java?name=request)]
69+
[!code-java[API request method](~/samples-anomaly-detector/quickstarts/java-detect-anomalies.java?name=request)]
7070

7171
## Detect anomalies as a batch
7272

@@ -76,11 +76,11 @@ Use this quickstart to start using the Anomaly Detector API's two detection mode
7676

7777
3. Otherwise, find the positions of anomalies in the data set. The response's `isAnomaly` field contains a boolean value relating to whether a given data point is an anomaly. Get the JSON array, and iterate through it, printing the index of any `true` values. These values correspond to the index of anomalous data points, if any were found.
7878

79-
[!code-java[Method for batch detection](~/samples-anomaly-detector/quickstarts/java-detect-anomalies.java?name=detectBatch)]
79+
[!code-java[Method for batch detection](~/samples-anomaly-detector/quickstarts/java-detect-anomalies.java?name=detectBatch)]
8080

8181
## Detect the anomaly status of the latest data point
8282

83-
* Create a method called `detectAnomaliesLatest()` to detect the anomaly status of the last data point in the data set. Call the `sendRequest()` method created above with your endpoint, url, subscription key, and json data. Get the result, and print it to the console.
83+
Create a method called `detectAnomaliesLatest()` to detect the anomaly status of the last data point in the data set. Call the `sendRequest()` method created above with your endpoint, url, subscription key, and json data. Get the result, and print it to the console.
8484

8585
[!code-java[Latest point detection method](~/samples-anomaly-detector/quickstarts/java-detect-anomalies.java?name=detectLatest)]
8686

@@ -90,19 +90,12 @@ Use this quickstart to start using the Anomaly Detector API's two detection mode
9090

9191
2. Call the two anomaly detection functions created above.
9292

93-
[!code-java[Main method](~/samples-anomaly-detector/quickstarts/java-detect-anomalies.java?name=main)]
93+
[!code-java[Main method](~/samples-anomaly-detector/quickstarts/java-detect-anomalies.java?name=main)]
9494

9595
### Example response
9696

9797
A successful response is returned in JSON format. Click the links below to view the JSON response on GitHub:
9898
* [Example batch detection response](https://github.com/Azure-Samples/anomalydetector/blob/master/example-data/batch-response.json)
9999
* [Example latest point detection response](https://github.com/Azure-Samples/anomalydetector/blob/master/example-data/latest-point-response.json)
100100

101-
## Next steps
102-
103-
> [!div class="nextstepaction"]
104-
>[Streaming anomaly detection with Azure Databricks](../tutorials/anomaly-detection-streaming-databricks.md)
105-
106-
* What is the [Anomaly Detector API?](../overview.md)
107-
* [Best practices](../concepts/anomaly-detection-best-practices.md) when using the Anomaly Detector API.
108-
* The source code for this sample can be found on [GitHub](https://github.com/Azure-Samples/AnomalyDetector/blob/master/quickstarts/sdk/csharp-sdk-sample.cs).
101+
[!INCLUDE [anomaly-detector-next-steps](../includes/quickstart-cleanup-next-steps.md)]

articles/cognitive-services/Anomaly-Detector/quickstarts/detect-data-anomalies-nodejs-sdk.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: anomaly-detector
1010
ms.topic: quickstart
11-
ms.date: 09/17/2019
11+
ms.date: 11/19/2019
1212
ms.author: aahi
1313
---
1414

@@ -21,12 +21,13 @@ Use the Anomaly Detector client library for Node.js to:
2121
* Detect anomalies throughout your time series dataset, as a batch request
2222
* Detect the anomaly status of the latest data point in your time series
2323

24-
[Reference documentation](https://docs.microsoft.com/javascript/api/@azure/cognitiveservices-anomalydetector/?view=azure-node-latest) | [Library source code](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/cognitiveservices/AnomalyDetector) | [Package (npm)](https://www.npmjs.com/package/@azure/cognitiveservices-anomalydetector) | [Code samples](https://github.com/Azure-Samples/anomalydetector)
24+
[Reference documentation](https://docs.microsoft.com/javascript/api/@azure/cognitiveservices-anomalydetector/?view=azure-node-latest) | [Library source code](https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/cognitiveservices/AnomalyDetector) | [Package (npm)](https://www.npmjs.com/package/@azure/cognitiveservices-anomalydetector) | [Find the code on GitHub](https://github.com/Azure-Samples/cognitive-services-quickstart-code/tree/master/javascript/AnomalyDetector)
2525

2626
## Prerequisites
2727

2828
* Azure subscription - [Create one for free](https://azure.microsoft.com/free/)
2929
* The current version of [Node.js](https://nodejs.org/)
30+
* An Anomaly detector key and endpoint
3031

3132
## Setting up
3233

@@ -122,18 +123,4 @@ Run the application with the `node` command on your quickstart file.
122123
node index.js
123124
```
124125

125-
## Clean up resources
126-
127-
If you want to clean up and remove a Cognitive Services subscription, you can delete the resource or resource group. Deleting the resource group also deletes any other resources associated with it.
128-
129-
* [Portal](../../cognitive-services-apis-create-account.md#clean-up-resources)
130-
* [Azure CLI](../../cognitive-services-apis-create-account-cli.md#clean-up-resources)
131-
132-
## Next steps
133-
134-
> [!div class="nextstepaction"]
135-
>[Streaming anomaly detection with Azure Databricks](../tutorials/anomaly-detection-streaming-databricks.md)
136-
137-
* What is the [Anomaly Detector API?](../overview.md)
138-
* [Best practices](../concepts/anomaly-detection-best-practices.md) when using the Anomaly Detector API.
139-
* The source code for this sample can be found on [GitHub](https://github.com/Azure-Samples/AnomalyDetector/blob/master/quickstarts/sdk/csharp-sdk-sample.cs).
126+
[!INCLUDE [anomaly-detector-next-steps](../includes/quickstart-cleanup-next-steps.md)]

articles/cognitive-services/Anomaly-Detector/quickstarts/detect-data-anomalies-python-sdk.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: anomaly-detector
1010
ms.topic: quickstart
11-
ms.date: 10/15/2019
11+
ms.date: 11/19/2019
1212
ms.author: aahi
1313
---
1414

@@ -21,11 +21,12 @@ Use the Anomaly Detector client library for Python to:
2121
* Detect anomalies throughout your time series dataset, as a batch request
2222
* Detect the anomaly status of the latest data point in your time series
2323

24-
[Library reference documentation](https://docs.microsoft.com/python/api/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector?view=azure-python) | [Library source code](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cognitiveservices/azure-cognitiveservices-anomalydetector) | [Package (PyPi)](https://pypi.org/project/azure-cognitiveservices-anomalydetector/) | [Code samples](https://github.com/Azure-Samples/anomalydetector)
24+
[Library reference documentation](https://docs.microsoft.com/python/api/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector?view=azure-python) | [Library source code](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cognitiveservices/azure-cognitiveservices-anomalydetector) | [Package (PyPi)](https://pypi.org/project/azure-cognitiveservices-anomalydetector/) | [Find the sample code on GitHub](https://github.com/Azure-Samples/AnomalyDetector/blob/master/quickstarts/sdk/python-sdk-sample.py)
2525

2626
## Prerequisites
2727

2828
* Azure subscription - [Create one for free](https://azure.microsoft.com/free/)
29+
* An Anomaly detector key and endpoint
2930
* [Python 3.x](https://www.python.org/)
3031
* The [Pandas data analysis library](https://pandas.pydata.org/)
3132

@@ -109,18 +110,4 @@ Call the Anomaly Detector API to determine if your latest data point is an anoma
109110

110111
Run the application with the `python` command and your file name.
111112

112-
## Clean up resources
113-
114-
If you want to clean up and remove a Cognitive Services subscription, you can delete the resource or resource group. Deleting the resource group also deletes any other resources associated with the resource group.
115-
116-
* [Portal](../../cognitive-services-apis-create-account.md#clean-up-resources)
117-
* [Azure CLI](../../cognitive-services-apis-create-account-cli.md#clean-up-resources)
118-
119-
## Next steps
120-
121-
> [!div class="nextstepaction"]
122-
>[Streaming anomaly detection with Azure Databricks](../tutorials/anomaly-detection-streaming-databricks.md)
123-
124-
* What is the [Anomaly Detector API?](../overview.md)
125-
* [Best practices](../concepts/anomaly-detection-best-practices.md) when using the Anomaly Detector API.
126-
* The source code for this sample can be found on [GitHub](https://github.com/Azure-Samples/AnomalyDetector/blob/master/quickstarts/sdk/csharp-sdk-sample.cs).
113+
[!INCLUDE [anomaly-detector-next-steps](../includes/quickstart-cleanup-next-steps.md)]

0 commit comments

Comments
 (0)