AnomalyDetector.EE
Project "Gualala"
Update anomaly detection configuration
Update anomaly detection configuration
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request parameters
string
Format - uuid. anomaly detection configuration unique id
Request headers
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.
Request body
anomaly detection configuration
{
"name": "Anomaly detection configuration name",
"description": "Anomaly detection configuration description",
"wholeMetricConfiguration": {
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
},
"dimensionGroupOverrideConfigurations": [
{
"group": {
"dimension": {
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
],
"seriesOverrideConfigurations": [
{
"series": {
"dimension": {
"category": "Jewelry",
"city": "Beijing"
}
},
"conditionOperator": "AND",
"smartDetectionCondition": {
"sensitivity": 91,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"hardThresholdCondition": {
"lowerBound": 1,
"upperBound": 100,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
},
"changeThresholdCondition": {
"changePercentage": 5,
"shiftPoint": 1,
"withinRange": false,
"anomalyDetectorDirection": "Both",
"suppressCondition": {
"minNumber": 1,
"minRatio": 100
}
}
}
]
}
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "anomaly detection configuration name",
"nullable": true
},
"description": {
"type": "string",
"description": "anomaly detection configuration description",
"nullable": true
},
"wholeMetricConfiguration": {
"required": [
"conditionOperator"
],
"type": "object",
"properties": {
"conditionOperator": {
"enum": [
"AND",
"OR"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectionConfigurationLogicType",
"modelAsString": true
}
},
"smartDetectionCondition": {
"required": [
"anomalyDetectorDirection",
"sensitivity",
"suppressCondition"
],
"type": "object",
"properties": {
"sensitivity": {
"type": "number",
"description": "sensitivity, value range : (0, 100]",
"format": "double"
},
"anomalyDetectorDirection": {
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"type": "integer",
"description": "min point number, value range : [1, +∞)",
"format": "int32"
},
"minRatio": {
"type": "number",
"description": "min point ratio, value range : (0, 100]",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"hardThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"suppressCondition"
],
"type": "object",
"properties": {
"lowerBound": {
"type": "number",
"description": "lower bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Down",
"format": "double",
"nullable": true
},
"upperBound": {
"type": "number",
"description": "upper bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Up",
"format": "double",
"nullable": true
},
"anomalyDetectorDirection": {
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"type": "integer",
"description": "min point number, value range : [1, +∞)",
"format": "int32"
},
"minRatio": {
"type": "number",
"description": "min point ratio, value range : (0, 100]",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"changeThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"changePercentage",
"shiftPoint",
"suppressCondition",
"withinRange"
],
"type": "object",
"properties": {
"changePercentage": {
"type": "number",
"description": "change percentage, value range : [0, +∞)",
"format": "double"
},
"shiftPoint": {
"type": "integer",
"description": "shift point, value range : [1, +∞)",
"format": "int32"
},
"withinRange": {
"type": "boolean",
"description": "if the withinRange = true, detected data is abnormal when the value falls in the range, in this case anomalyDetectorDirection must be Both\r\nif the withinRange = false, detected data is abnormal when the value falls out of the range"
},
"anomalyDetectorDirection": {
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"type": "integer",
"description": "min point number, value range : [1, +∞)",
"format": "int32"
},
"minRatio": {
"type": "number",
"description": "min point ratio, value range : (0, 100]",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"dimensionGroupOverrideConfigurations": {
"uniqueItems": true,
"type": "array",
"items": {
"required": [
"conditionOperator",
"group"
],
"type": "object",
"properties": {
"group": {
"required": [
"dimension"
],
"type": "object",
"properties": {
"dimension": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "dimension specified for series group"
}
},
"additionalProperties": false
},
"conditionOperator": {
"enum": [
"AND",
"OR"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectionConfigurationLogicType",
"modelAsString": true
}
},
"smartDetectionCondition": {
"required": [
"anomalyDetectorDirection",
"sensitivity",
"suppressCondition"
],
"type": "object",
"properties": {
"sensitivity": {
"type": "number",
"description": "sensitivity, value range : (0, 100]",
"format": "double"
},
"anomalyDetectorDirection": {
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"type": "integer",
"description": "min point number, value range : [1, +∞)",
"format": "int32"
},
"minRatio": {
"type": "number",
"description": "min point ratio, value range : (0, 100]",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"hardThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"suppressCondition"
],
"type": "object",
"properties": {
"lowerBound": {
"type": "number",
"description": "lower bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Down",
"format": "double",
"nullable": true
},
"upperBound": {
"type": "number",
"description": "upper bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Up",
"format": "double",
"nullable": true
},
"anomalyDetectorDirection": {
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"type": "integer",
"description": "min point number, value range : [1, +∞)",
"format": "int32"
},
"minRatio": {
"type": "number",
"description": "min point ratio, value range : (0, 100]",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"changeThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"changePercentage",
"shiftPoint",
"suppressCondition",
"withinRange"
],
"type": "object",
"properties": {
"changePercentage": {
"type": "number",
"description": "change percentage, value range : [0, +∞)",
"format": "double"
},
"shiftPoint": {
"type": "integer",
"description": "shift point, value range : [1, +∞)",
"format": "int32"
},
"withinRange": {
"type": "boolean",
"description": "if the withinRange = true, detected data is abnormal when the value falls in the range, in this case anomalyDetectorDirection must be Both\r\nif the withinRange = false, detected data is abnormal when the value falls out of the range"
},
"anomalyDetectorDirection": {
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"type": "integer",
"description": "min point number, value range : [1, +∞)",
"format": "int32"
},
"minRatio": {
"type": "number",
"description": "min point ratio, value range : (0, 100]",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"description": "detection configuration for series group",
"nullable": true
},
"seriesOverrideConfigurations": {
"uniqueItems": true,
"type": "array",
"items": {
"required": [
"conditionOperator",
"series"
],
"type": "object",
"properties": {
"series": {
"required": [
"dimension"
],
"type": "object",
"properties": {
"dimension": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "dimension specified for series"
}
},
"additionalProperties": false
},
"conditionOperator": {
"enum": [
"AND",
"OR"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectionConfigurationLogicType",
"modelAsString": true
}
},
"smartDetectionCondition": {
"required": [
"anomalyDetectorDirection",
"sensitivity",
"suppressCondition"
],
"type": "object",
"properties": {
"sensitivity": {
"type": "number",
"description": "sensitivity, value range : (0, 100]",
"format": "double"
},
"anomalyDetectorDirection": {
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"type": "integer",
"description": "min point number, value range : [1, +∞)",
"format": "int32"
},
"minRatio": {
"type": "number",
"description": "min point ratio, value range : (0, 100]",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"hardThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"suppressCondition"
],
"type": "object",
"properties": {
"lowerBound": {
"type": "number",
"description": "lower bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Down",
"format": "double",
"nullable": true
},
"upperBound": {
"type": "number",
"description": "upper bound\r\n\r\nshould be specified when anomalyDetectorDirection is Both or Up",
"format": "double",
"nullable": true
},
"anomalyDetectorDirection": {
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"type": "integer",
"description": "min point number, value range : [1, +∞)",
"format": "int32"
},
"minRatio": {
"type": "number",
"description": "min point ratio, value range : (0, 100]",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"changeThresholdCondition": {
"required": [
"anomalyDetectorDirection",
"changePercentage",
"shiftPoint",
"suppressCondition",
"withinRange"
],
"type": "object",
"properties": {
"changePercentage": {
"type": "number",
"description": "change percentage, value range : [0, +∞)",
"format": "double"
},
"shiftPoint": {
"type": "integer",
"description": "shift point, value range : [1, +∞)",
"format": "int32"
},
"withinRange": {
"type": "boolean",
"description": "if the withinRange = true, detected data is abnormal when the value falls in the range, in this case anomalyDetectorDirection must be Both\r\nif the withinRange = false, detected data is abnormal when the value falls out of the range"
},
"anomalyDetectorDirection": {
"enum": [
"Both",
"Down",
"Up"
],
"type": "string",
"x-ms-enum": {
"name": "AnomalyDetectorDirection",
"modelAsString": true
}
},
"suppressCondition": {
"required": [
"minNumber",
"minRatio"
],
"type": "object",
"properties": {
"minNumber": {
"type": "integer",
"description": "min point number, value range : [1, +∞)",
"format": "int32"
},
"minRatio": {
"type": "number",
"description": "min point ratio, value range : (0, 100]",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"description": "detection configuration for specific series",
"nullable": true
}
},
"additionalProperties": false
}
Response 204
Success
Response 400
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
{
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"code": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Response 500
Client error or server error (4xx or 5xx)
{
"message": "string",
"code": 0
}
{
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"code": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
Code samples
@ECHO OFF
curl -v -X PATCH "https://*.cognitiveservices.azure.us/anomalydetector-ee/v1.0/enrichment/anomalyDetection/configurations/{configurationId}"
-H "Content-Type: application/json-merge-patch"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://*.cognitiveservices.azure.us/anomalydetector-ee/v1.0/enrichment/anomalyDetection/configurations/{configurationId}?" + queryString;
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://*.cognitiveservices.azure.us/anomalydetector-ee/v1.0/enrichment/anomalyDetection/configurations/{configurationId}");
URI uri = builder.build();
HttpPatch request = new HttpPatch(uri);
request.setHeader("Content-Type", "application/json-merge-patch");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://*.cognitiveservices.azure.us/anomalydetector-ee/v1.0/enrichment/anomalyDetection/configurations/{configurationId}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json-merge-patch");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "PATCH",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://*.cognitiveservices.azure.us/anomalydetector-ee/v1.0/enrichment/anomalyDetection/configurations/{configurationId}";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"PATCH"];
// Request headers
[_request setValue:@"application/json-merge-patch" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://*.cognitiveservices.azure.us/anomalydetector-ee/v1.0/enrichment/anomalyDetection/configurations/{configurationId}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json-merge-patch',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_PATCH);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json-merge-patch',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.us')
conn.request("PATCH", "/anomalydetector-ee/v1.0/enrichment/anomalyDetection/configurations/{configurationId}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json-merge-patch',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.us')
conn.request("PATCH", "/anomalydetector-ee/v1.0/enrichment/anomalyDetection/configurations/{configurationId}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://*.cognitiveservices.azure.us/anomalydetector-ee/v1.0/enrichment/anomalyDetection/configurations/{configurationId}')
uri.query = URI.encode_www_form({
})
request = Net::HTTP::Patch.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-merge-patch'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body