aws-sdk-rekognition 1.54.0 → 1.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3be2c5689e792a068c696e416622e79a1ef01e2564a6b77a58bd7f9764cdcce9
-  data.tar.gz: 8275849761b724ea256aeb308d281c254f1a46ae0694b0d9a50a81e6e3552073
+  metadata.gz: 7eeed39966b02dbca262b06448e70e72199cf1be48216013201792fb3f4bc779
+  data.tar.gz: 328270c34037105ee62bb85c125603be2d9f3d7bdf3c47d0195e2118171ebb07
 SHA512:
-  metadata.gz: b53c25a316b0643b6e26034e1f2aa209669fc550799b306e9fe2debc5d824314ac1bb0ec8f5c6663dd14c15203fa8e246504472f8969df8ab8a1fdf42e385e60
-  data.tar.gz: 28041784233e4cea2a86458435fcfb3a5f6c5f313ea202e80458c6580c13705d10b926281ac503987104902f32790be0e6fe12ddd8f25472f3304a5ac19df94b
+  metadata.gz: cdf637272f8f63dd7cd98e866de36e35a5be0c11ba3d3e04cc7ebb41922a52fb7c0d6e78b4d160e8cdb90ada2d1c1bb2cdb1682bdfd086d010b746d8c4a3baf5
+  data.tar.gz: 93af3da3840cfc76847214f6f7ae61789cca32152f9978256030332ea169b052a40354e72c7d38f6fb5ed913731277ee741d3d6b6081660c483232a1369b607d

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.55.0 (2021-08-26)
+------------------
+
+* Feature - This release added new attributes to Rekognition RecognizeCelebities and GetCelebrityInfo API operations.
+
 1.54.0 (2021-08-09)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.54.0
+1.55.0

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

@@ -547,6 +547,11 @@ module Aws::Rekognition
     #   resp.face_matches[0].face.pose.pitch #=> Float
     #   resp.face_matches[0].face.quality.brightness #=> Float
     #   resp.face_matches[0].face.quality.sharpness #=> Float
+    #   resp.face_matches[0].face.emotions #=> Array
+    #   resp.face_matches[0].face.emotions[0].type #=> String, one of "HAPPY", "SAD", "ANGRY", "CONFUSED", "DISGUSTED", "SURPRISED", "CALM", "UNKNOWN", "FEAR"
+    #   resp.face_matches[0].face.emotions[0].confidence #=> Float
+    #   resp.face_matches[0].face.smile.value #=> Boolean
+    #   resp.face_matches[0].face.smile.confidence #=> Float
     #   resp.unmatched_faces #=> Array
     #   resp.unmatched_faces[0].bounding_box.width #=> Float
     #   resp.unmatched_faces[0].bounding_box.height #=> Float
@@ -562,6 +567,11 @@ module Aws::Rekognition
     #   resp.unmatched_faces[0].pose.pitch #=> Float
     #   resp.unmatched_faces[0].quality.brightness #=> Float
     #   resp.unmatched_faces[0].quality.sharpness #=> Float
+    #   resp.unmatched_faces[0].emotions #=> Array
+    #   resp.unmatched_faces[0].emotions[0].type #=> String, one of "HAPPY", "SAD", "ANGRY", "CONFUSED", "DISGUSTED", "SURPRISED", "CALM", "UNKNOWN", "FEAR"
+    #   resp.unmatched_faces[0].emotions[0].confidence #=> Float
+    #   resp.unmatched_faces[0].smile.value #=> Boolean
+    #   resp.unmatched_faces[0].smile.confidence #=> Float
     #   resp.source_image_orientation_correction #=> String, one of "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270"
     #   resp.target_image_orientation_correction #=> String, one of "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270"
     #
@@ -1335,18 +1345,23 @@ module Aws::Rekognition
     # object location information, if it exists, for the label on the image
     # (`Geometry`).
     #
-    # During training model calculates a threshold value that determines if
-    # a prediction for a label is true. By default, `DetectCustomLabels`
-    # doesn't return labels whose confidence value is below the model's
-    # calculated threshold value. To filter labels that are returned,
-    # specify a value for `MinConfidence` that is higher than the model's
-    # calculated threshold. You can get the model's calculated threshold
-    # from the model's training results shown in the Amazon Rekognition
-    # Custom Labels console. To get all labels, regardless of confidence,
-    # specify a `MinConfidence` value of 0.
-    #
-    # You can also add the `MaxResults` parameter to limit the number of
-    # labels returned.
+    # To filter labels that are returned, specify a value for
+    # `MinConfidence`. `DetectCustomLabelsLabels` only returns labels with a
+    # confidence that's higher than the specified value. The value of
+    # `MinConfidence` maps to the assumed threshold values created during
+    # training. For more information, see *Assumed threshold* in the Amazon
+    # Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom
+    # Labels metrics expresses an assumed threshold as a floating point
+    # value between 0-1. The range of `MinConfidence` normalizes the
+    # threshold value to a percentage value (0-100). Confidence responses
+    # from `DetectCustomLabels` are also returned as a percentage. You can
+    # use `MinConfidence` to change the precision and recall or your model.
+    # For more information, see *Analyzing an image* in the Amazon
+    # Rekognition Custom Labels Developer Guide.
+    #
+    # If you don't specify a value for `MinConfidence`,
+    # `DetectCustomLabels` returns labels based on the assumed threshold of
+    # each label.
     #
     # This is a stateless API operation. That is, the operation does not
     # persist any data.
@@ -1354,6 +1369,9 @@ module Aws::Rekognition
     # This operation requires permissions to perform the
     # `rekognition:DetectCustomLabels` action.
     #
+    # For more information, see *Analyzing an image* in the Amazon
+    # Rekognition Custom Labels Developer Guide.
+    #
     # @option params [required, String] :project_version_arn
     #   The ARN of the model version that you want to use.
     #
@@ -1393,10 +1411,12 @@ module Aws::Rekognition
     #
     # @option params [Float] :min_confidence
     #   Specifies the minimum confidence level for the labels to return.
-    #   Amazon Rekognition doesn't return any labels with a confidence lower
-    #   than this specified value. If you specify a value of 0, all labels are
-    #   return, regardless of the default thresholds that the model version
-    #   applies.
+    #   `DetectCustomLabels` doesn't return any labels with a confidence
+    #   value that's lower than this specified value. If you specify a value
+    #   of 0, `DetectCustomLabels` returns all labels, regardless of the
+    #   assumed threshold applied to each label. If you don't specify a value
+    #   for `MinConfidence`, `DetectCustomLabels` returns labels based on the
+    #   assumed threshold of each label.
     #
     # @return [Types::DetectCustomLabelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -2099,9 +2119,9 @@ module Aws::Rekognition
     end
 
     # Gets the name and additional information about a celebrity based on
-    # his or her Amazon Rekognition ID. The additional information is
-    # returned as an array of URLs. If there is no additional information
-    # about the celebrity, this list is empty.
+    # their Amazon Rekognition ID. The additional information is returned as
+    # an array of URLs. If there is no additional information about the
+    # celebrity, this list is empty.
     #
     # For more information, see Recognizing Celebrities in an Image in the
     # Amazon Rekognition Developer Guide.
@@ -2118,6 +2138,7 @@ module Aws::Rekognition
     #
     #   * {Types::GetCelebrityInfoResponse#urls #urls} => Array<String>
     #   * {Types::GetCelebrityInfoResponse#name #name} => String
+    #   * {Types::GetCelebrityInfoResponse#known_gender #known_gender} => Types::KnownGender
     #
     # @example Request syntax with placeholder values
     #
@@ -2130,6 +2151,7 @@ module Aws::Rekognition
     #   resp.urls #=> Array
     #   resp.urls[0] #=> String
     #   resp.name #=> String
+    #   resp.known_gender.type #=> String, one of "Male", "Female"
     #
     # @overload get_celebrity_info(params = {})
     # @param [Hash] params ({})
@@ -3982,7 +4004,13 @@ module Aws::Rekognition
     #   resp.celebrity_faces[0].face.pose.pitch #=> Float
     #   resp.celebrity_faces[0].face.quality.brightness #=> Float
     #   resp.celebrity_faces[0].face.quality.sharpness #=> Float
+    #   resp.celebrity_faces[0].face.emotions #=> Array
+    #   resp.celebrity_faces[0].face.emotions[0].type #=> String, one of "HAPPY", "SAD", "ANGRY", "CONFUSED", "DISGUSTED", "SURPRISED", "CALM", "UNKNOWN", "FEAR"
+    #   resp.celebrity_faces[0].face.emotions[0].confidence #=> Float
+    #   resp.celebrity_faces[0].face.smile.value #=> Boolean
+    #   resp.celebrity_faces[0].face.smile.confidence #=> Float
     #   resp.celebrity_faces[0].match_confidence #=> Float
+    #   resp.celebrity_faces[0].known_gender.type #=> String, one of "Male", "Female"
     #   resp.unrecognized_faces #=> Array
     #   resp.unrecognized_faces[0].bounding_box.width #=> Float
     #   resp.unrecognized_faces[0].bounding_box.height #=> Float
@@ -3998,6 +4026,11 @@ module Aws::Rekognition
     #   resp.unrecognized_faces[0].pose.pitch #=> Float
     #   resp.unrecognized_faces[0].quality.brightness #=> Float
     #   resp.unrecognized_faces[0].quality.sharpness #=> Float
+    #   resp.unrecognized_faces[0].emotions #=> Array
+    #   resp.unrecognized_faces[0].emotions[0].type #=> String, one of "HAPPY", "SAD", "ANGRY", "CONFUSED", "DISGUSTED", "SURPRISED", "CALM", "UNKNOWN", "FEAR"
+    #   resp.unrecognized_faces[0].emotions[0].confidence #=> Float
+    #   resp.unrecognized_faces[0].smile.value #=> Boolean
+    #   resp.unrecognized_faces[0].smile.confidence #=> Float
     #   resp.orientation_correction #=> String, one of "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270"
     #
     # @overload recognize_celebrities(params = {})
@@ -5216,7 +5249,7 @@ module Aws::Rekognition
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rekognition'
-      context[:gem_version] = '1.54.0'
+      context[:gem_version] = '1.55.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -178,6 +178,8 @@ module Aws::Rekognition
     KinesisVideoArn = Shapes::StringShape.new(name: 'KinesisVideoArn')
     KinesisVideoStream = Shapes::StructureShape.new(name: 'KinesisVideoStream')
     KmsKeyId = Shapes::StringShape.new(name: 'KmsKeyId')
+    KnownGender = Shapes::StructureShape.new(name: 'KnownGender')
+    KnownGenderType = Shapes::StringShape.new(name: 'KnownGenderType')
     Label = Shapes::StructureShape.new(name: 'Label')
     LabelDetection = Shapes::StructureShape.new(name: 'LabelDetection')
     LabelDetectionSortBy = Shapes::StringShape.new(name: 'LabelDetectionSortBy')
@@ -396,6 +398,7 @@ module Aws::Rekognition
     Celebrity.add_member(:id, Shapes::ShapeRef.new(shape: RekognitionUniqueId, location_name: "Id"))
     Celebrity.add_member(:face, Shapes::ShapeRef.new(shape: ComparedFace, location_name: "Face"))
     Celebrity.add_member(:match_confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "MatchConfidence"))
+    Celebrity.add_member(:known_gender, Shapes::ShapeRef.new(shape: KnownGender, location_name: "KnownGender"))
     Celebrity.struct_class = Types::Celebrity
 
     CelebrityDetail.add_member(:urls, Shapes::ShapeRef.new(shape: Urls, location_name: "Urls"))
@@ -442,6 +445,8 @@ module Aws::Rekognition
     ComparedFace.add_member(:landmarks, Shapes::ShapeRef.new(shape: Landmarks, location_name: "Landmarks"))
     ComparedFace.add_member(:pose, Shapes::ShapeRef.new(shape: Pose, location_name: "Pose"))
     ComparedFace.add_member(:quality, Shapes::ShapeRef.new(shape: ImageQuality, location_name: "Quality"))
+    ComparedFace.add_member(:emotions, Shapes::ShapeRef.new(shape: Emotions, location_name: "Emotions"))
+    ComparedFace.add_member(:smile, Shapes::ShapeRef.new(shape: Smile, location_name: "Smile"))
     ComparedFace.struct_class = Types::ComparedFace
 
     ComparedFaceList.member = Shapes::ShapeRef.new(shape: ComparedFace)
@@ -735,6 +740,7 @@ module Aws::Rekognition
 
     GetCelebrityInfoResponse.add_member(:urls, Shapes::ShapeRef.new(shape: Urls, location_name: "Urls"))
     GetCelebrityInfoResponse.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
+    GetCelebrityInfoResponse.add_member(:known_gender, Shapes::ShapeRef.new(shape: KnownGender, location_name: "KnownGender"))
     GetCelebrityInfoResponse.struct_class = Types::GetCelebrityInfoResponse
 
     GetCelebrityRecognitionRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
@@ -914,6 +920,9 @@ module Aws::Rekognition
     KinesisVideoStream.add_member(:arn, Shapes::ShapeRef.new(shape: KinesisVideoArn, location_name: "Arn"))
     KinesisVideoStream.struct_class = Types::KinesisVideoStream
 
+    KnownGender.add_member(:type, Shapes::ShapeRef.new(shape: KnownGenderType, location_name: "Type"))
+    KnownGender.struct_class = Types::KnownGender
+
     Label.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
     Label.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
     Label.add_member(:instances, Shapes::ShapeRef.new(shape: Instances, location_name: "Instances"))

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

@@ -250,12 +250,18 @@ module Aws::Rekognition
     #   recognized face is the celebrity.
     #   @return [Float]
     #
+    # @!attribute [rw] known_gender
+    #   The known gender identity for the celebrity that matches the
+    #   provided ID.
+    #   @return [Types::KnownGender]
+    #
     class Celebrity < Struct.new(
       :urls,
       :name,
       :id,
       :face,
-      :match_confidence)
+      :match_confidence,
+      :known_gender)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -501,12 +507,26 @@ module Aws::Rekognition
     #   Identifies face image brightness and sharpness.
     #   @return [Types::ImageQuality]
     #
+    # @!attribute [rw] emotions
+    #   The emotions that appear to be expressed on the face, and the
+    #   confidence level in the determination. Valid values include
+    #   "Happy", "Sad", "Angry", "Confused", "Disgusted",
+    #   "Surprised", "Calm", "Unknown", and "Fear".
+    #   @return [Array<Types::Emotion>]
+    #
+    # @!attribute [rw] smile
+    #   Indicates whether or not the face is smiling, and the confidence
+    #   level in the determination.
+    #   @return [Types::Smile]
+    #
     class ComparedFace < Struct.new(
       :bounding_box,
       :confidence,
       :landmarks,
       :pose,
-      :quality)
+      :quality,
+      :emotions,
+      :smile)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1310,10 +1330,12 @@ module Aws::Rekognition
     #
     # @!attribute [rw] min_confidence
     #   Specifies the minimum confidence level for the labels to return.
-    #   Amazon Rekognition doesn't return any labels with a confidence
-    #   lower than this specified value. If you specify a value of 0, all
-    #   labels are return, regardless of the default thresholds that the
-    #   model version applies.
+    #   `DetectCustomLabels` doesn't return any labels with a confidence
+    #   value that's lower than this specified value. If you specify a
+    #   value of 0, `DetectCustomLabels` returns all labels, regardless of
+    #   the assumed threshold applied to each label. If you don't specify a
+    #   value for `MinConfidence`, `DetectCustomLabels` returns labels based
+    #   on the assumed threshold of each label.
     #   @return [Float]
     #
     class DetectCustomLabelsRequest < Struct.new(
@@ -2217,9 +2239,14 @@ module Aws::Rekognition
     #   The name of the celebrity.
     #   @return [String]
     #
+    # @!attribute [rw] known_gender
+    #   Retrieves the known gender for the celebrity.
+    #   @return [Types::KnownGender]
+    #
     class GetCelebrityInfoResponse < Struct.new(
       :urls,
-      :name)
+      :name,
+      :known_gender)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3368,6 +3395,19 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # The known gender identity for the celebrity that matches the provided
+    # ID.
+    #
+    # @!attribute [rw] type
+    #   A string value of the KnownGender info about the Celebrity.
+    #   @return [String]
+    #
+    class KnownGender < Struct.new(
+      :type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Structure containing details about the detected label, including the
     # name, detected instances, parent labels, and level of confidence.
     #
@@ -4189,7 +4229,10 @@ module Aws::Rekognition
 
     # @!attribute [rw] celebrity_faces
     #   Details about each celebrity found in the image. Amazon Rekognition
-    #   can detect a maximum of 64 celebrities in an image.
+    #   can detect a maximum of 64 celebrities in an image. Each celebrity
+    #   object includes the following attributes: `Face`, `Confidence`,
+    #   `Emotions`, `Landmarks`, `Pose`, `Quality`, `Smile`, `Id`,
+    #   `KnownGender`, `MatchConfidence`, `Name`, `Urls`.
     #   @return [Array<Types::Celebrity>]
     #
     # @!attribute [rw] unrecognized_faces
@@ -4197,6 +4240,13 @@ module Aws::Rekognition
     #   @return [Array<Types::ComparedFace>]
     #
     # @!attribute [rw] orientation_correction
+    #   <note markdown="1"> Support for estimating image orientation using the the
+    #   OrientationCorrection field has ceased as of August 2021. Any
+    #   returned values for this field included in an API response will
+    #   always be NULL.
+    #
+    #    </note>
+    #
     #   The orientation of the input image (counterclockwise direction). If
     #   your application displays the image, you can use this value to
     #   correct the orientation. The bounding box coordinates returned in

data/lib/aws-sdk-rekognition.rb

@@ -49,6 +49,6 @@ require_relative 'aws-sdk-rekognition/customizations'
 # @!group service
 module Aws::Rekognition
 
-  GEM_VERSION = '1.54.0'
+  GEM_VERSION = '1.55.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rekognition
 version: !ruby/object:Gem::Version
-  version: 1.54.0
+  version: 1.55.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-09 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core