diff --git a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/face.rb b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/face.rb
index 57706e9ae7..498e6d6348 100644
--- a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/face.rb
+++ b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/face.rb
@@ -809,7 +809,7 @@ def verify_face_to_face_async(face_id1, face_id2, custom_headers = nil)
# * Optional parameters including faceId, landmarks, and attributes. Attributes
# include age, gender, headPose, smile, facialHair, glasses, emotion, hair,
# makeup, occlusion, accessories, blur, exposure and noise.
- # * The extracted face feature, instead of the actual image, will be stored on
+ # * No image will be stored. Only the extracted face feature will be stored on
# server. The faceId is an identifier of the face feature and will be used in
# [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239),
@@ -832,8 +832,7 @@ def verify_face_to_face_async(face_id1, face_id2, custom_headers = nil)
# or being occluded, or wrong image orientation.
# * Attributes (age, gender, headPose, smile, facialHair, glasses, emotion,
# hair, makeup, occlusion, accessories, blur, exposure and noise) may not be
- # perfectly accurate. HeadPose's pitch value is a reserved field and will
- # always return 0.
+ # perfectly accurate.
# * Different 'recognitionModel' values are provided. If follow-up operations
# like Verify, Identify, Find Similar are needed, please specify the
# recognition model with 'recognitionModel' parameter. The default value for
@@ -843,7 +842,6 @@ def verify_face_to_face_async(face_id1, face_id2, custom_headers = nil)
# More details, please refer to [How to specify a recognition
# model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)
#
- #
# @param url [String] Publicly reachable URL of an image
# @param return_face_id [Boolean] A value indicating whether the operation
# should return faceIds of detected faces.
@@ -879,7 +877,7 @@ def detect_with_url(url, return_face_id = true, return_face_landmarks = false, r
# * Optional parameters including faceId, landmarks, and attributes. Attributes
# include age, gender, headPose, smile, facialHair, glasses, emotion, hair,
# makeup, occlusion, accessories, blur, exposure and noise.
- # * The extracted face feature, instead of the actual image, will be stored on
+ # * No image will be stored. Only the extracted face feature will be stored on
# server. The faceId is an identifier of the face feature and will be used in
# [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239),
@@ -902,8 +900,7 @@ def detect_with_url(url, return_face_id = true, return_face_landmarks = false, r
# or being occluded, or wrong image orientation.
# * Attributes (age, gender, headPose, smile, facialHair, glasses, emotion,
# hair, makeup, occlusion, accessories, blur, exposure and noise) may not be
- # perfectly accurate. HeadPose's pitch value is a reserved field and will
- # always return 0.
+ # perfectly accurate.
# * Different 'recognitionModel' values are provided. If follow-up operations
# like Verify, Identify, Find Similar are needed, please specify the
# recognition model with 'recognitionModel' parameter. The default value for
@@ -913,7 +910,6 @@ def detect_with_url(url, return_face_id = true, return_face_landmarks = false, r
# More details, please refer to [How to specify a recognition
# model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)
#
- #
# @param url [String] Publicly reachable URL of an image
# @param return_face_id [Boolean] A value indicating whether the operation
# should return faceIds of detected faces.
@@ -948,7 +944,7 @@ def detect_with_url_with_http_info(url, return_face_id = true, return_face_landm
# * Optional parameters including faceId, landmarks, and attributes. Attributes
# include age, gender, headPose, smile, facialHair, glasses, emotion, hair,
# makeup, occlusion, accessories, blur, exposure and noise.
- # * The extracted face feature, instead of the actual image, will be stored on
+ # * No image will be stored. Only the extracted face feature will be stored on
# server. The faceId is an identifier of the face feature and will be used in
# [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239),
@@ -971,8 +967,7 @@ def detect_with_url_with_http_info(url, return_face_id = true, return_face_landm
# or being occluded, or wrong image orientation.
# * Attributes (age, gender, headPose, smile, facialHair, glasses, emotion,
# hair, makeup, occlusion, accessories, blur, exposure and noise) may not be
- # perfectly accurate. HeadPose's pitch value is a reserved field and will
- # always return 0.
+ # perfectly accurate.
# * Different 'recognitionModel' values are provided. If follow-up operations
# like Verify, Identify, Find Similar are needed, please specify the
# recognition model with 'recognitionModel' parameter. The default value for
@@ -982,7 +977,6 @@ def detect_with_url_with_http_info(url, return_face_id = true, return_face_landm
# More details, please refer to [How to specify a recognition
# model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)
#
- #
# @param url [String] Publicly reachable URL of an image
# @param return_face_id [Boolean] A value indicating whether the operation
# should return faceIds of detected faces.
diff --git a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/face_list_operations.rb b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/face_list_operations.rb
index 71a01c849a..dcadffbbc6 100644
--- a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/face_list_operations.rb
+++ b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/face_list_operations.rb
@@ -30,7 +30,8 @@ def initialize(client)
# Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
#
After creation, user should use [FaceList - Add
# Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250)
- # to import the faces. Faces are stored on server until [FaceList -
+ # to import the faces. No image will be stored. Only the extracted face
+ # features are stored on server until [FaceList -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f)
# is called.
#
Find Similar is used for scenario like finding celebrity-like faces,
@@ -44,14 +45,20 @@ def initialize(client)
#
Please consider
# [LargeFaceList](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc)
# when the face number is large. It can support up to 1,000,000 faces.
- # 'recognitionModel' should be specified to associate with this face list. The
- # default value for 'recognitionModel' is 'recognition_01', if the latest model
- # needed, please explicitly specify the model you need in this parameter. New
- # faces that are added to an existing face list will use the recognition model
- # that's already associated with the collection. Existing face features in a
- # face list can't be updated to features extracted by another version of
+ #
'recognitionModel' should be specified to associate with this face
+ # list. The default value for 'recognitionModel' is 'recognition_01', if the
+ # latest model needed, please explicitly specify the model you need in this
+ # parameter. New faces that are added to an existing face list will use the
+ # recognition model that's already associated with the collection. Existing
+ # face features in a face list can't be updated to features extracted by
+ # another version of recognition model.
+ # * 'recognition_01': The default recognition model for [FaceList-
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b).
+ # All those face lists created before 2019 March are bonded with this
# recognition model.
- #
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param name [String] User defined name, maximum length is 128.
@@ -76,7 +83,8 @@ def create(face_list_id, name = nil, user_data = nil, recognition_model = nil, c
# Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
#
After creation, user should use [FaceList - Add
# Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250)
- # to import the faces. Faces are stored on server until [FaceList -
+ # to import the faces. No image will be stored. Only the extracted face
+ # features are stored on server until [FaceList -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f)
# is called.
#
Find Similar is used for scenario like finding celebrity-like faces,
@@ -90,14 +98,20 @@ def create(face_list_id, name = nil, user_data = nil, recognition_model = nil, c
#
Please consider
# [LargeFaceList](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc)
# when the face number is large. It can support up to 1,000,000 faces.
- # 'recognitionModel' should be specified to associate with this face list. The
- # default value for 'recognitionModel' is 'recognition_01', if the latest model
- # needed, please explicitly specify the model you need in this parameter. New
- # faces that are added to an existing face list will use the recognition model
- # that's already associated with the collection. Existing face features in a
- # face list can't be updated to features extracted by another version of
+ #
'recognitionModel' should be specified to associate with this face
+ # list. The default value for 'recognitionModel' is 'recognition_01', if the
+ # latest model needed, please explicitly specify the model you need in this
+ # parameter. New faces that are added to an existing face list will use the
+ # recognition model that's already associated with the collection. Existing
+ # face features in a face list can't be updated to features extracted by
+ # another version of recognition model.
+ # * 'recognition_01': The default recognition model for [FaceList-
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b).
+ # All those face lists created before 2019 March are bonded with this
# recognition model.
- #
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param name [String] User defined name, maximum length is 128.
@@ -122,7 +136,8 @@ def create_with_http_info(face_list_id, name = nil, user_data = nil, recognition
# Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
#
After creation, user should use [FaceList - Add
# Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250)
- # to import the faces. Faces are stored on server until [FaceList -
+ # to import the faces. No image will be stored. Only the extracted face
+ # features are stored on server until [FaceList -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f)
# is called.
#
Find Similar is used for scenario like finding celebrity-like faces,
@@ -136,14 +151,20 @@ def create_with_http_info(face_list_id, name = nil, user_data = nil, recognition
#
Please consider
# [LargeFaceList](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc)
# when the face number is large. It can support up to 1,000,000 faces.
- # 'recognitionModel' should be specified to associate with this face list. The
- # default value for 'recognitionModel' is 'recognition_01', if the latest model
- # needed, please explicitly specify the model you need in this parameter. New
- # faces that are added to an existing face list will use the recognition model
- # that's already associated with the collection. Existing face features in a
- # face list can't be updated to features extracted by another version of
+ #
'recognitionModel' should be specified to associate with this face
+ # list. The default value for 'recognitionModel' is 'recognition_01', if the
+ # latest model needed, please explicitly specify the model you need in this
+ # parameter. New faces that are added to an existing face list will use the
+ # recognition model that's already associated with the collection. Existing
+ # face features in a face list can't be updated to features extracted by
+ # another version of recognition model.
+ # * 'recognition_01': The default recognition model for [FaceList-
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b).
+ # All those face lists created before 2019 March are bonded with this
# recognition model.
- #
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param name [String] User defined name, maximum length is 128.
@@ -405,8 +426,7 @@ def update_async(face_list_id, name = nil, user_data = nil, custom_headers = nil
end
#
- # Delete an existing face list according to faceListId. Persisted face images
- # in the face list will also be deleted.
+ # Delete a specified face list.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param custom_headers [Hash{String => String}] A hash of custom headers that
@@ -419,8 +439,7 @@ def delete(face_list_id, custom_headers = nil)
end
#
- # Delete an existing face list according to faceListId. Persisted face images
- # in the face list will also be deleted.
+ # Delete a specified face list.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param custom_headers [Hash{String => String}] A hash of custom headers that
@@ -433,8 +452,7 @@ def delete_with_http_info(face_list_id, custom_headers = nil)
end
#
- # Delete an existing face list according to faceListId. Persisted face images
- # in the face list will also be deleted.
+ # Delete a specified face list.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param [Hash{String => String}] A hash of custom headers that will be added
@@ -594,8 +612,9 @@ def list_async(return_recognition_model = false, custom_headers = nil)
end
#
- # Delete an existing face from a face list (given by a persistedFaceId and a
- # faceListId). Persisted image related to the face will also be deleted.
+ # Delete a face from a face list by specified faceListId and persistedFaceId.
+ #
Adding/deleting faces to/from a same face list are processed
+ # sequentially and to/from different face lists are in parallel.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param persisted_face_id Id referencing a particular persistedFaceId of an
@@ -610,8 +629,9 @@ def delete_face(face_list_id, persisted_face_id, custom_headers = nil)
end
#
- # Delete an existing face from a face list (given by a persistedFaceId and a
- # faceListId). Persisted image related to the face will also be deleted.
+ # Delete a face from a face list by specified faceListId and persistedFaceId.
+ #
Adding/deleting faces to/from a same face list are processed
+ # sequentially and to/from different face lists are in parallel.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param persisted_face_id Id referencing a particular persistedFaceId of an
@@ -626,8 +646,9 @@ def delete_face_with_http_info(face_list_id, persisted_face_id, custom_headers =
end
#
- # Delete an existing face from a face list (given by a persistedFaceId and a
- # faceListId). Persisted image related to the face will also be deleted.
+ # Delete a face from a face list by specified faceListId and persistedFaceId.
+ #
Adding/deleting faces to/from a same face list are processed
+ # sequentially and to/from different face lists are in parallel.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param persisted_face_id Id referencing a particular persistedFaceId of an
@@ -679,9 +700,31 @@ def delete_face_async(face_list_id, persisted_face_id, custom_headers = nil)
end
#
- # Add a face to a face list. The input face is specified as an image with a
- # targetFace rectangle. It returns a persistedFaceId representing the added
- # face, and persistedFaceId will not expire.
+ # Add a face to a specified face list, up to 1,000 faces.
+ #
To deal with an image contains multiple faces, input face can be
+ # specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [FaceList - Delete
+ # Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395251)
+ # or [FaceList -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better detection and recognition precision.
+ # Please consider high-quality faces: frontal, clear, and face size is 200x200
+ # pixels (100 pixels between eyes) or bigger.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same face list are processed sequentially
+ # and to/from different face lists are in parallel.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param url [String] Publicly reachable URL of an image
@@ -704,9 +747,31 @@ def add_face_from_url(face_list_id, url, user_data = nil, target_face = nil, cus
end
#
- # Add a face to a face list. The input face is specified as an image with a
- # targetFace rectangle. It returns a persistedFaceId representing the added
- # face, and persistedFaceId will not expire.
+ # Add a face to a specified face list, up to 1,000 faces.
+ #
To deal with an image contains multiple faces, input face can be
+ # specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [FaceList - Delete
+ # Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395251)
+ # or [FaceList -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better detection and recognition precision.
+ # Please consider high-quality faces: frontal, clear, and face size is 200x200
+ # pixels (100 pixels between eyes) or bigger.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same face list are processed sequentially
+ # and to/from different face lists are in parallel.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param url [String] Publicly reachable URL of an image
@@ -728,9 +793,31 @@ def add_face_from_url_with_http_info(face_list_id, url, user_data = nil, target_
end
#
- # Add a face to a face list. The input face is specified as an image with a
- # targetFace rectangle. It returns a persistedFaceId representing the added
- # face, and persistedFaceId will not expire.
+ # Add a face to a specified face list, up to 1,000 faces.
+ #
To deal with an image contains multiple faces, input face can be
+ # specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [FaceList - Delete
+ # Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395251)
+ # or [FaceList -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better detection and recognition precision.
+ # Please consider high-quality faces: frontal, clear, and face size is 200x200
+ # pixels (100 pixels between eyes) or bigger.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same face list are processed sequentially
+ # and to/from different face lists are in parallel.
#
# @param face_list_id [String] Id referencing a particular face list.
# @param url [String] Publicly reachable URL of an image
diff --git a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_face_list_operations.rb b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_face_list_operations.rb
index eafad728a0..0455bec778 100644
--- a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_face_list_operations.rb
+++ b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_face_list_operations.rb
@@ -31,9 +31,10 @@ def initialize(client)
# Add](/docs/services/563879b61984550e40cbbe8d/operations/5a158c10d2de3616c086f2d3)
# to import the faces and [LargeFaceList -
# Train](/docs/services/563879b61984550e40cbbe8d/operations/5a158422d2de3616c086f2d1)
- # to make it ready for [Face -
- # FindSimilar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
- # Faces are stored on server until [LargeFaceList -
+ # to make it ready for [Face - Find
+ # Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
+ # No image will be stored. Only the extracted face features are stored on
+ # server until [LargeFaceList -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd)
# is called.
#
Find Similar is used for scenario like finding celebrity-like faces,
@@ -44,18 +45,24 @@ def initialize(client)
# [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d)
# and [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).
- #
- # * Free-tier subscription quota: 64 large face lists.
- # * S0-tier subscription quota: 1,000,000 large face lists.
- #
- # 'recognitionModel' should be specified to associate with this large face
+ #
'recognitionModel' should be specified to associate with this large face
# list. The default value for 'recognitionModel' is 'recognition_01', if the
# latest model needed, please explicitly specify the model you need in this
# parameter. New faces that are added to an existing large face list will use
# the recognition model that's already associated with the collection. Existing
# face features in a large face list can't be updated to features extracted by
# another version of recognition model.
- #
+ # * 'recognition_01': The default recognition model for [LargeFaceList-
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc).
+ # All those large face lists created before 2019 March are bonded with this
+ # recognition model.
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
+ #
+ # Large face list quota:
+ # * Free-tier subscription quota: 64 large face lists.
+ # * S0-tier subscription quota: 1,000,000 large face lists.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
@@ -82,9 +89,10 @@ def create(large_face_list_id, name = nil, user_data = nil, recognition_model =
# Add](/docs/services/563879b61984550e40cbbe8d/operations/5a158c10d2de3616c086f2d3)
# to import the faces and [LargeFaceList -
# Train](/docs/services/563879b61984550e40cbbe8d/operations/5a158422d2de3616c086f2d1)
- # to make it ready for [Face -
- # FindSimilar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
- # Faces are stored on server until [LargeFaceList -
+ # to make it ready for [Face - Find
+ # Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
+ # No image will be stored. Only the extracted face features are stored on
+ # server until [LargeFaceList -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd)
# is called.
#
Find Similar is used for scenario like finding celebrity-like faces,
@@ -95,18 +103,24 @@ def create(large_face_list_id, name = nil, user_data = nil, recognition_model =
# [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d)
# and [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).
- #
- # * Free-tier subscription quota: 64 large face lists.
- # * S0-tier subscription quota: 1,000,000 large face lists.
- #
- # 'recognitionModel' should be specified to associate with this large face
+ #
'recognitionModel' should be specified to associate with this large face
# list. The default value for 'recognitionModel' is 'recognition_01', if the
# latest model needed, please explicitly specify the model you need in this
# parameter. New faces that are added to an existing large face list will use
# the recognition model that's already associated with the collection. Existing
# face features in a large face list can't be updated to features extracted by
# another version of recognition model.
- #
+ # * 'recognition_01': The default recognition model for [LargeFaceList-
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc).
+ # All those large face lists created before 2019 March are bonded with this
+ # recognition model.
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
+ #
+ # Large face list quota:
+ # * Free-tier subscription quota: 64 large face lists.
+ # * S0-tier subscription quota: 1,000,000 large face lists.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
@@ -133,9 +147,10 @@ def create_with_http_info(large_face_list_id, name = nil, user_data = nil, recog
# Add](/docs/services/563879b61984550e40cbbe8d/operations/5a158c10d2de3616c086f2d3)
# to import the faces and [LargeFaceList -
# Train](/docs/services/563879b61984550e40cbbe8d/operations/5a158422d2de3616c086f2d1)
- # to make it ready for [Face -
- # FindSimilar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
- # Faces are stored on server until [LargeFaceList -
+ # to make it ready for [Face - Find
+ # Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
+ # No image will be stored. Only the extracted face features are stored on
+ # server until [LargeFaceList -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd)
# is called.
#
Find Similar is used for scenario like finding celebrity-like faces,
@@ -146,18 +161,24 @@ def create_with_http_info(large_face_list_id, name = nil, user_data = nil, recog
# [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d)
# and [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).
- #
- # * Free-tier subscription quota: 64 large face lists.
- # * S0-tier subscription quota: 1,000,000 large face lists.
- #
- # 'recognitionModel' should be specified to associate with this large face
+ #
'recognitionModel' should be specified to associate with this large face
# list. The default value for 'recognitionModel' is 'recognition_01', if the
# latest model needed, please explicitly specify the model you need in this
# parameter. New faces that are added to an existing large face list will use
# the recognition model that's already associated with the collection. Existing
# face features in a large face list can't be updated to features extracted by
# another version of recognition model.
- #
+ # * 'recognition_01': The default recognition model for [LargeFaceList-
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc).
+ # All those large face lists created before 2019 March are bonded with this
+ # recognition model.
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
+ #
+ # Large face list quota:
+ # * Free-tier subscription quota: 64 large face lists.
+ # * S0-tier subscription quota: 1,000,000 large face lists.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
@@ -423,8 +444,7 @@ def update_async(large_face_list_id, name = nil, user_data = nil, custom_headers
end
#
- # Delete an existing large face list according to faceListId. Persisted face
- # images in the large face list will also be deleted.
+ # Delete a specified large face list.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
@@ -438,8 +458,7 @@ def delete(large_face_list_id, custom_headers = nil)
end
#
- # Delete an existing large face list according to faceListId. Persisted face
- # images in the large face list will also be deleted.
+ # Delete a specified large face list.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
@@ -453,8 +472,7 @@ def delete_with_http_info(large_face_list_id, custom_headers = nil)
end
#
- # Delete an existing large face list according to faceListId. Persisted face
- # images in the large face list will also be deleted.
+ # Delete a specified large face list.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
@@ -827,9 +845,10 @@ def train_async(large_face_list_id, custom_headers = nil)
end
#
- # Delete an existing face from a large face list (given by a persistedFaceId
- # and a largeFaceListId). Persisted image related to the face will also be
- # deleted.
+ # Delete a face from a large face list by specified largeFaceListId and
+ # persistedFaceId.
+ #
Adding/deleting faces to/from a same large face list are processed
+ # sequentially and to/from different large face lists are in parallel.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
@@ -845,9 +864,10 @@ def delete_face(large_face_list_id, persisted_face_id, custom_headers = nil)
end
#
- # Delete an existing face from a large face list (given by a persistedFaceId
- # and a largeFaceListId). Persisted image related to the face will also be
- # deleted.
+ # Delete a face from a large face list by specified largeFaceListId and
+ # persistedFaceId.
+ #
Adding/deleting faces to/from a same large face list are processed
+ # sequentially and to/from different large face lists are in parallel.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
@@ -863,9 +883,10 @@ def delete_face_with_http_info(large_face_list_id, persisted_face_id, custom_hea
end
#
- # Delete an existing face from a large face list (given by a persistedFaceId
- # and a largeFaceListId). Persisted image related to the face will also be
- # deleted.
+ # Delete a face from a large face list by specified largeFaceListId and
+ # persistedFaceId.
+ #
Adding/deleting faces to/from a same large face list are processed
+ # sequentially and to/from different large face lists are in parallel.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
@@ -1121,9 +1142,36 @@ def update_face_async(large_face_list_id, persisted_face_id, user_data = nil, cu
end
#
- # Add a face to a large face list. The input face is specified as an image with
- # a targetFace rectangle. It returns a persistedFaceId representing the added
- # face, and persistedFaceId will not expire.
+ # Add a face to a specified large face list, up to 1,000,000 faces.
+ #
To deal with an image contains multiple faces, input face can be
+ # specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [LargeFaceList Face
+ # -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a158c8ad2de3616c086f2d4)
+ # or [LargeFaceList -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same face list are processed sequentially
+ # and to/from different face lists are in parallel.
+ #
+ # Quota:
+ # * Free-tier subscription quota: 1,000 faces per large face list.
+ # * S0-tier subscription quota: 1,000,000 faces per large face list.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
@@ -1147,9 +1195,36 @@ def add_face_from_url(large_face_list_id, url, user_data = nil, target_face = ni
end
#
- # Add a face to a large face list. The input face is specified as an image with
- # a targetFace rectangle. It returns a persistedFaceId representing the added
- # face, and persistedFaceId will not expire.
+ # Add a face to a specified large face list, up to 1,000,000 faces.
+ #
To deal with an image contains multiple faces, input face can be
+ # specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [LargeFaceList Face
+ # -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a158c8ad2de3616c086f2d4)
+ # or [LargeFaceList -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same face list are processed sequentially
+ # and to/from different face lists are in parallel.
+ #
+ # Quota:
+ # * Free-tier subscription quota: 1,000 faces per large face list.
+ # * S0-tier subscription quota: 1,000,000 faces per large face list.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
@@ -1172,9 +1247,36 @@ def add_face_from_url_with_http_info(large_face_list_id, url, user_data = nil, t
end
#
- # Add a face to a large face list. The input face is specified as an image with
- # a targetFace rectangle. It returns a persistedFaceId representing the added
- # face, and persistedFaceId will not expire.
+ # Add a face to a specified large face list, up to 1,000,000 faces.
+ #
To deal with an image contains multiple faces, input face can be
+ # specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [LargeFaceList Face
+ # -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a158c8ad2de3616c086f2d4)
+ # or [LargeFaceList -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same face list are processed sequentially
+ # and to/from different face lists are in parallel.
+ #
+ # Quota:
+ # * Free-tier subscription quota: 1,000 faces per large face list.
+ # * S0-tier subscription quota: 1,000,000 faces per large face list.
#
# @param large_face_list_id [String] Id referencing a particular large face
# list.
diff --git a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_person_group_operations.rb b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_person_group_operations.rb
index 273c6455bf..b6782992b1 100644
--- a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_person_group_operations.rb
+++ b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_person_group_operations.rb
@@ -25,7 +25,7 @@ def initialize(client)
# Create a new large person group with user-specified largePersonGroupId, name,
# an optional userData and recognitionModel.
#
A large person group is the container of the uploaded person data,
- # including face images and face recognition feature, and up to 1,000,000
+ # including face recognition feature, and up to 1,000,000
# people.
#
After creation, use [LargePersonGroup Person -
# Create](/docs/services/563879b61984550e40cbbe8d/operations/599adcba3a7b9412a4d53f40)
@@ -33,24 +33,30 @@ def initialize(client)
# Train](/docs/services/563879b61984550e40cbbe8d/operations/599ae2d16ac60f11b48b5aa4)
# to get this group ready for [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).
- #
The person face, image, and userData will be stored on server until
- # [LargePersonGroup Person -
+ #
No image will be stored. Only the person's extracted face features and
+ # userData will be stored on server until [LargePersonGroup Person -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2)
# or [LargePersonGroup -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f)
# is called.
- #
- # * Free-tier subscription quota: 1,000 large person groups.
- # * S0-tier subscription quota: 1,000,000 large person groups.
- #
- # 'recognitionModel' should be specified to associate with this large person
- # group. The default value for 'recognitionModel' is 'recognition_01', if the
- # latest model needed, please explicitly specify the model you need in this
- # parameter. New faces that are added to an existing large person group will
- # use the recognition model that's already associated with the collection.
+ #
'recognitionModel' should be specified to associate with this large
+ # person group. The default value for 'recognitionModel' is 'recognition_01',
+ # if the latest model needed, please explicitly specify the model you need in
+ # this parameter. New faces that are added to an existing large person group
+ # will use the recognition model that's already associated with the collection.
# Existing face features in a large person group can't be updated to features
# extracted by another version of recognition model.
- #
+ # * 'recognition_01': The default recognition model for [LargePersonGroup -
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d).
+ # All those large person groups created before 2019 March are bonded with this
+ # recognition model.
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
+ #
+ # Large person group quota:
+ # * Free-tier subscription quota: 1,000 large person groups.
+ # * S0-tier subscription quota: 1,000,000 large person groups.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -71,7 +77,7 @@ def create(large_person_group_id, name = nil, user_data = nil, recognition_model
# Create a new large person group with user-specified largePersonGroupId, name,
# an optional userData and recognitionModel.
#
A large person group is the container of the uploaded person data,
- # including face images and face recognition feature, and up to 1,000,000
+ # including face recognition feature, and up to 1,000,000
# people.
#
After creation, use [LargePersonGroup Person -
# Create](/docs/services/563879b61984550e40cbbe8d/operations/599adcba3a7b9412a4d53f40)
@@ -79,24 +85,30 @@ def create(large_person_group_id, name = nil, user_data = nil, recognition_model
# Train](/docs/services/563879b61984550e40cbbe8d/operations/599ae2d16ac60f11b48b5aa4)
# to get this group ready for [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).
- #
The person face, image, and userData will be stored on server until
- # [LargePersonGroup Person -
+ #
No image will be stored. Only the person's extracted face features and
+ # userData will be stored on server until [LargePersonGroup Person -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2)
# or [LargePersonGroup -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f)
# is called.
- #
- # * Free-tier subscription quota: 1,000 large person groups.
- # * S0-tier subscription quota: 1,000,000 large person groups.
- #
- # 'recognitionModel' should be specified to associate with this large person
- # group. The default value for 'recognitionModel' is 'recognition_01', if the
- # latest model needed, please explicitly specify the model you need in this
- # parameter. New faces that are added to an existing large person group will
- # use the recognition model that's already associated with the collection.
+ #
'recognitionModel' should be specified to associate with this large
+ # person group. The default value for 'recognitionModel' is 'recognition_01',
+ # if the latest model needed, please explicitly specify the model you need in
+ # this parameter. New faces that are added to an existing large person group
+ # will use the recognition model that's already associated with the collection.
# Existing face features in a large person group can't be updated to features
# extracted by another version of recognition model.
- #
+ # * 'recognition_01': The default recognition model for [LargePersonGroup -
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d).
+ # All those large person groups created before 2019 March are bonded with this
+ # recognition model.
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
+ #
+ # Large person group quota:
+ # * Free-tier subscription quota: 1,000 large person groups.
+ # * S0-tier subscription quota: 1,000,000 large person groups.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -117,7 +129,7 @@ def create_with_http_info(large_person_group_id, name = nil, user_data = nil, re
# Create a new large person group with user-specified largePersonGroupId, name,
# an optional userData and recognitionModel.
#
A large person group is the container of the uploaded person data,
- # including face images and face recognition feature, and up to 1,000,000
+ # including face recognition feature, and up to 1,000,000
# people.
#
After creation, use [LargePersonGroup Person -
# Create](/docs/services/563879b61984550e40cbbe8d/operations/599adcba3a7b9412a4d53f40)
@@ -125,24 +137,30 @@ def create_with_http_info(large_person_group_id, name = nil, user_data = nil, re
# Train](/docs/services/563879b61984550e40cbbe8d/operations/599ae2d16ac60f11b48b5aa4)
# to get this group ready for [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).
- #
The person face, image, and userData will be stored on server until
- # [LargePersonGroup Person -
+ #
No image will be stored. Only the person's extracted face features and
+ # userData will be stored on server until [LargePersonGroup Person -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2)
# or [LargePersonGroup -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f)
# is called.
- #
- # * Free-tier subscription quota: 1,000 large person groups.
- # * S0-tier subscription quota: 1,000,000 large person groups.
- #
- # 'recognitionModel' should be specified to associate with this large person
- # group. The default value for 'recognitionModel' is 'recognition_01', if the
- # latest model needed, please explicitly specify the model you need in this
- # parameter. New faces that are added to an existing large person group will
- # use the recognition model that's already associated with the collection.
+ #
'recognitionModel' should be specified to associate with this large
+ # person group. The default value for 'recognitionModel' is 'recognition_01',
+ # if the latest model needed, please explicitly specify the model you need in
+ # this parameter. New faces that are added to an existing large person group
+ # will use the recognition model that's already associated with the collection.
# Existing face features in a large person group can't be updated to features
# extracted by another version of recognition model.
- #
+ # * 'recognition_01': The default recognition model for [LargePersonGroup -
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d).
+ # All those large person groups created before 2019 March are bonded with this
+ # recognition model.
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
+ #
+ # Large person group quota:
+ # * Free-tier subscription quota: 1,000 large person groups.
+ # * S0-tier subscription quota: 1,000,000 large person groups.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
diff --git a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_person_group_person.rb b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_person_group_person.rb
index 8d01119ebe..4bde69e7b4 100644
--- a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_person_group_person.rb
+++ b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/large_person_group_person.rb
@@ -253,8 +253,9 @@ def list_async(large_person_group_id, start = nil, top = nil, custom_headers = n
end
#
- # Delete an existing person from a large person group. All stored person data,
- # and face features in the person entry will be deleted.
+ # Delete an existing person from a large person group. The persistedFaceId,
+ # userData, person name and face feature in the person entry will all be
+ # deleted.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -269,8 +270,9 @@ def delete(large_person_group_id, person_id, custom_headers = nil)
end
#
- # Delete an existing person from a large person group. All stored person data,
- # and face features in the person entry will be deleted.
+ # Delete an existing person from a large person group. The persistedFaceId,
+ # userData, person name and face feature in the person entry will all be
+ # deleted.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -285,8 +287,9 @@ def delete_with_http_info(large_person_group_id, person_id, custom_headers = nil
end
#
- # Delete an existing person from a large person group. All stored person data,
- # and face features in the person entry will be deleted.
+ # Delete an existing person from a large person group. The persistedFaceId,
+ # userData, person name and face feature in the person entry will all be
+ # deleted.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -338,8 +341,8 @@ def delete_async(large_person_group_id, person_id, custom_headers = nil)
end
#
- # Retrieve a person's information, including registered persisted faces, name
- # and userData.
+ # Retrieve a person's name and userData, and the persisted faceIds representing
+ # the registered person face feature.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -355,8 +358,8 @@ def get(large_person_group_id, person_id, custom_headers = nil)
end
#
- # Retrieve a person's information, including registered persisted faces, name
- # and userData.
+ # Retrieve a person's name and userData, and the persisted faceIds representing
+ # the registered person face feature.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -371,8 +374,8 @@ def get_with_http_info(large_person_group_id, person_id, custom_headers = nil)
end
#
- # Retrieve a person's information, including registered persisted faces, name
- # and userData.
+ # Retrieve a person's name and userData, and the persisted faceIds representing
+ # the registered person face feature.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -536,8 +539,11 @@ def update_async(large_person_group_id, person_id, name = nil, user_data = nil,
end
#
- # Delete a face from a person. Relative feature for the persisted face will
- # also be deleted.
+ # Delete a face from a person in a large person group by specified
+ # largePersonGroupId, personId and persistedFaceId.
+ #
Adding/deleting faces to/from a same person will be processed
+ # sequentially. Adding/deleting faces to/from different persons are processed
+ # in parallel.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -554,8 +560,11 @@ def delete_face(large_person_group_id, person_id, persisted_face_id, custom_head
end
#
- # Delete a face from a person. Relative feature for the persisted face will
- # also be deleted.
+ # Delete a face from a person in a large person group by specified
+ # largePersonGroupId, personId and persistedFaceId.
+ #
Adding/deleting faces to/from a same person will be processed
+ # sequentially. Adding/deleting faces to/from different persons are processed
+ # in parallel.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -572,8 +581,11 @@ def delete_face_with_http_info(large_person_group_id, person_id, persisted_face_
end
#
- # Delete a face from a person. Relative feature for the persisted face will
- # also be deleted.
+ # Delete a face from a person in a large person group by specified
+ # largePersonGroupId, personId and persistedFaceId.
+ #
Adding/deleting faces to/from a same person will be processed
+ # sequentially. Adding/deleting faces to/from different persons are processed
+ # in parallel.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -839,8 +851,35 @@ def update_face_async(large_person_group_id, person_id, persisted_face_id, user_
end
#
- # Add a representative face to a person for identification. The input face is
- # specified as an image with a targetFace rectangle.
+ # Add a face to a person into a large person group for face identification or
+ # verification. To deal with an image contains multiple faces, input face can
+ # be specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [LargePersonGroup
+ # PersonFace -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ae2966ac60f11b48b5aa3),
+ # [LargePersonGroup Person -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2)
+ # or [LargePersonGroup -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * Each person entry can hold up to 248 faces.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same person will be processed sequentially.
+ # Adding/deleting faces to/from different persons are processed in parallel.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -865,8 +904,35 @@ def add_face_from_url(large_person_group_id, person_id, url, user_data = nil, ta
end
#
- # Add a representative face to a person for identification. The input face is
- # specified as an image with a targetFace rectangle.
+ # Add a face to a person into a large person group for face identification or
+ # verification. To deal with an image contains multiple faces, input face can
+ # be specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [LargePersonGroup
+ # PersonFace -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ae2966ac60f11b48b5aa3),
+ # [LargePersonGroup Person -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2)
+ # or [LargePersonGroup -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * Each person entry can hold up to 248 faces.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same person will be processed sequentially.
+ # Adding/deleting faces to/from different persons are processed in parallel.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
@@ -890,8 +956,35 @@ def add_face_from_url_with_http_info(large_person_group_id, person_id, url, user
end
#
- # Add a representative face to a person for identification. The input face is
- # specified as an image with a targetFace rectangle.
+ # Add a face to a person into a large person group for face identification or
+ # verification. To deal with an image contains multiple faces, input face can
+ # be specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [LargePersonGroup
+ # PersonFace -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ae2966ac60f11b48b5aa3),
+ # [LargePersonGroup Person -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2)
+ # or [LargePersonGroup -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * Each person entry can hold up to 248 faces.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same person will be processed sequentially.
+ # Adding/deleting faces to/from different persons are processed in parallel.
#
# @param large_person_group_id [String] Id referencing a particular large
# person group.
diff --git a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/person_group_operations.rb b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/person_group_operations.rb
index 496b6393f0..fac7039434 100644
--- a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/person_group_operations.rb
+++ b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/person_group_operations.rb
@@ -25,35 +25,41 @@ def initialize(client)
# Create a new person group with specified personGroupId, name, user-provided
# userData and recognitionModel.
#
A person group is the container of the uploaded person data, including
- # face images and face recognition features.
+ # face recognition features.
#
After creation, use [PersonGroup Person -
# Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523c)
# to add persons into the group, and then call [PersonGroup -
# Train](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249)
# to get this group ready for [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).
- #
The person's face, image, and userData will be stored on server until
- # [PersonGroup Person -
+ #
No image will be stored. Only the person's extracted face features and
+ # userData will be stored on server until [PersonGroup Person -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d)
# or [PersonGroup -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245)
# is called.
- #
+ #
'recognitionModel' should be specified to associate with this person
+ # group. The default value for 'recognitionModel' is 'recognition_01', if the
+ # latest model needed, please explicitly specify the model you need in this
+ # parameter. New faces that are added to an existing person group will use the
+ # recognition model that's already associated with the collection. Existing
+ # face features in a person group can't be updated to features extracted by
+ # another version of recognition model.
+ # * 'recognition_01': The default recognition model for [PersonGroup -
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244).
+ # All those person groups created before 2019 March are bonded with this
+ # recognition model.
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
+ #
+ # Person group quota:
# * Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000
# persons.
# * S0-tier subscription quota: 1,000,000 person groups. Each holds up to
# 10,000 persons.
# * to handle larger scale face identification problem, please consider using
# [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d).
- #
- # 'recognitionModel' should be specified to associate with this person group.
- # The default value for 'recognitionModel' is 'recognition_01', if the latest
- # model needed, please explicitly specify the model you need in this parameter.
- # New faces that are added to an existing person group will use the recognition
- # model that's already associated with the collection. Existing face features
- # in a person group can't be updated to features extracted by another version
- # of recognition model.
- #
#
# @param person_group_id [String] Id referencing a particular person group.
# @param name [String] User defined name, maximum length is 128.
@@ -73,35 +79,41 @@ def create(person_group_id, name = nil, user_data = nil, recognition_model = nil
# Create a new person group with specified personGroupId, name, user-provided
# userData and recognitionModel.
#
A person group is the container of the uploaded person data, including
- # face images and face recognition features.
+ # face recognition features.
#
After creation, use [PersonGroup Person -
# Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523c)
# to add persons into the group, and then call [PersonGroup -
# Train](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249)
# to get this group ready for [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).
- #
The person's face, image, and userData will be stored on server until
- # [PersonGroup Person -
+ #
No image will be stored. Only the person's extracted face features and
+ # userData will be stored on server until [PersonGroup Person -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d)
# or [PersonGroup -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245)
# is called.
- #
+ #
'recognitionModel' should be specified to associate with this person
+ # group. The default value for 'recognitionModel' is 'recognition_01', if the
+ # latest model needed, please explicitly specify the model you need in this
+ # parameter. New faces that are added to an existing person group will use the
+ # recognition model that's already associated with the collection. Existing
+ # face features in a person group can't be updated to features extracted by
+ # another version of recognition model.
+ # * 'recognition_01': The default recognition model for [PersonGroup -
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244).
+ # All those person groups created before 2019 March are bonded with this
+ # recognition model.
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
+ #
+ # Person group quota:
# * Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000
# persons.
# * S0-tier subscription quota: 1,000,000 person groups. Each holds up to
# 10,000 persons.
# * to handle larger scale face identification problem, please consider using
# [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d).
- #
- # 'recognitionModel' should be specified to associate with this person group.
- # The default value for 'recognitionModel' is 'recognition_01', if the latest
- # model needed, please explicitly specify the model you need in this parameter.
- # New faces that are added to an existing person group will use the recognition
- # model that's already associated with the collection. Existing face features
- # in a person group can't be updated to features extracted by another version
- # of recognition model.
- #
#
# @param person_group_id [String] Id referencing a particular person group.
# @param name [String] User defined name, maximum length is 128.
@@ -121,35 +133,41 @@ def create_with_http_info(person_group_id, name = nil, user_data = nil, recognit
# Create a new person group with specified personGroupId, name, user-provided
# userData and recognitionModel.
#
A person group is the container of the uploaded person data, including
- # face images and face recognition features.
+ # face recognition features.
#
After creation, use [PersonGroup Person -
# Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523c)
# to add persons into the group, and then call [PersonGroup -
# Train](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249)
# to get this group ready for [Face -
# Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).
- #
The person's face, image, and userData will be stored on server until
- # [PersonGroup Person -
+ #
No image will be stored. Only the person's extracted face features and
+ # userData will be stored on server until [PersonGroup Person -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d)
# or [PersonGroup -
# Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245)
# is called.
- #
+ #
'recognitionModel' should be specified to associate with this person
+ # group. The default value for 'recognitionModel' is 'recognition_01', if the
+ # latest model needed, please explicitly specify the model you need in this
+ # parameter. New faces that are added to an existing person group will use the
+ # recognition model that's already associated with the collection. Existing
+ # face features in a person group can't be updated to features extracted by
+ # another version of recognition model.
+ # * 'recognition_01': The default recognition model for [PersonGroup -
+ # Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244).
+ # All those person groups created before 2019 March are bonded with this
+ # recognition model.
+ # * 'recognition_02': Recognition model released in 2019 March.
+ # 'recognition_02' is recommended since its overall accuracy is improved
+ # compared with 'recognition_01'.
+ #
+ # Person group quota:
# * Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000
# persons.
# * S0-tier subscription quota: 1,000,000 person groups. Each holds up to
# 10,000 persons.
# * to handle larger scale face identification problem, please consider using
# [LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d).
- #
- # 'recognitionModel' should be specified to associate with this person group.
- # The default value for 'recognitionModel' is 'recognition_01', if the latest
- # model needed, please explicitly specify the model you need in this parameter.
- # New faces that are added to an existing person group will use the recognition
- # model that's already associated with the collection. Existing face features
- # in a person group can't be updated to features extracted by another version
- # of recognition model.
- #
#
# @param person_group_id [String] Id referencing a particular person group.
# @param name [String] User defined name, maximum length is 128.
diff --git a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/person_group_person.rb b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/person_group_person.rb
index 2fa0b29299..063914435d 100644
--- a/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/person_group_person.rb
+++ b/data/azure_cognitiveservices_face/lib/1.0/generated/azure_cognitiveservices_face/person_group_person.rb
@@ -247,8 +247,8 @@ def list_async(person_group_id, start = nil, top = nil, custom_headers = nil)
end
#
- # Delete an existing person from a person group. All stored person data, and
- # face features in the person entry will be deleted.
+ # Delete an existing person from a person group. The persistedFaceId, userData,
+ # person name and face feature in the person entry will all be deleted.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.
@@ -262,8 +262,8 @@ def delete(person_group_id, person_id, custom_headers = nil)
end
#
- # Delete an existing person from a person group. All stored person data, and
- # face features in the person entry will be deleted.
+ # Delete an existing person from a person group. The persistedFaceId, userData,
+ # person name and face feature in the person entry will all be deleted.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.
@@ -277,8 +277,8 @@ def delete_with_http_info(person_group_id, person_id, custom_headers = nil)
end
#
- # Delete an existing person from a person group. All stored person data, and
- # face features in the person entry will be deleted.
+ # Delete an existing person from a person group. The persistedFaceId, userData,
+ # person name and face feature in the person entry will all be deleted.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.
@@ -521,8 +521,11 @@ def update_async(person_group_id, person_id, name = nil, user_data = nil, custom
end
#
- # Delete a face from a person. Relative feature for the persisted face will
- # also be deleted.
+ # Delete a face from a person in a person group by specified personGroupId,
+ # personId and persistedFaceId.
+ #
Adding/deleting faces to/from a same person will be processed
+ # sequentially. Adding/deleting faces to/from different persons are processed
+ # in parallel.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.
@@ -538,8 +541,11 @@ def delete_face(person_group_id, person_id, persisted_face_id, custom_headers =
end
#
- # Delete a face from a person. Relative feature for the persisted face will
- # also be deleted.
+ # Delete a face from a person in a person group by specified personGroupId,
+ # personId and persistedFaceId.
+ #
Adding/deleting faces to/from a same person will be processed
+ # sequentially. Adding/deleting faces to/from different persons are processed
+ # in parallel.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.
@@ -555,8 +561,11 @@ def delete_face_with_http_info(person_group_id, person_id, persisted_face_id, cu
end
#
- # Delete a face from a person. Relative feature for the persisted face will
- # also be deleted.
+ # Delete a face from a person in a person group by specified personGroupId,
+ # personId and persistedFaceId.
+ #
Adding/deleting faces to/from a same person will be processed
+ # sequentially. Adding/deleting faces to/from different persons are processed
+ # in parallel.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.
@@ -710,7 +719,35 @@ def get_face_async(person_group_id, person_id, persisted_face_id, custom_headers
end
#
- # Update a person persisted face's userData field.
+ # Add a face to a person into a person group for face identification or
+ # verification. To deal with an image contains multiple faces, input face can
+ # be specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [PersonGroup
+ # PersonFace -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523e),
+ # [PersonGroup Person -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d)
+ # or [PersonGroup -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * Each person entry can hold up to 248 faces.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same person will be processed sequentially.
+ # Adding/deleting faces to/from different persons are processed in parallel.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.
@@ -728,7 +765,35 @@ def update_face(person_group_id, person_id, persisted_face_id, user_data = nil,
end
#
- # Update a person persisted face's userData field.
+ # Add a face to a person into a person group for face identification or
+ # verification. To deal with an image contains multiple faces, input face can
+ # be specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [PersonGroup
+ # PersonFace -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523e),
+ # [PersonGroup Person -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d)
+ # or [PersonGroup -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * Each person entry can hold up to 248 faces.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same person will be processed sequentially.
+ # Adding/deleting faces to/from different persons are processed in parallel.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.
@@ -746,7 +811,35 @@ def update_face_with_http_info(person_group_id, person_id, persisted_face_id, us
end
#
- # Update a person persisted face's userData field.
+ # Add a face to a person into a person group for face identification or
+ # verification. To deal with an image contains multiple faces, input face can
+ # be specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [PersonGroup
+ # PersonFace -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523e),
+ # [PersonGroup Person -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d)
+ # or [PersonGroup -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * Each person entry can hold up to 248 faces.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed
+ # image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces will
+ # be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or
+ # large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same person will be processed sequentially.
+ # Adding/deleting faces to/from different persons are processed in parallel.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.
@@ -815,8 +908,36 @@ def update_face_async(person_group_id, person_id, persisted_face_id, user_data =
end
#
- # Add a representative face to a person for identification. The input face is
- # specified as an image with a targetFace rectangle.
+ # Add a face to a person into a large person group for face identification or
+ # verification. To deal with an image contains multiple faces, input face can
+ # be specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [LargePersonGroup
+ # PersonFace -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ae2966ac60f11b48b5aa3),
+ # [LargePersonGroup Person -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2)
+ # or [LargePersonGroup -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * Each person entry can hold up to 248 faces.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The
+ # allowed image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces
+ # will be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose,
+ # or large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same person will be processed
+ # sequentially. Adding/deleting faces to/from different persons are processed
+ # in parallel.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.
@@ -840,8 +961,36 @@ def add_face_from_url(person_group_id, person_id, url, user_data = nil, target_f
end
#
- # Add a representative face to a person for identification. The input face is
- # specified as an image with a targetFace rectangle.
+ # Add a face to a person into a large person group for face identification or
+ # verification. To deal with an image contains multiple faces, input face can
+ # be specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [LargePersonGroup
+ # PersonFace -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ae2966ac60f11b48b5aa3),
+ # [LargePersonGroup Person -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2)
+ # or [LargePersonGroup -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * Each person entry can hold up to 248 faces.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The
+ # allowed image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces
+ # will be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose,
+ # or large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same person will be processed
+ # sequentially. Adding/deleting faces to/from different persons are processed
+ # in parallel.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.
@@ -864,8 +1013,36 @@ def add_face_from_url_with_http_info(person_group_id, person_id, url, user_data
end
#
- # Add a representative face to a person for identification. The input face is
- # specified as an image with a targetFace rectangle.
+ # Add a face to a person into a large person group for face identification or
+ # verification. To deal with an image contains multiple faces, input face can
+ # be specified as an image with a targetFace rectangle. It returns a
+ # persistedFaceId representing the added face. No image will be stored. Only
+ # the extracted face feature will be stored on server until [LargePersonGroup
+ # PersonFace -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ae2966ac60f11b48b5aa3),
+ # [LargePersonGroup Person -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599ade5c6ac60f11b48b5aa2)
+ # or [LargePersonGroup -
+ # Delete](/docs/services/563879b61984550e40cbbe8d/operations/599adc216ac60f11b48b5a9f)
+ # is called.
+ #
Note persistedFaceId is different from faceId generated by [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236).
+ # * Higher face image quality means better recognition precision. Please
+ # consider high-quality faces: frontal, clear, and face size is 200x200 pixels
+ # (100 pixels between eyes) or bigger.
+ # * Each person entry can hold up to 248 faces.
+ # * JPEG, PNG, GIF (the first frame), and BMP format are supported. The
+ # allowed image file size is from 1KB to 6MB.
+ # * "targetFace" rectangle should contain one face. Zero or multiple faces
+ # will be regarded as an error. If the provided "targetFace" rectangle is not
+ # returned from [Face -
+ # Detect](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236),
+ # there’s no guarantee to detect and add the face successfully.
+ # * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose,
+ # or large occlusions will cause failures.
+ # * Adding/deleting faces to/from a same person will be processed
+ # sequentially. Adding/deleting faces to/from different persons are processed
+ # in parallel.
#
# @param person_group_id [String] Id referencing a particular person group.
# @param person_id Id referencing a particular person.