Skip to content

Commit e7d2d8c

Browse files
suxi-mssuxi-ms
authored
Add multidimensional Root Cause Analysis APIs in Anomaly Detector Service (#18037)
* add multidimentional RCA API * update to 4 tab * update swagger * update swagger with kind * update * update wording * add derived decoration * update schema definition * add more polymorphism * update create dataset * add kin for train, inference, data * update * update * update * update according to review * update query filter * remove nextLinkName * add error code * update * update verion so v1.2-preview * update spelling * update list partition meta * update * update version * update partition * update * update * merge with 1.1-preview.1 version * update * sync with 1.1-preview.1 * update train response * update inference * update version * update description of timestamp * update * update readme * update * update version * update * add x-ms-error-code * update filter description * add 201 response and add kind list * update * update * update comment * update * update * update * upate * format * add emtpy line at end of file * add dataset Id in required for dataset * update * update
1 parent d045209 commit e7d2d8c

36 files changed

+68822
-2
lines changed

‎specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/AnomalyDetector.json‎

Lines changed: 597 additions & 0 deletions
Large diffs are not rendered by default.

‎specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/MultivariateAnomalyDetector.json‎

Lines changed: 1222 additions & 0 deletions
Large diffs are not rendered by default.

‎specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/RootCauseAnalysis.json‎

Lines changed: 44410 additions & 0 deletions
Large diffs are not rendered by default.

‎specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/ChangePointDetect.json‎

Lines changed: 1570 additions & 0 deletions
Large diffs are not rendered by default.

‎specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisDataSet.json‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "{Endpoint}",
4+
"Ocp-Apim-Subscription-Key": "{API key}",
5+
"dataSetId": "01234567-8901-2345-6789-012345678901",
6+
"Content-Type": "application/json",
7+
"body": {
8+
"granularity": "daily",
9+
"customInterval": 1,
10+
"dimensionKeys": [
11+
"Region",
12+
"Platform"
13+
],
14+
"aggregatedIdentifier": "__AGG__",
15+
"measures": [
16+
{
17+
"displayName": "Failure Rate"
18+
},
19+
{
20+
"displayName": "Error Count"
21+
},
22+
{
23+
"displayName": "Total Count"
24+
}
25+
],
26+
"displayName": "Sample Multidimensional Root Cause Analysis Dataset Name",
27+
"kind": "multidimensional"
28+
}
29+
},
30+
"responses": {
31+
"201": {
32+
"headers": {
33+
"Location": ""
34+
}
35+
}
36+
}
37+
}

‎specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisInferenceTask.json‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "{Endpoint}",
4+
"Ocp-Apim-Subscription-Key": "{API key}",
5+
"instanceId": "11111111-2222-3333-4444-000000000000",
6+
"modelId": "11223344-5555-6666-7777-000000000000",
7+
"inferenceId": "11111111-1111-1111-1111-000000000000",
8+
"Content-Type": "application/json",
9+
"body": {
10+
"kind": "multidimensional",
11+
"parameter": {
12+
"timestamp": "2021-06-04T00:00:00.000Z",
13+
"dimensionScope": {}
14+
}
15+
}
16+
},
17+
"responses": {
18+
"201": {
19+
"body": {
20+
"inferenceId": "11111111-1111-1111-1111-000000000000",
21+
"instanceId": "11111111-2222-3333-4444-000000000000",
22+
"modelId": "11223344-5555-6666-7777-000000000000",
23+
"kind": "multidimensional",
24+
"status": "scheduled",
25+
"createdDateTime": "2021-12-01T00:00:00.000Z",
26+
"lastModifiedDateTime": "2021-12-01T00:00:00.000Z",
27+
"parameter": {
28+
"timestamp": "2021-06-04T00:00:00.000Z",
29+
"dimensionScope": {}
30+
}
31+
}
32+
}
33+
}
34+
}

‎specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisInstance.json‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "{Endpoint}",
4+
"Ocp-Apim-Subscription-Key": "{API key}",
5+
"instanceId": "11111111-2222-3333-4444-000000000000",
6+
"Content-Type": "application/json",
7+
"body": {
8+
"targetMeasure": {
9+
"dataSetId": "01234567-8901-2345-6789-012345678901",
10+
"measureName": "Failure Rate"
11+
},
12+
"assistiveMeasures": [
13+
{
14+
"dataSetId": "01234567-8901-2345-6789-012345678901",
15+
"measureName": "Error Count"
16+
},
17+
{
18+
"dataSetId": "01234567-8901-2345-6789-012345678901",
19+
"measureName": "Total Count"
20+
}
21+
],
22+
"displayName": "Sample Root Cause Analysis Instance Name",
23+
"kind": "multidimensional"
24+
}
25+
},
26+
"responses": {
27+
"201": {
28+
"headers": {
29+
"Location": ""
30+
}
31+
}
32+
}
33+
}

‎specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisTrainingTask.json‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "{Endpoint}",
4+
"Ocp-Apim-Subscription-Key": "{API key}",
5+
"instanceId": "11111111-2222-3333-4444-000000000000",
6+
"modelId": "11223344-5555-6666-7777-000000000000",
7+
"Content-Type": "application/json",
8+
"body": {
9+
"displayName": "Sample Root Cause Analysis Model Name",
10+
"kind": "multidimensional",
11+
"parameter": {
12+
"startDateTime": "2021-05-01T00:00:00.000Z",
13+
"endDateTime": "2021-09-01T00:00:00.000Z"
14+
}
15+
}
16+
},
17+
"responses": {
18+
"201": {
19+
"body": {
20+
"taskId": "11111111-1111-4444-4444-000000000000",
21+
"instanceId": "11111111-2222-3333-4444-000000000000",
22+
"modelId": "11223344-5555-6666-7777-000000000000",
23+
"displayName": "Sample Root Cause Analysis Model Name",
24+
"kind": "multidimensional",
25+
"status": "scheduled",
26+
"createdDateTime": "2021-12-01T00:00:00.000Z",
27+
"lastModifiedDateTime": "2021-12-01T00:00:00.000Z",
28+
"parameter": {
29+
"startDateTime": "2021-05-01T00:00:00.000Z",
30+
"endDateTime": "2021-09-01T00:00:00.000Z"
31+
}
32+
}
33+
}
34+
}
35+
}

‎specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/DeleteModel.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "{Endpoint}",
4+
"ApiVersion": "v1.1-preview.1",
5+
"Content-Type": "application/json",
6+
"Ocp-Apim-Subscription-Key": "{API key}",
7+
"modelId": "45aad126-aafd-11ea-b8fb-d89ef3400c5f",
8+
"body": {}
9+
},
10+
"responses": {
11+
"204": {},
12+
"default": {
13+
"headers": {
14+
"Content-Type": "application/json",
15+
"x-ms-error-code": "Error Code"
16+
},
17+
"body": {
18+
"code": "Error Code",
19+
"message": "Error Message"
20+
}
21+
}
22+
}
23+
}

‎specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/DeleteRootCauseAnalysisDataByPartitionId.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"parameters": {
3+
"Endpoint": "{Endpoint}",
4+
"Ocp-Apim-Subscription-Key": "{API key}",
5+
"dataSetId": "01234567-8901-2345-6789-012345678901",
6+
"timestamp": "2022-01-02T08:00:00.000Z",
7+
"partitionId": "11234567-8901-2345-6789-012345678901"
8+
},
9+
"responses": {
10+
"204": {}
11+
}
12+
}

0 commit comments

Comments
 (0)