azure_cognitiveservices_face 0.18.0 → 0.19.0

data/lib/1.0/generated/azure_cognitiveservices_face/face_client.rb

@@ -152,7 +152,7 @@ module Azure::CognitiveServices::Face::V1_0
     #
     def add_telemetry
         sdk_information = 'azure_cognitiveservices_face'
-        sdk_information = "#{sdk_information}/0.18.0"
+        sdk_information = "#{sdk_information}/0.19.0"
         add_user_agent_information(sdk_information)
     end
   end

data/lib/1.0/generated/azure_cognitiveservices_face/face_list_operations.rb

@@ -30,7 +30,8 @@ module Azure::CognitiveServices::Face::V1_0
     # Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
     # <br /> 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.
     # <br /> Find Similar is used for scenario like finding celebrity-like faces,
@@ -44,14 +45,20 @@ module Azure::CognitiveServices::Face::V1_0
     # <br /> 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
+    # <br />'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 @@ module Azure::CognitiveServices::Face::V1_0
     # Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
     # <br /> 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.
     # <br /> Find Similar is used for scenario like finding celebrity-like faces,
@@ -90,14 +98,20 @@ module Azure::CognitiveServices::Face::V1_0
     # <br /> 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
+    # <br />'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 @@ module Azure::CognitiveServices::Face::V1_0
     # Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
     # <br /> 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.
     # <br /> Find Similar is used for scenario like finding celebrity-like faces,
@@ -136,14 +151,20 @@ module Azure::CognitiveServices::Face::V1_0
     # <br /> 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
+    # <br />'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.
@@ -206,6 +227,8 @@ module Azure::CognitiveServices::Face::V1_0
         end
 
         result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
+        result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
 
         result
       end
@@ -298,6 +321,8 @@ module Azure::CognitiveServices::Face::V1_0
         end
 
         result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
+        result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
         # Deserialize Response
         if status_code == 200
           begin
@@ -406,6 +431,8 @@ module Azure::CognitiveServices::Face::V1_0
         end
 
         result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
+        result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
 
         result
       end
@@ -414,8 +441,7 @@ module Azure::CognitiveServices::Face::V1_0
     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
@@ -428,8 +454,7 @@ module Azure::CognitiveServices::Face::V1_0
     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
@@ -442,8 +467,7 @@ module Azure::CognitiveServices::Face::V1_0
     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
@@ -487,6 +511,8 @@ module Azure::CognitiveServices::Face::V1_0
         end
 
         result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
+        result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
 
         result
       end
@@ -575,6 +601,8 @@ module Azure::CognitiveServices::Face::V1_0
         end
 
         result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
+        result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
         # Deserialize Response
         if status_code == 200
           begin
@@ -609,8 +637,9 @@ module Azure::CognitiveServices::Face::V1_0
     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.
+    # <br /> 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
@@ -625,8 +654,9 @@ module Azure::CognitiveServices::Face::V1_0
     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.
+    # <br /> 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
@@ -641,8 +671,9 @@ module Azure::CognitiveServices::Face::V1_0
     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.
+    # <br /> 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
@@ -689,6 +720,8 @@ module Azure::CognitiveServices::Face::V1_0
         end
 
         result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
+        result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
 
         result
       end
@@ -697,9 +730,46 @@ module Azure::CognitiveServices::Face::V1_0
     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.
+    # <br /> 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.
+    # <br /> 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.
+    # * The minimum detectable face size is 36x36 pixels in an image no larger than
+    # 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will
+    # need a proportionally larger minimum face size.
+    # * Different 'detectionModel' values can be provided. To use and compare
+    # different detection models, please refer to [How to specify a detection
+    # model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)
+    # | Model | Recommended use-case(s) |
+    # | ---------- | -------- |
+    # | 'detection_01': | The default detection model for [FaceList - Add
+    # Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250).
+    # Recommend for near frontal face detection. For scenarios with exceptionally
+    # large angle (head-pose) faces, occluded faces or wrong image orientation, the
+    # faces in such cases may not be detected. |
+    # | 'detection_02': | Detection model released in 2019 May with improved
+    # accuracy especially on small, side and blurry faces. |
     #
     # @param face_list_id [String] Id referencing a particular face list.
     # @param url [String] Publicly reachable URL of an image
@@ -711,20 +781,63 @@ module Azure::CognitiveServices::Face::V1_0
     # is more than one face in the image, targetFace is required to specify which
     # face to add. No targetFace means there is only one face detected in the
     # entire image.
+    # @param detection_model [DetectionModel] Name of detection model. Detection
+    # model is used to detect faces in the submitted image. A detection model name
+    # can be provided when performing Face - Detect or (Large)FaceList - Add Face
+    # or (Large)PersonGroup - Add Face. The default value is 'detection_01', if
+    # another model is needed, please explicitly specify it. Possible values
+    # include: 'detection_01', 'detection_02'
     # @param custom_headers [Hash{String => String}] A hash of custom headers that
     # will be added to the HTTP request.
     #
     # @return [PersistedFace] operation results.
     #
-    def add_face_from_url(face_list_id, url, user_data:nil, target_face:nil, custom_headers:nil)
-      response = add_face_from_url_async(face_list_id, url, user_data:user_data, target_face:target_face, custom_headers:custom_headers).value!
+    def add_face_from_url(face_list_id, url, user_data:nil, target_face:nil, detection_model:nil, custom_headers:nil)
+      response = add_face_from_url_async(face_list_id, url, user_data:user_data, target_face:target_face, detection_model:detection_model, custom_headers:custom_headers).value!
       response.body unless response.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.
+    # <br /> 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.
+    # <br /> 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.
+    # * The minimum detectable face size is 36x36 pixels in an image no larger than
+    # 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will
+    # need a proportionally larger minimum face size.
+    # * Different 'detectionModel' values can be provided. To use and compare
+    # different detection models, please refer to [How to specify a detection
+    # model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)
+    # | Model | Recommended use-case(s) |
+    # | ---------- | -------- |
+    # | 'detection_01': | The default detection model for [FaceList - Add
+    # Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250).
+    # Recommend for near frontal face detection. For scenarios with exceptionally
+    # large angle (head-pose) faces, occluded faces or wrong image orientation, the
+    # faces in such cases may not be detected. |
+    # | 'detection_02': | Detection model released in 2019 May with improved
+    # accuracy especially on small, side and blurry faces. |
     #
     # @param face_list_id [String] Id referencing a particular face list.
     # @param url [String] Publicly reachable URL of an image
@@ -736,19 +849,62 @@ module Azure::CognitiveServices::Face::V1_0
     # is more than one face in the image, targetFace is required to specify which
     # face to add. No targetFace means there is only one face detected in the
     # entire image.
+    # @param detection_model [DetectionModel] Name of detection model. Detection
+    # model is used to detect faces in the submitted image. A detection model name
+    # can be provided when performing Face - Detect or (Large)FaceList - Add Face
+    # or (Large)PersonGroup - Add Face. The default value is 'detection_01', if
+    # another model is needed, please explicitly specify it. Possible values
+    # include: 'detection_01', 'detection_02'
     # @param custom_headers [Hash{String => String}] A hash of custom headers that
     # will be added to the HTTP request.
     #
     # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
     #
-    def add_face_from_url_with_http_info(face_list_id, url, user_data:nil, target_face:nil, custom_headers:nil)
-      add_face_from_url_async(face_list_id, url, user_data:user_data, target_face:target_face, custom_headers:custom_headers).value!
+    def add_face_from_url_with_http_info(face_list_id, url, user_data:nil, target_face:nil, detection_model:nil, custom_headers:nil)
+      add_face_from_url_async(face_list_id, url, user_data:user_data, target_face:target_face, detection_model:detection_model, custom_headers:custom_headers).value!
     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.
+    # <br /> 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.
+    # <br /> 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.
+    # * The minimum detectable face size is 36x36 pixels in an image no larger than
+    # 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will
+    # need a proportionally larger minimum face size.
+    # * Different 'detectionModel' values can be provided. To use and compare
+    # different detection models, please refer to [How to specify a detection
+    # model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)
+    # | Model | Recommended use-case(s) |
+    # | ---------- | -------- |
+    # | 'detection_01': | The default detection model for [FaceList - Add
+    # Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250).
+    # Recommend for near frontal face detection. For scenarios with exceptionally
+    # large angle (head-pose) faces, occluded faces or wrong image orientation, the
+    # faces in such cases may not be detected. |
+    # | 'detection_02': | Detection model released in 2019 May with improved
+    # accuracy especially on small, side and blurry faces. |
     #
     # @param face_list_id [String] Id referencing a particular face list.
     # @param url [String] Publicly reachable URL of an image
@@ -760,12 +916,18 @@ module Azure::CognitiveServices::Face::V1_0
     # is more than one face in the image, targetFace is required to specify which
     # face to add. No targetFace means there is only one face detected in the
     # entire image.
+    # @param detection_model [DetectionModel] Name of detection model. Detection
+    # model is used to detect faces in the submitted image. A detection model name
+    # can be provided when performing Face - Detect or (Large)FaceList - Add Face
+    # or (Large)PersonGroup - Add Face. The default value is 'detection_01', if
+    # another model is needed, please explicitly specify it. Possible values
+    # include: 'detection_01', 'detection_02'
     # @param [Hash{String => String}] A hash of custom headers that will be added
     # to the HTTP request.
     #
     # @return [Concurrent::Promise] Promise object which holds the HTTP response.
     #
-    def add_face_from_url_async(face_list_id, url, user_data:nil, target_face:nil, custom_headers:nil)
+    def add_face_from_url_async(face_list_id, url, user_data:nil, target_face:nil, detection_model:nil, custom_headers:nil)
       fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil?
       fail ArgumentError, 'face_list_id is nil' if face_list_id.nil?
       fail ArgumentError, "'face_list_id' should satisfy the constraint - 'MaxLength': '64'" if !face_list_id.nil? && face_list_id.length > 64
@@ -798,7 +960,7 @@ module Azure::CognitiveServices::Face::V1_0
       options = {
           middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
           path_params: {'faceListId' => face_list_id},
-          query_params: {'userData' => user_data,'targetFace' => target_face.nil? ? nil : target_face.join(',')},
+          query_params: {'userData' => user_data,'targetFace' => target_face.nil? ? nil : target_face.join(','),'detectionModel' => detection_model},
           body: request_content,
           headers: request_headers.merge(custom_headers || {}),
           base_url: request_url
@@ -815,6 +977,8 @@ module Azure::CognitiveServices::Face::V1_0
         end
 
         result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
+        result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
         # Deserialize Response
         if status_code == 200
           begin
@@ -833,9 +997,46 @@ module Azure::CognitiveServices::Face::V1_0
     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.
+    # <br /> 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.
+    # <br /> 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.
+    # * The minimum detectable face size is 36x36 pixels in an image no larger than
+    # 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will
+    # need a proportionally larger minimum face size.
+    # * Different 'detectionModel' values can be provided. To use and compare
+    # different detection models, please refer to [How to specify a detection
+    # model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)
+    # | Model | Recommended use-case(s) |
+    # | ---------- | -------- |
+    # | 'detection_01': | The default detection model for [FaceList - Add
+    # Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250).
+    # Recommend for near frontal face detection. For scenarios with exceptionally
+    # large angle (head-pose) faces, occluded faces or wrong image orientation, the
+    # faces in such cases may not be detected. |
+    # | 'detection_02': | Detection model released in 2019 May with improved
+    # accuracy especially on small, side and blurry faces. |
     #
     # @param face_list_id [String] Id referencing a particular face list.
     # @param image An image stream.
@@ -847,20 +1048,63 @@ module Azure::CognitiveServices::Face::V1_0
     # is more than one face in the image, targetFace is required to specify which
     # face to add. No targetFace means there is only one face detected in the
     # entire image.
+    # @param detection_model [DetectionModel] Name of detection model. Detection
+    # model is used to detect faces in the submitted image. A detection model name
+    # can be provided when performing Face - Detect or (Large)FaceList - Add Face
+    # or (Large)PersonGroup - Add Face. The default value is 'detection_01', if
+    # another model is needed, please explicitly specify it. Possible values
+    # include: 'detection_01', 'detection_02'
     # @param custom_headers [Hash{String => String}] A hash of custom headers that
     # will be added to the HTTP request.
     #
     # @return [PersistedFace] operation results.
     #
-    def add_face_from_stream(face_list_id, image, user_data:nil, target_face:nil, custom_headers:nil)
-      response = add_face_from_stream_async(face_list_id, image, user_data:user_data, target_face:target_face, custom_headers:custom_headers).value!
+    def add_face_from_stream(face_list_id, image, user_data:nil, target_face:nil, detection_model:nil, custom_headers:nil)
+      response = add_face_from_stream_async(face_list_id, image, user_data:user_data, target_face:target_face, detection_model:detection_model, custom_headers:custom_headers).value!
       response.body unless response.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.
+    # <br /> 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.
+    # <br /> 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.
+    # * The minimum detectable face size is 36x36 pixels in an image no larger than
+    # 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will
+    # need a proportionally larger minimum face size.
+    # * Different 'detectionModel' values can be provided. To use and compare
+    # different detection models, please refer to [How to specify a detection
+    # model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)
+    # | Model | Recommended use-case(s) |
+    # | ---------- | -------- |
+    # | 'detection_01': | The default detection model for [FaceList - Add
+    # Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250).
+    # Recommend for near frontal face detection. For scenarios with exceptionally
+    # large angle (head-pose) faces, occluded faces or wrong image orientation, the
+    # faces in such cases may not be detected. |
+    # | 'detection_02': | Detection model released in 2019 May with improved
+    # accuracy especially on small, side and blurry faces. |
     #
     # @param face_list_id [String] Id referencing a particular face list.
     # @param image An image stream.
@@ -872,19 +1116,62 @@ module Azure::CognitiveServices::Face::V1_0
     # is more than one face in the image, targetFace is required to specify which
     # face to add. No targetFace means there is only one face detected in the
     # entire image.
+    # @param detection_model [DetectionModel] Name of detection model. Detection
+    # model is used to detect faces in the submitted image. A detection model name
+    # can be provided when performing Face - Detect or (Large)FaceList - Add Face
+    # or (Large)PersonGroup - Add Face. The default value is 'detection_01', if
+    # another model is needed, please explicitly specify it. Possible values
+    # include: 'detection_01', 'detection_02'
     # @param custom_headers [Hash{String => String}] A hash of custom headers that
     # will be added to the HTTP request.
     #
     # @return [MsRestAzure::AzureOperationResponse] HTTP response information.
     #
-    def add_face_from_stream_with_http_info(face_list_id, image, user_data:nil, target_face:nil, custom_headers:nil)
-      add_face_from_stream_async(face_list_id, image, user_data:user_data, target_face:target_face, custom_headers:custom_headers).value!
+    def add_face_from_stream_with_http_info(face_list_id, image, user_data:nil, target_face:nil, detection_model:nil, custom_headers:nil)
+      add_face_from_stream_async(face_list_id, image, user_data:user_data, target_face:target_face, detection_model:detection_model, custom_headers:custom_headers).value!
     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.
+    # <br /> 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.
+    # <br /> 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.
+    # * The minimum detectable face size is 36x36 pixels in an image no larger than
+    # 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will
+    # need a proportionally larger minimum face size.
+    # * Different 'detectionModel' values can be provided. To use and compare
+    # different detection models, please refer to [How to specify a detection
+    # model](https://docs.microsoft.com/en-us/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)
+    # | Model | Recommended use-case(s) |
+    # | ---------- | -------- |
+    # | 'detection_01': | The default detection model for [FaceList - Add
+    # Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250).
+    # Recommend for near frontal face detection. For scenarios with exceptionally
+    # large angle (head-pose) faces, occluded faces or wrong image orientation, the
+    # faces in such cases may not be detected. |
+    # | 'detection_02': | Detection model released in 2019 May with improved
+    # accuracy especially on small, side and blurry faces. |
     #
     # @param face_list_id [String] Id referencing a particular face list.
     # @param image An image stream.
@@ -896,12 +1183,18 @@ module Azure::CognitiveServices::Face::V1_0
     # is more than one face in the image, targetFace is required to specify which
     # face to add. No targetFace means there is only one face detected in the
     # entire image.
+    # @param detection_model [DetectionModel] Name of detection model. Detection
+    # model is used to detect faces in the submitted image. A detection model name
+    # can be provided when performing Face - Detect or (Large)FaceList - Add Face
+    # or (Large)PersonGroup - Add Face. The default value is 'detection_01', if
+    # another model is needed, please explicitly specify it. Possible values
+    # include: 'detection_01', 'detection_02'
     # @param [Hash{String => String}] A hash of custom headers that will be added
     # to the HTTP request.
     #
     # @return [Concurrent::Promise] Promise object which holds the HTTP response.
     #
-    def add_face_from_stream_async(face_list_id, image, user_data:nil, target_face:nil, custom_headers:nil)
+    def add_face_from_stream_async(face_list_id, image, user_data:nil, target_face:nil, detection_model:nil, custom_headers:nil)
       fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil?
       fail ArgumentError, 'face_list_id is nil' if face_list_id.nil?
       fail ArgumentError, "'face_list_id' should satisfy the constraint - 'MaxLength': '64'" if !face_list_id.nil? && face_list_id.length > 64
@@ -936,7 +1229,7 @@ module Azure::CognitiveServices::Face::V1_0
       options = {
           middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
           path_params: {'faceListId' => face_list_id},
-          query_params: {'userData' => user_data,'targetFace' => target_face.nil? ? nil : target_face.join(',')},
+          query_params: {'userData' => user_data,'targetFace' => target_face.nil? ? nil : target_face.join(','),'detectionModel' => detection_model},
           body: request_content,
           headers: request_headers.merge(custom_headers || {}),
           base_url: request_url
@@ -953,6 +1246,8 @@ module Azure::CognitiveServices::Face::V1_0
         end
 
         result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
+        result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
+        result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
         # Deserialize Response
         if status_code == 200
           begin