Users/sharathm/putmodelapi (#17386)

* Put Model api for Personalizer * Moved api to v1.1-preview.3 and renamed api from model to signedmodel * Change api to allowed downloading signed and unsigned models. * Updates to add new parameter for signed for Get model api * Renamed example file reference * Fixed errors in model validation. * Fixed errors from prettier check. * Changed examples to match the generated files. * Manual updates to address breaking change issues * Updated as per feedback from api review meeting * Added description for Ocp-Apim-Subscription-Key * Renamed Evaluation_Apply to Evaluations_Apply * Reverting back the renaming operation since it was done in error. * Add description for body parameter of model/put call Co-authored-by: Decision Service <[email protected]>
Azure · Feb 17, 2022 · 0f3093e · 0f3093e
1 parent b4215a3
commit 0f3093e
Show file tree

Hide file tree

Showing 26 changed files with 2,638 additions and 0 deletions.
diff --git a/...cation/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/Personalizer.json b/...cation/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/Personalizer.json
diff --git a/...eservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Create.json b/...eservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Create.json
@@ -0,0 +1,43 @@
+{
+  "parameters": {
+    "evaluation": {
+      "enableOfflineExperimentation": true,
+      "name": "myFirstEvaluation",
+      "startTime": "2018-12-19T00:00:00Z",
+      "endTime": "2019-01-19T00:00:00Z",
+      "policies": [
+        {
+          "name": "Custom learning settings 1",
+          "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5"
+        }
+      ]
+    },
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Endpoint": "{Endpoint}"
+  },
+  "responses": {
+    "201": {
+      "body": {
+        "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a",
+        "name": "myFirstEvaluation",
+        "startTime": "2018-12-19T00:00:00Z",
+        "endTime": "2019-01-19T00:00:00Z",
+        "status": "pending",
+        "policyResults": [
+          {
+            "name": "Custom learning settings 1",
+            "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5",
+            "policySource": "Online"
+          }
+        ],
+        "featureImportance": [],
+        "evaluationType": "Manual",
+        "optimalPolicy": "",
+        "creationTime": "2019-01-20T00:00:00Z"
+      },
+      "headers": {
+        "Location": "{endpoint}/personalizer/v1.1-preview.3/evaluations/{evaluationId}"
+      }
+    }
+  }
+}
diff --git a/...eservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Delete.json b/...eservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Delete.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Endpoint": "{Endpoint}",
+    "evaluationId": "id"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...tiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Get.json b/...tiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Get.json
@@ -0,0 +1,74 @@
+{
+  "parameters": {
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Endpoint": "{Endpoint}",
+    "evaluationId": "id"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a",
+        "name": "myFirstEvaluation",
+        "startTime": "2018-12-19T00:00:00Z",
+        "endTime": "2019-01-19T00:00:00Z",
+        "status": "completed",
+        "policyResults": [
+          {
+            "name": "Custom learning settings 1",
+            "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5",
+            "policySource": "Custom",
+            "summary": [
+              {
+                "timeStamp": "2018-12-19T00:00:00Z",
+                "ipsEstimatorNumerator": 0,
+                "ipsEstimatorDenominator": 170,
+                "snipsEstimatorDenominator": 308.25,
+                "aggregateTimeWindow": "PT0S",
+                "nonZeroProbability": 64,
+                "sumOfSquares": 0,
+                "confidenceInterval": 0,
+                "averageReward": 0
+              },
+              {
+                "timeStamp": "2018-12-19T00:05:00Z",
+                "ipsEstimatorNumerator": 2.2,
+                "ipsEstimatorDenominator": 196,
+                "snipsEstimatorDenominator": 193.761,
+                "aggregateTimeWindow": "PT0S",
+                "nonZeroProbability": 68,
+                "sumOfSquares": 2.424,
+                "confidenceInterval": 0.015529361,
+                "averageReward": 0.01122449
+              }
+            ],
+            "totalSummary": {
+              "timeStamp": "2019-01-19T00:00:00Z",
+              "ipsEstimatorNumerator": 22.2,
+              "ipsEstimatorDenominator": 1906,
+              "snipsEstimatorDenominator": 1993.761,
+              "aggregateTimeWindow": "PT0S",
+              "nonZeroProbability": 68,
+              "sumOfSquares": 2.484,
+              "confidenceInterval": 0.0015344538,
+              "averageReward": 0.011647429
+            }
+          }
+        ],
+        "featureImportance": [
+          [
+            "f1",
+            "f2"
+          ],
+          [
+            "f3",
+            "f4"
+          ]
+        ],
+        "evaluationType": "Manual",
+        "optimalPolicy": "Custom learning settings 1",
+        "creationTime": "2019-01-20T00:00:00Z"
+      },
+      "headers": {}
+    }
+  }
+}
diff --git a/...iveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_List.json b/...iveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_List.json
@@ -0,0 +1,54 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}"
+  },
+  "responses": {
+    "200": {
+      "body": [
+        {
+          "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a",
+          "name": "myFirstEvaluation",
+          "startTime": "2018-11-19T00:00:00Z",
+          "endTime": "2018-12-19T00:00:00Z",
+          "status": "completed",
+          "policyResults": [
+            {
+              "name": "Custom learning settings 1",
+              "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5",
+              "policySource": "Online",
+              "totalSummary": {
+                "timeStamp": "2018-12-19T00:00:00Z",
+                "ipsEstimatorNumerator": 18,
+                "ipsEstimatorDenominator": 36,
+                "snipsEstimatorDenominator": 1,
+                "aggregateTimeWindow": "PT0S",
+                "nonZeroProbability": 1.1,
+                "sumOfSquares": 12.28,
+                "confidenceInterval": 0.100001775,
+                "averageReward": 0.5
+              }
+            }
+          ],
+          "featureImportance": [],
+          "evaluationType": "Manual",
+          "optimalPolicy": "Custom learning settings 1",
+          "creationTime": "2019-01-19T00:00:00Z"
+        },
+        {
+          "id": "21d03972-9130-4be9-8c8b-8ac3ec9b9dd1",
+          "name": "mySecondEvaluation",
+          "startTime": "2018-12-19T00:00:00Z",
+          "endTime": "2019-01-19T00:00:00Z",
+          "status": "pending",
+          "policyResults": [],
+          "featureImportance": [],
+          "evaluationType": "Manual",
+          "optimalPolicy": "",
+          "creationTime": "2019-01-19T00:00:00Z"
+        }
+      ],
+      "headers": {}
+    }
+  }
+}
diff --git a/...tiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Events_Activate.json b/...tiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Events_Activate.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Endpoint": "{Endpoint}",
+    "eventId": "id"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...nitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Events_Reward.json b/...nitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Events_Reward.json
@@ -0,0 +1,13 @@
+{
+  "parameters": {
+    "reward": {
+      "value": 1
+    },
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Endpoint": "{Endpoint}",
+    "eventId": "id"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Delete.json b/...cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Delete.json
@@ -0,0 +1,9 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...veservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_GetProperties.json b/...veservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_GetProperties.json
@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "dateRange": {
+          "from": "2019-01-18T16:00:00-08:00",
+          "to": "2019-02-18T16:00:00-08:00"
+        }
+      },
+      "headers": {}
+    }
+  }
+}
diff --git a/...iveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Interactions.json b/...iveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Interactions.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "body": "id",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Endpoint": "{Endpoint}"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...iveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Observations.json b/...iveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Observations.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "body": "id",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Endpoint": "{Endpoint}"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/.../cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Get.json b/.../cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Get.json
@@ -0,0 +1,13 @@
+{
+  "parameters": {
+    "signed": false,
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Endpoint": "{Endpoint}"
+  },
+  "responses": {
+    "200": {
+      "body": "",
+      "headers": {}
+    }
+  }
+}
diff --git a/...services/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_GetProperties.json b/...services/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_GetProperties.json
@@ -0,0 +1,15 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "creationTime": "2019-01-18T16:00:00-08:00",
+        "lastModifiedTime": "2019-01-18T16:00:00-08:00"
+      },
+      "headers": {}
+    }
+  }
+}
diff --git a/...gnitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Import.json b/...gnitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Import.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "body": "id",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Endpoint": "{Endpoint}"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...ognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Reset.json b/...ognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Reset.json
@@ -0,0 +1,9 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "{API key}"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...ces/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlotEvents_Activate.json b/...ces/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlotEvents_Activate.json
@@ -0,0 +1,10 @@
+{
+  "parameters": {
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Endpoint": "{Endpoint}",
+    "eventId": "id"
+  },
+  "responses": {
+    "204": {}
+  }
+}
diff --git a/...vices/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlotEvents_Reward.json b/...vices/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlotEvents_Reward.json
@@ -0,0 +1,22 @@
+{
+  "parameters": {
+    "body": {
+      "reward": [
+        {
+          "slotId": "Heroposition",
+          "value": 0.5
+        },
+        {
+          "slotId": "SideBar",
+          "value": 0.6
+        }
+      ]
+    },
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "Endpoint": "{Endpoint}",
+    "eventId": "id"
+  },
+  "responses": {
+    "204": {}
+  }
+}