aws-sdk-rekognition 1.31.0 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4175be83c7517e7157ab7b8231ec430c9b574e0b
-  data.tar.gz: b4808a84e5b10fb3d7ca2323f6cec9b747ee28ac
+  metadata.gz: f88df947d010d4e4f6f23ddb3275063422b232c1
+  data.tar.gz: 4fb28d5dc55cbc5c057706a248047e3543c8ff31
 SHA512:
-  metadata.gz: 497a008ac620a46a76094a4bddda196505ff7a9069778e25ab4bed20dcb95f992193341eb1332db091a912383193a327fb4a8c4c0ac44dab0758fcd8d79b766d
-  data.tar.gz: 41d952d25f7114fe6efa99cc5dfd8f3800211c8d424ec4555a41c78f735fb8b75fe74f24bf2a83e3b4e98b198e25fc7396f0ed2870fc78014e01e18e821a7776
+  metadata.gz: e1abdd86e56212e4c23ab773d10e21d83b25c952bd75d0540a695c39b9d486aa0ca322c19dc5172ffbb2889583799c8853be3df10c75d09f5b8134b3c4d78a93
+  data.tar.gz: e750ce1b80b67746276fb4ff373eca36b6b6b56164e3881c5e4db00f8f3417cf1f2d1a1b9c15a0344417d1a7966a3f9a450be396c51a9ba55f931e0432ea6af5

data/lib/aws-sdk-rekognition.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-rekognition/customizations'
 # @service
 module Aws::Rekognition
 
-  GEM_VERSION = '1.31.0'
+  GEM_VERSION = '1.32.0'
 
 end

data/lib/aws-sdk-rekognition/client.rb

@@ -298,6 +298,20 @@ module Aws::Rekognition
     # information about the face in the source image, including the bounding
     # box of the face and confidence value.
     #
+    # The `QualityFilter` input parameter allows you to filter out detected
+    # faces that don’t meet a required quality bar. The quality bar is based
+    # on a variety of common use cases. By default, `CompareFaces` chooses
+    # the quality bar that's used to filter faces. You can also explicitly
+    # choose the quality bar. Use `QualityFilter`, to set the quality bar by
+    # specifying `LOW`, `MEDIUM`, or `HIGH`. If you do not want to filter
+    # detected faces, specify `NONE`.
+    #
+    # <note markdown="1"> To use quality filtering, you need a collection associated with
+    # version 3 of the face model or higher. To get the version of the face
+    # model associated with a collection, call DescribeCollection.
+    #
+    #  </note>
+    #
     # If the image doesn't contain Exif metadata, `CompareFaces` returns
     # orientation information for the source and target images. Use these
     # values to display the images with the correct image orientation.
@@ -340,6 +354,21 @@ module Aws::Rekognition
     #   The minimum level of confidence in the face matches that a match must
     #   meet to be included in the `FaceMatches` array.
     #
+    # @option params [String] :quality_filter
+    #   A filter that specifies a quality bar for how much filtering is done
+    #   to identify faces. Filtered faces aren't compared. If you specify
+    #   `AUTO`, Amazon Rekognition chooses the quality bar. If you specify
+    #   `LOW`, `MEDIUM`, or `HIGH`, filtering removes all faces that don’t
+    #   meet the chosen quality bar. The default value is `AUTO`. The quality
+    #   bar is based on a variety of common use cases. Low-quality detections
+    #   can occur for a number of reasons. Some examples are an object that's
+    #   misidentified as a face, a face that's too blurry, or a face with a
+    #   pose that's too extreme to use. If you specify `NONE`, no filtering
+    #   is performed.
+    #
+    #   To use quality filtering, the collection you are using must be
+    #   associated with version 3 of the face model or higher.
+    #
     # @return [Types::CompareFacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CompareFacesResponse#source_image_face #source_image_face} => Types::ComparedSourceImageFace
@@ -416,6 +445,7 @@ module Aws::Rekognition
     #       },
     #     },
     #     similarity_threshold: 1.0,
+    #     quality_filter: "NONE", # accepts NONE, AUTO, LOW, MEDIUM, HIGH
     #   })
     #
     # @example Response structure
@@ -823,8 +853,8 @@ module Aws::Rekognition
     # face detected, the operation returns face details. These details
     # include a bounding box of the face, a confidence value (that the
     # bounding box contains a face), and a fixed set of attributes such as
-    # facial landmarks (for example, coordinates of eye and mouth), gender,
-    # presence of beard, sunglasses, and so on.
+    # facial landmarks (for example, coordinates of eye and mouth), presence
+    # of beard, sunglasses, and so on.
     #
     # The face-detection algorithm is most effective on frontal faces. For
     # non-frontal or obscured faces, the algorithm might not detect the
@@ -2174,16 +2204,16 @@ module Aws::Rekognition
     # as those belonging to people standing in the background.
     #
     # The `QualityFilter` input parameter allows you to filter out detected
-    # faces that don’t meet the required quality bar chosen by Amazon
-    # Rekognition. The quality bar is based on a variety of common use
-    # cases. By default, `IndexFaces` filters detected faces. You can also
-    # explicitly filter detected faces by specifying `AUTO` for the value of
-    # `QualityFilter`. If you do not want to filter detected faces, specify
-    # `NONE`.
+    # faces that don’t meet a required quality bar. The quality bar is based
+    # on a variety of common use cases. By default, `IndexFaces` chooses the
+    # quality bar that's used to filter faces. You can also explicitly
+    # choose the quality bar. Use `QualityFilter`, to set the quality bar by
+    # specifying `LOW`, `MEDIUM`, or `HIGH`. If you do not want to filter
+    # detected faces, specify `NONE`.
     #
     # <note markdown="1"> To use quality filtering, you need a collection associated with
-    # version 3 of the face model. To get the version of the face model
-    # associated with a collection, call DescribeCollection.
+    # version 3 of the face model or higher. To get the version of the face
+    # model associated with a collection, call DescribeCollection.
     #
     #  </note>
     #
@@ -2202,6 +2232,8 @@ module Aws::Rekognition
     #
     # * The face has an extreme pose.
     #
+    # * The face doesn’t have enough detail to be suitable for face search.
+    #
     # In response, the `IndexFaces` operation returns an array of metadata
     # for all detected faces, `FaceRecords`. This includes:
     #
@@ -2218,10 +2250,10 @@ module Aws::Rekognition
     # If you request all facial attributes (by using the
     # `detectionAttributes` parameter), Amazon Rekognition returns detailed
     # facial attributes, such as facial landmarks (for example, location of
-    # eye and mouth) and other facial attributes like gender. If you provide
-    # the same image, specify the same collection, and use the same external
-    # ID in the `IndexFaces` operation, Amazon Rekognition doesn't save
-    # duplicate face metadata.
+    # eye and mouth) and other facial attributes. If you provide the same
+    # image, specify the same collection, and use the same external ID in
+    # the `IndexFaces` operation, Amazon Rekognition doesn't save duplicate
+    # face metadata.
     #
     #
     #
@@ -2283,18 +2315,19 @@ module Aws::Rekognition
     #   of the face model.
     #
     # @option params [String] :quality_filter
-    #   A filter that specifies how much filtering is done to identify faces
-    #   that are detected with low quality. Filtered faces aren't indexed. If
-    #   you specify `AUTO`, filtering prioritizes the identification of faces
-    #   that don’t meet the required quality bar chosen by Amazon Rekognition.
-    #   The quality bar is based on a variety of common use cases. Low-quality
-    #   detections can occur for a number of reasons. Some examples are an
-    #   object that's misidentified as a face, a face that's too blurry, or
-    #   a face with a pose that's too extreme to use. If you specify `NONE`,
-    #   no filtering is performed. The default value is AUTO.
+    #   A filter that specifies a quality bar for how much filtering is done
+    #   to identify faces. Filtered faces aren't indexed. If you specify
+    #   `AUTO`, Amazon Rekognition chooses the quality bar. If you specify
+    #   `LOW`, `MEDIUM`, or `HIGH`, filtering removes all faces that don’t
+    #   meet the chosen quality bar. The default value is `AUTO`. The quality
+    #   bar is based on a variety of common use cases. Low-quality detections
+    #   can occur for a number of reasons. Some examples are an object that's
+    #   misidentified as a face, a face that's too blurry, or a face with a
+    #   pose that's too extreme to use. If you specify `NONE`, no filtering
+    #   is performed.
     #
     #   To use quality filtering, the collection you are using must be
-    #   associated with version 3 of the face model.
+    #   associated with version 3 of the face model or higher.
     #
     # @return [Types::IndexFacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -2459,7 +2492,7 @@ module Aws::Rekognition
     #     external_image_id: "ExternalImageId",
     #     detection_attributes: ["DEFAULT"], # accepts DEFAULT, ALL
     #     max_faces: 1,
-    #     quality_filter: "NONE", # accepts NONE, AUTO
+    #     quality_filter: "NONE", # accepts NONE, AUTO, LOW, MEDIUM, HIGH
     #   })
     #
     # @example Response structure
@@ -2512,7 +2545,7 @@ module Aws::Rekognition
     #   resp.face_model_version #=> String
     #   resp.unindexed_faces #=> Array
     #   resp.unindexed_faces[0].reasons #=> Array
-    #   resp.unindexed_faces[0].reasons[0] #=> String, one of "EXCEEDS_MAX_FACES", "EXTREME_POSE", "LOW_BRIGHTNESS", "LOW_SHARPNESS", "LOW_CONFIDENCE", "SMALL_BOUNDING_BOX"
+    #   resp.unindexed_faces[0].reasons[0] #=> String, one of "EXCEEDS_MAX_FACES", "EXTREME_POSE", "LOW_BRIGHTNESS", "LOW_SHARPNESS", "LOW_CONFIDENCE", "SMALL_BOUNDING_BOX", "LOW_FACE_QUALITY"
     #   resp.unindexed_faces[0].face_detail.bounding_box.width #=> Float
     #   resp.unindexed_faces[0].face_detail.bounding_box.height #=> Float
     #   resp.unindexed_faces[0].face_detail.bounding_box.left #=> Float
@@ -3126,6 +3159,20 @@ module Aws::Rekognition
     # For an example, Searching for a Face Using an Image in the Amazon
     # Rekognition Developer Guide.
     #
+    # The `QualityFilter` input parameter allows you to filter out detected
+    # faces that don’t meet a required quality bar. The quality bar is based
+    # on a variety of common use cases. By default, Amazon Rekognition
+    # chooses the quality bar that's used to filter faces. You can also
+    # explicitly choose the quality bar. Use `QualityFilter`, to set the
+    # quality bar for filtering by specifying `LOW`, `MEDIUM`, or `HIGH`. If
+    # you do not want to filter detected faces, specify `NONE`.
+    #
+    # <note markdown="1"> To use quality filtering, you need a collection associated with
+    # version 3 of the face model or higher. To get the version of the face
+    # model associated with a collection, call DescribeCollection.
+    #
+    #  </note>
+    #
     # This operation requires permissions to perform the
     # `rekognition:SearchFacesByImage` action.
     #
@@ -3151,6 +3198,21 @@ module Aws::Rekognition
     #   return. For example, don't return any matches where confidence in
     #   matches is less than 70%. The default value is 80%.
     #
+    # @option params [String] :quality_filter
+    #   A filter that specifies a quality bar for how much filtering is done
+    #   to identify faces. Filtered faces aren't searched for in the
+    #   collection. If you specify `AUTO`, Amazon Rekognition chooses the
+    #   quality bar. If you specify `LOW`, `MEDIUM`, or `HIGH`, filtering
+    #   removes all faces that don’t meet the chosen quality bar. The default
+    #   value is `AUTO`. The quality bar is based on a variety of common use
+    #   cases. Low-quality detections can occur for a number of reasons. Some
+    #   examples are an object that's misidentified as a face, a face that's
+    #   too blurry, or a face with a pose that's too extreme to use. If you
+    #   specify `NONE`, no filtering is performed.
+    #
+    #   To use quality filtering, the collection you are using must be
+    #   associated with version 3 of the face model or higher.
+    #
     # @return [Types::SearchFacesByImageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::SearchFacesByImageResponse#searched_face_bounding_box #searched_face_bounding_box} => Types::BoundingBox
@@ -3216,6 +3278,7 @@ module Aws::Rekognition
     #     },
     #     max_faces: 1,
     #     face_match_threshold: 1.0,
+    #     quality_filter: "NONE", # accepts NONE, AUTO, LOW, MEDIUM, HIGH
     #   })
     #
     # @example Response structure
@@ -3767,7 +3830,7 @@ module Aws::Rekognition
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rekognition'
-      context[:gem_version] = '1.31.0'
+      context[:gem_version] = '1.32.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-rekognition/client_api.rb

@@ -276,6 +276,7 @@ module Aws::Rekognition
     CompareFacesRequest.add_member(:source_image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "SourceImage"))
     CompareFacesRequest.add_member(:target_image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "TargetImage"))
     CompareFacesRequest.add_member(:similarity_threshold, Shapes::ShapeRef.new(shape: Percent, location_name: "SimilarityThreshold"))
+    CompareFacesRequest.add_member(:quality_filter, Shapes::ShapeRef.new(shape: QualityFilter, location_name: "QualityFilter"))
     CompareFacesRequest.struct_class = Types::CompareFacesRequest
 
     CompareFacesResponse.add_member(:source_image_face, Shapes::ShapeRef.new(shape: ComparedSourceImageFace, location_name: "SourceImageFace"))
@@ -714,6 +715,7 @@ module Aws::Rekognition
     SearchFacesByImageRequest.add_member(:image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "Image"))
     SearchFacesByImageRequest.add_member(:max_faces, Shapes::ShapeRef.new(shape: MaxFaces, location_name: "MaxFaces"))
     SearchFacesByImageRequest.add_member(:face_match_threshold, Shapes::ShapeRef.new(shape: Percent, location_name: "FaceMatchThreshold"))
+    SearchFacesByImageRequest.add_member(:quality_filter, Shapes::ShapeRef.new(shape: QualityFilter, location_name: "QualityFilter"))
     SearchFacesByImageRequest.struct_class = Types::SearchFacesByImageRequest
 
     SearchFacesByImageResponse.add_member(:searched_face_bounding_box, Shapes::ShapeRef.new(shape: BoundingBox, location_name: "SearchedFaceBoundingBox"))

data/lib/aws-sdk-rekognition/types.rb

@@ -231,6 +231,7 @@ module Aws::Rekognition
     #           },
     #         },
     #         similarity_threshold: 1.0,
+    #         quality_filter: "NONE", # accepts NONE, AUTO, LOW, MEDIUM, HIGH
     #       }
     #
     # @!attribute [rw] source_image
@@ -260,10 +261,27 @@ module Aws::Rekognition
     #   must meet to be included in the `FaceMatches` array.
     #   @return [Float]
     #
+    # @!attribute [rw] quality_filter
+    #   A filter that specifies a quality bar for how much filtering is done
+    #   to identify faces. Filtered faces aren't compared. If you specify
+    #   `AUTO`, Amazon Rekognition chooses the quality bar. If you specify
+    #   `LOW`, `MEDIUM`, or `HIGH`, filtering removes all faces that don’t
+    #   meet the chosen quality bar. The default value is `AUTO`. The
+    #   quality bar is based on a variety of common use cases. Low-quality
+    #   detections can occur for a number of reasons. Some examples are an
+    #   object that's misidentified as a face, a face that's too blurry,
+    #   or a face with a pose that's too extreme to use. If you specify
+    #   `NONE`, no filtering is performed.
+    #
+    #   To use quality filtering, the collection you are using must be
+    #   associated with version 3 of the face model or higher.
+    #   @return [String]
+    #
     class CompareFacesRequest < Struct.new(
       :source_image,
       :target_image,
-      :similarity_threshold)
+      :similarity_threshold,
+      :quality_filter)
       include Aws::Structure
     end
 
@@ -1093,7 +1111,7 @@ module Aws::Rekognition
     #   @return [Types::Sunglasses]
     #
     # @!attribute [rw] gender
-    #   Gender of the face and the confidence level in the determination.
+    #   The predicted gender of a detected face.
     #   @return [Types::Gender]
     #
     # @!attribute [rw] beard
@@ -1249,14 +1267,30 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # Gender of the face and the confidence level in the determination.
+    # The predicted gender of a detected face.
+    #
+    # Amazon Rekognition makes gender binary (male/female) predictions based
+    # on the physical appearance of a face in a particular image. This kind
+    # of prediction is not designed to categorize a person’s gender
+    # identity, and you shouldn't use Amazon Rekognition to make such a
+    # determination. For example, a male actor wearing a long-haired wig and
+    # earrings for a role might be predicted as female.
+    #
+    # Using Amazon Rekognition to make gender binary predictions is best
+    # suited for use cases where aggregate gender distribution statistics
+    # need to be analyzed without identifying specific users. For example,
+    # the percentage of female users compared to male users on a social
+    # media platform.
+    #
+    # We don't recommend using gender binary predictions to make decisions
+    # that impact
 an individual's rights, privacy, or access to services.
     #
     # @!attribute [rw] value
-    #   Gender of the face.
+    #   The predicted gender of the face.
     #   @return [String]
     #
     # @!attribute [rw] confidence
-    #   Level of confidence in the determination.
+    #   Level of confidence in the prediction.
     #   @return [Float]
     #
     class Gender < Struct.new(
@@ -1894,7 +1928,7 @@ module Aws::Rekognition
     #         external_image_id: "ExternalImageId",
     #         detection_attributes: ["DEFAULT"], # accepts DEFAULT, ALL
     #         max_faces: 1,
-    #         quality_filter: "NONE", # accepts NONE, AUTO
+    #         quality_filter: "NONE", # accepts NONE, AUTO, LOW, MEDIUM, HIGH
     #       }
     #
     # @!attribute [rw] collection_id
@@ -1953,19 +1987,19 @@ module Aws::Rekognition
     #   @return [Integer]
     #
     # @!attribute [rw] quality_filter
-    #   A filter that specifies how much filtering is done to identify faces
-    #   that are detected with low quality. Filtered faces aren't indexed.
-    #   If you specify `AUTO`, filtering prioritizes the identification of
-    #   faces that don’t meet the required quality bar chosen by Amazon
-    #   Rekognition. The quality bar is based on a variety of common use
-    #   cases. Low-quality detections can occur for a number of reasons.
-    #   Some examples are an object that's misidentified as a face, a face
-    #   that's too blurry, or a face with a pose that's too extreme to
-    #   use. If you specify `NONE`, no filtering is performed. The default
-    #   value is AUTO.
+    #   A filter that specifies a quality bar for how much filtering is done
+    #   to identify faces. Filtered faces aren't indexed. If you specify
+    #   `AUTO`, Amazon Rekognition chooses the quality bar. If you specify
+    #   `LOW`, `MEDIUM`, or `HIGH`, filtering removes all faces that don’t
+    #   meet the chosen quality bar. The default value is `AUTO`. The
+    #   quality bar is based on a variety of common use cases. Low-quality
+    #   detections can occur for a number of reasons. Some examples are an
+    #   object that's misidentified as a face, a face that's too blurry,
+    #   or a face with a pose that's too extreme to use. If you specify
+    #   `NONE`, no filtering is performed.
     #
     #   To use quality filtering, the collection you are using must be
-    #   associated with version 3 of the face model.
+    #   associated with version 3 of the face model or higher.
     #   @return [String]
     #
     class IndexFacesRequest < Struct.new(
@@ -2653,6 +2687,7 @@ module Aws::Rekognition
     #         },
     #         max_faces: 1,
     #         face_match_threshold: 1.0,
+    #         quality_filter: "NONE", # accepts NONE, AUTO, LOW, MEDIUM, HIGH
     #       }
     #
     # @!attribute [rw] collection_id
@@ -2681,11 +2716,28 @@ module Aws::Rekognition
     #   matches is less than 70%. The default value is 80%.
     #   @return [Float]
     #
+    # @!attribute [rw] quality_filter
+    #   A filter that specifies a quality bar for how much filtering is done
+    #   to identify faces. Filtered faces aren't searched for in the
+    #   collection. If you specify `AUTO`, Amazon Rekognition chooses the
+    #   quality bar. If you specify `LOW`, `MEDIUM`, or `HIGH`, filtering
+    #   removes all faces that don’t meet the chosen quality bar. The
+    #   default value is `AUTO`. The quality bar is based on a variety of
+    #   common use cases. Low-quality detections can occur for a number of
+    #   reasons. Some examples are an object that's misidentified as a
+    #   face, a face that's too blurry, or a face with a pose that's too
+    #   extreme to use. If you specify `NONE`, no filtering is performed.
+    #
+    #   To use quality filtering, the collection you are using must be
+    #   associated with version 3 of the face model or higher.
+    #   @return [String]
+    #
     class SearchFacesByImageRequest < Struct.new(
       :collection_id,
       :image,
       :max_faces,
-      :face_match_threshold)
+      :face_match_threshold,
+      :quality_filter)
       include Aws::Structure
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rekognition
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.32.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2019-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core