Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates for Face PersonDirectory #21831

Merged
merged 3 commits into from
Dec 11, 2022
Merged

Updates for Face PersonDirectory #21831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6efdb63
Updates for Face PersonDirectory
msyache Dec 9, 2022
8ce6ccb
Another description update
msyache Dec 9, 2022
207f6cf
More
msyache Dec 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 39 additions & 17 deletions specification/cognitiveservices/data-plane/Face/preview/v1.0-preview/Face.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2543,11 +2543,13 @@
"in": "query",
"name": "start",
"format": "uuid",
"description": "List persons from the least personId greater than the \"start\". It contains no more than 64 characters. Default is empty.",
"type": "string"
},
{
"in": "query",
"name": "top",
"description": "The number of persons to list, ranging in [1, 1000]. Default is 1000.",
"type": "string"
}
],
Expand Down Expand Up @@ -2591,6 +2593,7 @@
"in": "body",
"name": "body",
"required": true,
"x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/EnrollmentRequest"
}
Expand Down Expand Up @@ -2640,6 +2643,7 @@
{
"in": "path",
"name": "personId",
"description": "Person id to update.",
"required": true,
"format": "uuid",
"type": "string"
Expand All @@ -2648,6 +2652,7 @@
"in": "body",
"name": "body",
"required": true,
"x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/EnrollmentRequest"
}
Expand Down Expand Up @@ -2683,6 +2688,7 @@
{
"in": "path",
"name": "personId",
"description": "Person id to delete.",
"required": true,
"format": "uuid",
"type": "string"
Expand Down Expand Up @@ -3023,8 +3029,9 @@
{
"in": "body",
"name": "body",
"description": "Target person face id to update.",
"description": "Target person face to update.",
"required": true,
"x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/PersistedFaceWithType"
}
Expand Down Expand Up @@ -3074,6 +3081,7 @@
"name": "body",
"description": "",
"required": true,
"x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/DynamicPersonGroupCreateRequest"
}
Expand Down Expand Up @@ -3130,6 +3138,7 @@
"name": "body",
"description": "",
"required": true,
"x-ms-client-flatten": true,
"schema": {
"$ref": "#/definitions/DynamicPersonGroupUpdateRequest"
}
Expand Down Expand Up @@ -5253,13 +5262,16 @@
"personId": {
"format": "uuid",
"type": "string",
"description": "Person id.",
"x-nullable": false
},
"name": {
"type": "string"
"type": "string",
"description": "User defined name, maximum length is 128."
},
"userData": {
"type": "string"
"type": "string",
"description": "User specified data. Length should not exceed 16KB."
}
}
},
Expand All @@ -5277,10 +5289,12 @@
"type": "object",
"properties": {
"name": {
"type": "string"
"type": "string",
"description": "User defined name, maximum length is 128."
},
"userData": {
"type": "string"
"type": "string",
"description": "User specified data. Length should not exceed 16KB."
}
}
},
Expand Down Expand Up @@ -5333,7 +5347,8 @@
"ir_detection_01",
"expression_01"
],
"type": "string"
"type": "string",
"description": "Detection model used when extracting the face."
},
"PersistedFaceWithType": {
"type": "object",
Expand All @@ -5358,13 +5373,16 @@
"type": "object",
"properties": {
"name": {
"type": "string"
"type": "string",
"description": "User defined name, maximum length is 128."
},
"userData": {
"type": "string"
"type": "string",
"description": "User specified data. Length should not exceed 16KB."
},
"addPersonIds": {
"type": "array",
"description": "Person ids to add to the dynamic person group.",
"items": {
"format": "uuid",
"type": "string",
Expand All @@ -5376,25 +5394,29 @@
"DynamicPersonGroupUpdateRequest": {
"type": "object",
"properties": {
"removePersonIds": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
"type": "string",
"description": "User defined name, maximum length is 128."
},
"userData": {
"type": "string"
"type": "string",
"description": "User specified data. Length should not exceed 16KB."
},
"addPersonIds": {
"type": "array",
"description": "Person ids to add to the dynamic person group.",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
}
},
"removePersonIds": {
"type": "array",
"description": "Person ids to remove from the dynamic person group.",
"items": {
"type": "string"
}
}
}
},
Expand Down Expand Up @@ -5663,7 +5685,7 @@
"name": "returnFaceId",
"in": "query",
"x-ms-parameter-location": "method",
"description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional permissions.",
"description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional access approvals at https://aka.ms/facerecognition.",
"type": "boolean"
},
"returnFaceLandmarks": {
Expand Down
2 changes: 1 addition & 1 deletion specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4490,7 +4490,7 @@
"name": "returnFaceId",
"in": "query",
"x-ms-parameter-location": "method",
"description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional permissions.",
"description": "A value indicating whether the operation should return faceIds of detected faces. Detecting with this value set to true requires additional access approvals at https://aka.ms/facerecognition.",
"type": "boolean"
},
"returnFaceLandmarks": {
Expand Down