aws-sdk-rekognition 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e0615e468443cc3292514031d09a9de486acc63
-  data.tar.gz: 51ea7ec4153e8b23a5613ddff5a0e858a49cc1ba
+  metadata.gz: 2d3fa98f7cf90ae98ab69e6a5ff00cd0f761fa77
+  data.tar.gz: 56ab01ad98223353ce59a4d9aff1a9a2be4f495f
 SHA512:
-  metadata.gz: 63c95533980ec3354aaf38719841d931bd00001ded444094547d26e50acaa912f0d0ce776fdb35de6e0642ce3ba3e4425a726697db2f77c1cd993b874da655f0
-  data.tar.gz: d18bc9fc1c96aeffea5158c58f788ddca944e2a86cdab834719299fed2c1efd6a5c6cb0cd660adb598e708bb4763874085ac0e1d93803eea95568e9838b403cc
+  metadata.gz: 36053a204711eb24d5f0197ebead895c1d55a1f6e3bcd6ac2b758837fcb5683934a9af26c9880ddf5b49ca4f7f506d61abd455efa55d28186df567419fdf7ebd
+  data.tar.gz: c53dcd5b2a2e70d02977007b159155bb653eaca964c239b48c6f76fc1b6179700401aee098ead40258ef9050042d2c25432b5d8cf58813d690db502974710220

data/lib/aws-sdk-rekognition.rb

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

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

@@ -1997,18 +1997,53 @@ module Aws::Rekognition
     # client-side index to associate the faces with each image. You can then
     # use the index to find all faces in an image.
     #
+    # You can specify the maximum number of faces to index with the
+    # `MaxFaces` input parameter. This is useful when you want to index the
+    # largest faces in an image, and you don't want to index other faces
+    # detected in the image.
+    #
+    # 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.
+    #
     # In response, the operation returns an array of metadata for all
-    # detected faces. This includes, the bounding box of the detected face,
-    # confidence value (indicating the bounding box contains a face), a face
-    # ID assigned by the service for each face that is detected and stored,
-    # and an image ID assigned by the service for the input image. If you
-    # request all facial attributes (using the `detectionAttributes`
-    # parameter, Amazon Rekognition returns detailed facial attributes such
+    # detected faces, `FaceRecords`. This includes:
+    #
+    # * The bounding box, `BoundingBox`, of the detected face.
+    #
+    # * A confidence value, `Confidence`, indicating the confidence that the
+    #   bounding box contains a face.
+    #
+    # * A face ID, `faceId`, assigned by the service for each face that is
+    #   detected and stored.
+    #
+    # * An image ID, `ImageId`, assigned by the service for the input image.
+    #
+    # If you request all facial attributes (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 such 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.
     #
+    # Information about faces detected in an image, but not indexed, is
+    # returned in an array of objects, `UnindexedFaces`. Faces are not
+    # indexed for reasons such as:
+    #
+    # * The face is too blurry.
+    #
+    # * The image is too dark.
+    #
+    # * The face has an extreme pose.
+    #
+    # * The face is too small.
+    #
+    # * The number of faces detected exceeds the value of the `MaxFaces`
+    #   request parameter.
+    #
+    #
+    #
     # For more information, see Adding Faces to a Collection in the Amazon
     # Rekognition Developer Guide.
     #
@@ -2045,11 +2080,39 @@ module Aws::Rekognition
     #   AND operator to determine which attributes to return (in this case,
     #   all attributes).
     #
+    # @option params [Integer] :max_faces
+    #   The maximum number of faces to index. The value of `MaxFaces` must be
+    #   greater than or equal to 1. `IndexFaces` returns no more that 100
+    #   detected faces in an image, even if you specify a larger value for
+    #   `MaxFaces`.
+    #
+    #   If `IndexFaces` detects more faces than the value of `MaxFaces`, the
+    #   faces with the lowest quality are filtered out first. If there are
+    #   still more faces than the value of `MaxFaces`, the faces with the
+    #   smallest bounding boxes are filtered out (up to the number needed to
+    #   satisfy the value of `MaxFaces`). Information about the unindexed
+    #   faces is available in the `UnindexedFaces` array.
+    #
+    #   The faces returned by `IndexFaces` are sorted, in descending order, by
+    #   the largest face bounding box size, to the smallest.
+    #
+    # @option params [String] :quality_filter
+    #   Specifies how much filtering is done to identify faces detected with
+    #   low quality. Filtered faces are not 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
+    #   arise for a number of reasons. For example, an object misidentified as
+    #   a face, a face that is too blurry, or a face with a pose that is too
+    #   extreme to use. If you specify `NONE`, no filtering is performed. The
+    #   default value is NONE.
+    #
     # @return [Types::IndexFacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::IndexFacesResponse#face_records #face_records} => Array<Types::FaceRecord>
     #   * {Types::IndexFacesResponse#orientation_correction #orientation_correction} => String
     #   * {Types::IndexFacesResponse#face_model_version #face_model_version} => String
+    #   * {Types::IndexFacesResponse#unindexed_faces #unindexed_faces} => Array<Types::UnindexedFace>
     #
     #
     # @example Example: To add a face to a collection
@@ -2206,6 +2269,8 @@ module Aws::Rekognition
     #     },
     #     external_image_id: "ExternalImageId",
     #     detection_attributes: ["DEFAULT"], # accepts DEFAULT, ALL
+    #     max_faces: 1,
+    #     quality_filter: "NONE", # accepts NONE, AUTO
     #   })
     #
     # @example Response structure
@@ -2256,6 +2321,44 @@ module Aws::Rekognition
     #   resp.face_records[0].face_detail.confidence #=> Float
     #   resp.orientation_correction #=> String, one of "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270"
     #   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].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
+    #   resp.unindexed_faces[0].face_detail.bounding_box.top #=> Float
+    #   resp.unindexed_faces[0].face_detail.age_range.low #=> Integer
+    #   resp.unindexed_faces[0].face_detail.age_range.high #=> Integer
+    #   resp.unindexed_faces[0].face_detail.smile.value #=> Boolean
+    #   resp.unindexed_faces[0].face_detail.smile.confidence #=> Float
+    #   resp.unindexed_faces[0].face_detail.eyeglasses.value #=> Boolean
+    #   resp.unindexed_faces[0].face_detail.eyeglasses.confidence #=> Float
+    #   resp.unindexed_faces[0].face_detail.sunglasses.value #=> Boolean
+    #   resp.unindexed_faces[0].face_detail.sunglasses.confidence #=> Float
+    #   resp.unindexed_faces[0].face_detail.gender.value #=> String, one of "Male", "Female"
+    #   resp.unindexed_faces[0].face_detail.gender.confidence #=> Float
+    #   resp.unindexed_faces[0].face_detail.beard.value #=> Boolean
+    #   resp.unindexed_faces[0].face_detail.beard.confidence #=> Float
+    #   resp.unindexed_faces[0].face_detail.mustache.value #=> Boolean
+    #   resp.unindexed_faces[0].face_detail.mustache.confidence #=> Float
+    #   resp.unindexed_faces[0].face_detail.eyes_open.value #=> Boolean
+    #   resp.unindexed_faces[0].face_detail.eyes_open.confidence #=> Float
+    #   resp.unindexed_faces[0].face_detail.mouth_open.value #=> Boolean
+    #   resp.unindexed_faces[0].face_detail.mouth_open.confidence #=> Float
+    #   resp.unindexed_faces[0].face_detail.emotions #=> Array
+    #   resp.unindexed_faces[0].face_detail.emotions[0].type #=> String, one of "HAPPY", "SAD", "ANGRY", "CONFUSED", "DISGUSTED", "SURPRISED", "CALM", "UNKNOWN"
+    #   resp.unindexed_faces[0].face_detail.emotions[0].confidence #=> Float
+    #   resp.unindexed_faces[0].face_detail.landmarks #=> Array
+    #   resp.unindexed_faces[0].face_detail.landmarks[0].type #=> String, one of "eyeLeft", "eyeRight", "nose", "mouthLeft", "mouthRight", "leftEyeBrowLeft", "leftEyeBrowRight", "leftEyeBrowUp", "rightEyeBrowLeft", "rightEyeBrowRight", "rightEyeBrowUp", "leftEyeLeft", "leftEyeRight", "leftEyeUp", "leftEyeDown", "rightEyeLeft", "rightEyeRight", "rightEyeUp", "rightEyeDown", "noseLeft", "noseRight", "mouthUp", "mouthDown", "leftPupil", "rightPupil"
+    #   resp.unindexed_faces[0].face_detail.landmarks[0].x #=> Float
+    #   resp.unindexed_faces[0].face_detail.landmarks[0].y #=> Float
+    #   resp.unindexed_faces[0].face_detail.pose.roll #=> Float
+    #   resp.unindexed_faces[0].face_detail.pose.yaw #=> Float
+    #   resp.unindexed_faces[0].face_detail.pose.pitch #=> Float
+    #   resp.unindexed_faces[0].face_detail.quality.brightness #=> Float
+    #   resp.unindexed_faces[0].face_detail.quality.sharpness #=> Float
+    #   resp.unindexed_faces[0].face_detail.confidence #=> Float
     #
     # @overload index_faces(params = {})
     # @param [Hash] params ({})
@@ -3446,7 +3549,7 @@ module Aws::Rekognition
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rekognition'
-      context[:gem_version] = '1.9.0'
+      context[:gem_version] = '1.10.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -137,6 +137,7 @@ module Aws::Rekognition
     ListStreamProcessorsRequest = Shapes::StructureShape.new(name: 'ListStreamProcessorsRequest')
     ListStreamProcessorsResponse = Shapes::StructureShape.new(name: 'ListStreamProcessorsResponse')
     MaxFaces = Shapes::IntegerShape.new(name: 'MaxFaces')
+    MaxFacesToIndex = Shapes::IntegerShape.new(name: 'MaxFacesToIndex')
     MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
     ModerationLabel = Shapes::StructureShape.new(name: 'ModerationLabel')
     ModerationLabels = Shapes::ListShape.new(name: 'ModerationLabels')
@@ -158,6 +159,9 @@ module Aws::Rekognition
     Polygon = Shapes::ListShape.new(name: 'Polygon')
     Pose = Shapes::StructureShape.new(name: 'Pose')
     ProvisionedThroughputExceededException = Shapes::StructureShape.new(name: 'ProvisionedThroughputExceededException')
+    QualityFilter = Shapes::StringShape.new(name: 'QualityFilter')
+    Reason = Shapes::StringShape.new(name: 'Reason')
+    Reasons = Shapes::ListShape.new(name: 'Reasons')
     RecognizeCelebritiesRequest = Shapes::StructureShape.new(name: 'RecognizeCelebritiesRequest')
     RecognizeCelebritiesResponse = Shapes::StructureShape.new(name: 'RecognizeCelebritiesResponse')
     RekognitionUniqueId = Shapes::StringShape.new(name: 'RekognitionUniqueId')
@@ -209,6 +213,8 @@ module Aws::Rekognition
     Timestamp = Shapes::IntegerShape.new(name: 'Timestamp')
     UInteger = Shapes::IntegerShape.new(name: 'UInteger')
     ULong = Shapes::IntegerShape.new(name: 'ULong')
+    UnindexedFace = Shapes::StructureShape.new(name: 'UnindexedFace')
+    UnindexedFaces = Shapes::ListShape.new(name: 'UnindexedFaces')
     Url = Shapes::StringShape.new(name: 'Url')
     Urls = Shapes::ListShape.new(name: 'Urls')
     Video = Shapes::StructureShape.new(name: 'Video')
@@ -558,11 +564,14 @@ module Aws::Rekognition
     IndexFacesRequest.add_member(:image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "Image"))
     IndexFacesRequest.add_member(:external_image_id, Shapes::ShapeRef.new(shape: ExternalImageId, location_name: "ExternalImageId"))
     IndexFacesRequest.add_member(:detection_attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "DetectionAttributes"))
+    IndexFacesRequest.add_member(:max_faces, Shapes::ShapeRef.new(shape: MaxFacesToIndex, location_name: "MaxFaces"))
+    IndexFacesRequest.add_member(:quality_filter, Shapes::ShapeRef.new(shape: QualityFilter, location_name: "QualityFilter"))
     IndexFacesRequest.struct_class = Types::IndexFacesRequest
 
     IndexFacesResponse.add_member(:face_records, Shapes::ShapeRef.new(shape: FaceRecordList, location_name: "FaceRecords"))
     IndexFacesResponse.add_member(:orientation_correction, Shapes::ShapeRef.new(shape: OrientationCorrection, location_name: "OrientationCorrection"))
     IndexFacesResponse.add_member(:face_model_version, Shapes::ShapeRef.new(shape: String, location_name: "FaceModelVersion"))
+    IndexFacesResponse.add_member(:unindexed_faces, Shapes::ShapeRef.new(shape: UnindexedFaces, location_name: "UnindexedFaces"))
     IndexFacesResponse.struct_class = Types::IndexFacesResponse
 
     KinesisDataStream.add_member(:arn, Shapes::ShapeRef.new(shape: KinesisDataArn, location_name: "Arn"))
@@ -665,6 +674,8 @@ module Aws::Rekognition
     Pose.add_member(:pitch, Shapes::ShapeRef.new(shape: Degree, location_name: "Pitch"))
     Pose.struct_class = Types::Pose
 
+    Reasons.member = Shapes::ShapeRef.new(shape: Reason)
+
     RecognizeCelebritiesRequest.add_member(:image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "Image"))
     RecognizeCelebritiesRequest.struct_class = Types::RecognizeCelebritiesRequest
 
@@ -803,6 +814,12 @@ module Aws::Rekognition
 
     TextDetectionList.member = Shapes::ShapeRef.new(shape: TextDetection)
 
+    UnindexedFace.add_member(:reasons, Shapes::ShapeRef.new(shape: Reasons, location_name: "Reasons"))
+    UnindexedFace.add_member(:face_detail, Shapes::ShapeRef.new(shape: FaceDetail, location_name: "FaceDetail"))
+    UnindexedFace.struct_class = Types::UnindexedFace
+
+    UnindexedFaces.member = Shapes::ShapeRef.new(shape: UnindexedFace)
+
     Urls.member = Shapes::ShapeRef.new(shape: Url)
 
     Video.add_member(:s3_object, Shapes::ShapeRef.new(shape: S3Object, location_name: "S3Object"))

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

@@ -1823,6 +1823,8 @@ module Aws::Rekognition
     #         },
     #         external_image_id: "ExternalImageId",
     #         detection_attributes: ["DEFAULT"], # accepts DEFAULT, ALL
+    #         max_faces: 1,
+    #         quality_filter: "NONE", # accepts NONE, AUTO
     #       }
     #
     # @!attribute [rw] collection_id
@@ -1854,11 +1856,42 @@ module Aws::Rekognition
     #   this case, all attributes).
     #   @return [Array<String>]
     #
+    # @!attribute [rw] max_faces
+    #   The maximum number of faces to index. The value of `MaxFaces` must
+    #   be greater than or equal to 1. `IndexFaces` returns no more that 100
+    #   detected faces in an image, even if you specify a larger value for
+    #   `MaxFaces`.
+    #
+    #   If `IndexFaces` detects more faces than the value of `MaxFaces`, the
+    #   faces with the lowest quality are filtered out first. If there are
+    #   still more faces than the value of `MaxFaces`, the faces with the
+    #   smallest bounding boxes are filtered out (up to the number needed to
+    #   satisfy the value of `MaxFaces`). Information about the unindexed
+    #   faces is available in the `UnindexedFaces` array.
+    #
+    #   The faces returned by `IndexFaces` are sorted, in descending order,
+    #   by the largest face bounding box size, to the smallest.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] quality_filter
+    #   Specifies how much filtering is done to identify faces detected with
+    #   low quality. Filtered faces are not 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 arise for a number of reasons. For example, an object
+    #   misidentified as a face, a face that is too blurry, or a face with a
+    #   pose that is too extreme to use. If you specify `NONE`, no filtering
+    #   is performed. The default value is NONE.
+    #   @return [String]
+    #
     class IndexFacesRequest < Struct.new(
       :collection_id,
       :image,
       :external_image_id,
-      :detection_attributes)
+      :detection_attributes,
+      :max_faces,
+      :quality_filter)
       include Aws::Structure
     end
 
@@ -1890,10 +1923,18 @@ module Aws::Rekognition
     #   collection (`CollectionId`).
     #   @return [String]
     #
+    # @!attribute [rw] unindexed_faces
+    #   An array of faces that detected in the image but not indexed either
+    #   because the quality filter deemed them to be of low-quality or the
+    #   `MaxFaces` request parameter filtered them out. To use the quality
+    #   filter, you specify the `QualityFilter` request parameter.
+    #   @return [Array<Types::UnindexedFace>]
+    #
     class IndexFacesResponse < Struct.new(
       :face_records,
       :orientation_correction,
-      :face_model_version)
+      :face_model_version,
+      :unindexed_faces)
       include Aws::Structure
     end
 
@@ -3202,6 +3243,40 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # A face detected by but not indexed. Use the `Reasons` response
+    # attribute to determine why a face is not indexed.
+    #
+    # @!attribute [rw] reasons
+    #   An array of reasons specifying why a face was not indexed.
+    #
+    #   * EXTREME\_POSE - The face is at a pose that can't be detected. For
+    #     example, the head is turned too far away from the camera.
+    #
+    #   * EXCEEDS\_MAX\_FACES - The number of faces detected is already
+    #     higher than that specified by the `MaxFaces` input parameter for
+    #     `IndexFaces`.
+    #
+    #   * LOW\_BRIGHTNESS - The image is too dark.
+    #
+    #   * LOW\_SHARPNESS - The image is too blurry.
+    #
+    #   * LOW\_CONFIDENCE - The face was detected with a low confidence.
+    #
+    #   * SMALL\_BOUNDING\_BOX - The bounding box around the face is too
+    #     small.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] face_detail
+    #   Structure containing attributes of a face that was detected, but not
+    #   indexed, by `IndexFaces`.
+    #   @return [Types::FaceDetail]
+    #
+    class UnindexedFace < Struct.new(
+      :reasons,
+      :face_detail)
+      include Aws::Structure
+    end
+
     # Video file stored in an Amazon S3 bucket. Amazon Rekognition video
     # start operations such as use `Video` to specify a video for analysis.
     # The supported file formats are .mp4, .mov and .avi.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rekognition
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core