[Cogs Face] Align with latest released version of Face API with milli…

…on-scale features. (#3552) * Add large person group management. * Add large face list management. * Nit * Add find similar with large face list. * Add identify with large person group. * Add verify with large person group. * Fix typo of training status. * Add missing adding face to large face list & large person group. * Add missing large face list face operations. * Nit fix. * Rebase and update master's endpoint changes to examples. * Nit fix documentation. * Nit path case refinement. * Fix LargeFaceListFace_List to LargeFaceList_ListFaces and refine example naming. * [Minor] Person_AddPersonFace to Person_AddFace. * [Minor] Amend last commit of Person_AddPersonFace to Person_AddFace.
Azure · Aug 1, 2018 · 603513f · 603513f
1 parent 674c2ac
commit 603513f
Show file tree

Hide file tree

Showing 47 changed files with 1,860 additions and 68 deletions.
diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json
diff --git a/...ognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargeFaceListFaceFromStream.json b/...ognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargeFaceListFaceFromStream.json
@@ -0,0 +1,23 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/octet-stream",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largeFaceListId": "sample_face_list",
+    "userData": "{Customized user data}",
+    "targetFace": [
+      10,
+      10,
+      100,
+      100
+    ],
+    "Image": "{Image stream in base 64 encoded format}"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "persistedFaceId": "B8D802CF-DD8F-4E61-B15C-9E6C5844CCBA"
+      }
+    }
+  }
+}
diff --git a/...n/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargeFaceListFaceFromUrl.json b/...n/cognitiveservices/data-plane/Face/stable/v1.0/examples/AddLargeFaceListFaceFromUrl.json
@@ -0,0 +1,23 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largeFaceListId": "sample_face_list",
+    "userData": "{Customized user data}",
+    "targetFace": [
+      10,
+      10,
+      100,
+      100
+    ],
+    "ImageUrl": "{Image url}"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "persistedFaceId": "B8D802CF-DD8F-4E61-B15C-9E6C5844CCBA"
+      }
+    }
+  }
+}
diff --git a/...ervices/data-plane/Face/stable/v1.0/examples/AddLargePersonGroupPersonFaceFromStream.json b/...ervices/data-plane/Face/stable/v1.0/examples/AddLargePersonGroupPersonFaceFromStream.json
@@ -0,0 +1,24 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/octet-stream",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largePersonGroupId": "abc",
+    "personId": "4caa25ee-3bc6-4e88-adf8-12455ce7aab0",
+    "userData": "{customized User data}",
+    "targetFace": [
+      10,
+      10,
+      100,
+      100
+    ],
+    "Image": "{Image stream in base 64 encoded format}"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "persistedFaceId": "6e04c175-219e-42a2-9d26-0e7b790e1ef4"
+      }
+    }
+  }
+}
diff --git a/...veservices/data-plane/Face/stable/v1.0/examples/AddLargePersonGroupPersonFaceFromUrl.json b/...veservices/data-plane/Face/stable/v1.0/examples/AddLargePersonGroupPersonFaceFromUrl.json
@@ -0,0 +1,24 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largePersonGroupId": "abc",
+    "personId": "4caa25ee-3bc6-4e88-adf8-12455ce7aab0",
+    "userData": "{customized User data}",
+    "targetFace": [
+      10,
+      10,
+      100,
+      100
+    ],
+    "ImageUrl": "{Image url}"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "persistedFaceId": "6e04c175-219e-42a2-9d26-0e7b790e1ef4"
+      }
+    }
+  }
+}
diff --git a/...1.0/examples/AddPersonFaceFromStream.json → ...s/AddPersonGroupPersonFaceFromStream.json b/...1.0/examples/AddPersonFaceFromStream.json → ...s/AddPersonGroupPersonFaceFromStream.json
diff --git a/...e/v1.0/examples/AddPersonFaceFromUrl.json → ...ples/AddPersonGroupPersonFaceFromUrl.json b/...e/v1.0/examples/AddPersonFaceFromUrl.json → ...ples/AddPersonGroupPersonFaceFromUrl.json
diff --git a/...cation/cognitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewLargeFaceList.json b/...cation/cognitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewLargeFaceList.json
@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largeFaceListId": "sample_face_list",
+    "body": {
+      "name": "large-face-list-name",
+      "userData": "User-provided data attached to the large face list."
+    }
+  },
+  "responses": {
+    "200": {
+      "body": ""
+    }
+  }
+}
diff --git a/...ion/cognitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewLargePersonGroup.json b/...ion/cognitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewLargePersonGroup.json
@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largePersonGroupId": "abc",
+    "body": {
+      "name": "large-person-group-name",
+      "userData": "User-provided data attached to the large person group."
+    }
+  },
+  "responses": {
+    "200": {
+      "body": ""
+    }
+  }
+}
diff --git a/...gnitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewLargePersonGroupPerson.json b/...gnitiveservices/data-plane/Face/stable/v1.0/examples/CreateNewLargePersonGroupPerson.json
@@ -0,0 +1,19 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largePersonGroupId": "abc",
+    "body":{
+      "name": "mike",
+      "userData": "{additional data associated with mike}"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "personId": "4caa25ee-3bc6-4e88-adf8-12455ce7aab0"
+      }
+    }
+  }
+}
diff --git a/...stable/v1.0/examples/CreateNewPerson.json → .../examples/CreateNewPersonGroupPerson.json b/...stable/v1.0/examples/CreateNewPerson.json → .../examples/CreateNewPersonGroupPerson.json
diff --git a/...ification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteLargeFaceList.json b/...ification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteLargeFaceList.json
@@ -0,0 +1,13 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largeFaceListId": "sample_face_list"
+  },
+  "responses": {
+    "200": {
+      "body": ""
+    }
+  }
+}
diff --git a/...ation/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteLargeFaceListFace.json b/...ation/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteLargeFaceListFace.json
@@ -0,0 +1,14 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largeFaceListId": "sample_face_list",
+    "persistedFaceId":"62004fa7-1ac0-478e-9d5a-b38f9e7fbc68"
+  },
+  "responses": {
+    "200": {
+      "body": ""
+    }
+  }
+}
diff --git a/...cation/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteLargePersonGroup.json b/...cation/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteLargePersonGroup.json
@@ -0,0 +1,13 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largePersonGroupId": "abc"
+  },
+  "responses": {
+    "200": {
+      "body": ""
+    }
+  }
+}
diff --git a/.../cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteLargePersonGroupPerson.json b/.../cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteLargePersonGroupPerson.json
@@ -0,0 +1,14 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largePersonGroupId": "abc",
+    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1"
+  },
+  "responses": {
+    "200": {
+      "body": ""
+    }
+  }
+}
diff --git a/...nitiveservices/data-plane/Face/stable/v1.0/examples/DeleteLargePersonGroupPersonFace.json b/...nitiveservices/data-plane/Face/stable/v1.0/examples/DeleteLargePersonGroupPersonFace.json
@@ -0,0 +1,15 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largePersonGroupId": "abc",
+    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
+    "persistedFaceId":"62004fa7-1ac0-478e-9d5a-b38f9e7fbc68"
+  },
+  "responses": {
+    "200": {
+      "body": ""
+    }
+  }
+}
diff --git a/...ce/stable/v1.0/examples/DeletePerson.json → ...1.0/examples/DeletePersonGroupPerson.json b/...ce/stable/v1.0/examples/DeletePerson.json → ...1.0/examples/DeletePersonGroupPerson.json
diff --git a/...table/v1.0/examples/DeletePersonFace.json → ...examples/DeletePersonGroupPersonFace.json b/...table/v1.0/examples/DeletePersonFace.json → ...examples/DeletePersonGroupPersonFace.json
diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/FindSimilar.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/FindSimilar.json
@@ -5,7 +5,7 @@
     "Ocp-Apim-Subscription-Key": "{API key}",
     "body": {
       "faceId": "c5c24a82-6845-4031-9d5d-978df9175426",
-      "faceListId": "sample_list",
+      "largeFaceListId": "sample_list",
       "maxNumOfCandidatesReturned": 1,
       "mode": "matchPerson"
     }

diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetLargeFaceList.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetLargeFaceList.json
@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largeFaceListId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "largeFaceListId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
+        "name": "large-face-list-name",
+        "userData": "User-provided data attached to the large face list."
+      }
+    }
+  }
+}
diff --git a/...cognitiveservices/data-plane/Face/stable/v1.0/examples/GetLargeFaceListPersistedFace.json b/...cognitiveservices/data-plane/Face/stable/v1.0/examples/GetLargeFaceListPersistedFace.json
@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largeFaceListId": "abc",
+    "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
+        "userData": "User-provided data attached to the face."
+      }
+    }
+  }
+}
diff --git a/...ognitiveservices/data-plane/Face/stable/v1.0/examples/GetLargeFaceListTrainingStatus.json b/...ognitiveservices/data-plane/Face/stable/v1.0/examples/GetLargeFaceListTrainingStatus.json
@@ -0,0 +1,19 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largeFaceListId": "abc"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "status": "succeeded",
+        "createdDateTime": "2017-12-21T12:57:27.00Z",
+        "lastActionDateTime": "2017-12-21T12:57:30.00Z",
+        "lastSuccessfulTrainingDateTime": "2017-12-21T12:57:30.00Z",
+        "message": null
+      }
+    }
+  }
+}
diff --git a/...ification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetLargePersonGroup.json b/...ification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetLargePersonGroup.json
@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largePersonGroupId": "abc"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "largePersonGroupId": "d408cb4e-2f5f-4b4d-b99e-f0b72870e5b5",
+        "name": "large-person-group-name",
+        "userData": "User-provided data attached to the large person group."
+      }
+    }
+  }
+}
diff --git a/...nitiveservices/data-plane/Face/stable/v1.0/examples/GetLargePersonGroupPersistedFace.json b/...nitiveservices/data-plane/Face/stable/v1.0/examples/GetLargePersonGroupPersistedFace.json
@@ -0,0 +1,18 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largePersonGroupId": "abc",
+    "personId": "B8D802CF-DD8F-4E61-B15C-9E6C5844CCBA",
+    "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
+        "userData": "User-provided data attached to the person face."
+      }
+    }
+  }
+}
diff --git a/...ion/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetLargePersonGroupPerson.json b/...ion/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetLargePersonGroupPerson.json
@@ -0,0 +1,23 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largePersonGroupId": "abc",
+    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
+        "persistedFaceIds": [
+          "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
+          "fce92aed-d578-4d2e-8114-068f8af4492e",
+          "b64d5e15-8257-4af2-b20a-5a750f8940e7"
+        ],
+        "name": "person-name",
+        "userData": "User-provided data attached to the person"
+      }
+    }
+  }
+}
diff --git a/...itiveservices/data-plane/Face/stable/v1.0/examples/GetLargePersonGroupTrainingStatus.json b/...itiveservices/data-plane/Face/stable/v1.0/examples/GetLargePersonGroupTrainingStatus.json
@@ -0,0 +1,19 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Content-Type": "application/json",
+    "Ocp-Apim-Subscription-Key": "{API key}",
+    "largePersonGroupId": "abc"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "status": "succeeded",
+        "createdDateTime": "2017-12-21T12:57:27.00Z",
+        "lastActionDateTime": "2017-12-21T12:57:30.00Z",
+        "lastSuccessfulTrainingDateTime": "2017-12-21T12:57:30.00Z",
+        "message": null
+      }
+    }
+  }
+}