Add multidimensional Root Cause Analysis APIs in Anomaly Detector Ser…

…vice (#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
Azure · Apr 7, 2022 · e7d2d8c · e7d2d8c
1 parent d045209
commit e7d2d8c
Show file tree

Hide file tree

Showing 36 changed files with 68,822 additions and 2 deletions.
diff --git a/.../cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/AnomalyDetector.json b/.../cognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/AnomalyDetector.json
diff --git a/...rvices/data-plane/AnomalyDetector/preview/v1.1-preview.2/MultivariateAnomalyDetector.json b/...rvices/data-plane/AnomalyDetector/preview/v1.1-preview.2/MultivariateAnomalyDetector.json
diff --git a/...ognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/RootCauseAnalysis.json b/...ognitiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/RootCauseAnalysis.json
diff --git a/...ervices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/ChangePointDetect.json b/...ervices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/ChangePointDetect.json
diff --git a/...plane/AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisDataSet.json b/...plane/AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisDataSet.json
@@ -0,0 +1,37 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "dataSetId": "01234567-8901-2345-6789-012345678901",
+    "Content-Type": "application/json",
+    "body": {
+      "granularity": "daily",
+      "customInterval": 1,
+      "dimensionKeys": [
+        "Region",
+        "Platform"
+      ],
+      "aggregatedIdentifier": "__AGG__",
+      "measures": [
+        {
+          "displayName": "Failure Rate"
+        },
+        {
+          "displayName": "Error Count"
+        },
+        {
+          "displayName": "Total Count"
+        }
+      ],
+      "displayName": "Sample Multidimensional Root Cause Analysis Dataset Name",
+      "kind": "multidimensional"
+    }
+  },
+  "responses": {
+    "201": {
+      "headers": {
+        "Location": ""
+      }
+    }
+  }
+}
diff --git a/...AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisInferenceTask.json b/...AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisInferenceTask.json
@@ -0,0 +1,34 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "instanceId": "11111111-2222-3333-4444-000000000000",
+    "modelId": "11223344-5555-6666-7777-000000000000",
+    "inferenceId": "11111111-1111-1111-1111-000000000000",
+    "Content-Type": "application/json",
+    "body": {
+      "kind": "multidimensional",
+      "parameter": {
+        "timestamp": "2021-06-04T00:00:00.000Z",
+        "dimensionScope": {}
+      }
+    }
+  },
+  "responses": {
+    "201": {
+      "body": {
+        "inferenceId": "11111111-1111-1111-1111-000000000000",
+        "instanceId": "11111111-2222-3333-4444-000000000000",
+        "modelId": "11223344-5555-6666-7777-000000000000",
+        "kind": "multidimensional",
+        "status": "scheduled",
+        "createdDateTime": "2021-12-01T00:00:00.000Z",
+        "lastModifiedDateTime": "2021-12-01T00:00:00.000Z",
+        "parameter": {
+          "timestamp": "2021-06-04T00:00:00.000Z",
+          "dimensionScope": {}
+        }
+      }
+    }
+  }
+}
diff --git a/...lane/AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisInstance.json b/...lane/AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisInstance.json
@@ -0,0 +1,33 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "instanceId": "11111111-2222-3333-4444-000000000000",
+    "Content-Type": "application/json",
+    "body": {
+      "targetMeasure": {
+        "dataSetId": "01234567-8901-2345-6789-012345678901",
+        "measureName": "Failure Rate"
+      },
+      "assistiveMeasures": [
+        {
+          "dataSetId": "01234567-8901-2345-6789-012345678901",
+          "measureName": "Error Count"
+        },
+        {
+          "dataSetId": "01234567-8901-2345-6789-012345678901",
+          "measureName": "Total Count"
+        }
+      ],
+      "displayName": "Sample Root Cause Analysis Instance Name",
+      "kind": "multidimensional"
+    }
+  },
+  "responses": {
+    "201": {
+      "headers": {
+        "Location": ""
+      }
+    }
+  }
+}
diff --git a/.../AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisTrainingTask.json b/.../AnomalyDetector/preview/v1.1-preview.2/examples/CreateRootCauseAnalysisTrainingTask.json
@@ -0,0 +1,35 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "instanceId": "11111111-2222-3333-4444-000000000000",
+    "modelId": "11223344-5555-6666-7777-000000000000",
+    "Content-Type": "application/json",
+    "body": {
+      "displayName": "Sample Root Cause Analysis Model Name",
+      "kind": "multidimensional",
+      "parameter": {
+        "startDateTime": "2021-05-01T00:00:00.000Z",
+        "endDateTime": "2021-09-01T00:00:00.000Z"
+      }
+    }
+  },
+  "responses": {
+    "201": {
+      "body": {
+        "taskId": "11111111-1111-4444-4444-000000000000",
+        "instanceId": "11111111-2222-3333-4444-000000000000",
+        "modelId": "11223344-5555-6666-7777-000000000000",
+        "displayName": "Sample Root Cause Analysis Model Name",
+        "kind": "multidimensional",
+        "status": "scheduled",
+        "createdDateTime": "2021-12-01T00:00:00.000Z",
+        "lastModifiedDateTime": "2021-12-01T00:00:00.000Z",
+        "parameter": {
+          "startDateTime": "2021-05-01T00:00:00.000Z",
+          "endDateTime": "2021-09-01T00:00:00.000Z"
+        }
+      }
+    }
+  }
+}
diff --git a/...itiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/DeleteModel.json b/...itiveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/DeleteModel.json
@@ -0,0 +1,23 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "ApiVersion": "v1.1-preview.1",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "modelId": "45aad126-aafd-11ea-b8fb-d89ef3400c5f",
+    "body": {}
+  },
+  "responses": {
+    "204": {},
+    "default": {
+      "headers": {
+        "Content-Type": "application/json",
+        "x-ms-error-code": "Error Code"
+      },
+      "body": {
+        "code": "Error Code",
+        "message": "Error Message"
+      }
+    }
+  }
+}
diff --git a/...alyDetector/preview/v1.1-preview.2/examples/DeleteRootCauseAnalysisDataByPartitionId.json b/...alyDetector/preview/v1.1-preview.2/examples/DeleteRootCauseAnalysisDataByPartitionId.json
@@ -0,0 +1,12 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "dataSetId": "01234567-8901-2345-6789-012345678901",
+    "timestamp": "2022-01-02T08:00:00.000Z",
+    "partitionId": "11234567-8901-2345-6789-012345678901"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...omalyDetector/preview/v1.1-preview.2/examples/DeleteRootCauseAnalysisDataByTimeRange.json b/...omalyDetector/preview/v1.1-preview.2/examples/DeleteRootCauseAnalysisDataByTimeRange.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "dataSetId": "01234567-8901-2345-6789-012345678901"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...plane/AnomalyDetector/preview/v1.1-preview.2/examples/DeleteRootCauseAnalysisDataSet.json b/...plane/AnomalyDetector/preview/v1.1-preview.2/examples/DeleteRootCauseAnalysisDataSet.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "dataSetId": "01234567-8901-2345-6789-012345678901"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...lane/AnomalyDetector/preview/v1.1-preview.2/examples/DeleteRootCauseAnalysisInstance.json b/...lane/AnomalyDetector/preview/v1.1-preview.2/examples/DeleteRootCauseAnalysisInstance.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "instanceId": "11111111-2222-3333-4444-000000000000"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...a-plane/AnomalyDetector/preview/v1.1-preview.2/examples/DeleteRootCauseAnalysisModel.json b/...a-plane/AnomalyDetector/preview/v1.1-preview.2/examples/DeleteRootCauseAnalysisModel.json
@@ -0,0 +1,11 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "instanceId": "11111111-2222-3333-4444-000000000000",
+    "modelId": "11223344-5555-6666-7777-000000000000"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...iveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/DetectAnomaly.json b/...iveservices/data-plane/AnomalyDetector/preview/v1.1-preview.2/examples/DetectAnomaly.json
@@ -0,0 +1,31 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "ApiVersion": "v1.1-preview.1",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "modelId": "45aad126-aafd-11ea-b8fb-d89ef3400c5f",
+    "body": {
+      "source": "https://multiadsample.blob.core.windows.net/data/sample_data_2_1000.zip?sp=rl&st=2020-12-04T06:03:47Z&se=2022-12-05T06:03:00Z&sv=2019-12-12&sr=b&sig=AZTbvZ7fcp3MdqGY%2FvGHJXJjUgjS4DneCGl7U5omq5c%3D",
+      "startTime": "2019-04-01T00:15:00Z",
+      "endTime": "2019-04-01T00:40:00Z"
+    }
+  },
+  "responses": {
+    "201": {
+      "headers": {
+        "Location": "{Endpoint}/anomalydetector/v1.1-preview/multivariate/results/{resultId}"
+      }
+    },
+    "default": {
+      "headers": {
+        "Content-Type": "application/json",
+        "x-ms-error-code": "Error Code"
+      },
+      "body": {
+        "code": "Error Code",
+        "message": "Error Message"
+      }
+    }
+  }
+}