Class: Aws::Rekognition::Types::FaceDetail

Inherits:

Struct

Object
Struct
Aws::Rekognition::Types::FaceDetail

show all

Includes:: Structure

Defined in:: lib/aws-sdk-rekognition/types.rb

Overview

Structure containing attributes of the face that the algorithm detected.

A ‘FaceDetail` object contains either the default facial attributes or all facial attributes. The default attributes are `BoundingBox`, `Confidence`, `Landmarks`, `Pose`, and `Quality`.

GetFaceDetection is the only Amazon Rekognition Video stored video operation that can return a ‘FaceDetail` object with all attributes. To specify which attributes to return, use the `FaceAttributes` input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don’t have a ‘FaceAttributes` input parameter:

GetCelebrityRecognition
GetPersonTracking
GetFaceSearch

The Amazon Rekognition Image DetectFaces and IndexFaces operations can return all facial attributes. To specify which attributes to return, use the ‘Attributes` input parameter for `DetectFaces`. For `IndexFaces`, use the `DetectAttributes` input parameter.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#age_range ⇒ Types::AgeRange

The estimated age range, in years, for the face.
#beard ⇒ Types::Beard

Indicates whether or not the face has a beard, and the confidence level in the determination.
#bounding_box ⇒ Types::BoundingBox

Bounding box of the face.
#confidence ⇒ Float

Confidence level that the bounding box contains a face (and not a different object such as a tree).
#emotions ⇒ Array<Types::Emotion>

The emotions that appear to be expressed on the face, and the confidence level in the determination.
#eye_direction ⇒ Types::EyeDirection

Indicates the direction the eyes are gazing in, as defined by pitch and yaw.
#eyeglasses ⇒ Types::Eyeglasses

Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
#eyes_open ⇒ Types::EyeOpen

Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
#face_occluded ⇒ Types::FaceOccluded

‘FaceOccluded` should return “true” with a high confidence score if a detected face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other objects.
#gender ⇒ Types::Gender

The predicted gender of a detected face.
#landmarks ⇒ Array<Types::Landmark>

Indicates the location of landmarks on the face.
#mouth_open ⇒ Types::MouthOpen

Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
#mustache ⇒ Types::Mustache

Indicates whether or not the face has a mustache, and the confidence level in the determination.
#pose ⇒ Types::Pose

Indicates the pose of the face as determined by its pitch, roll, and yaw.
#quality ⇒ Types::ImageQuality

Identifies image brightness and sharpness.
#smile ⇒ Types::Smile

Indicates whether or not the face is smiling, and the confidence level in the determination.
#sunglasses ⇒ Types::Sunglasses

Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

Instance Attribute Details

#age_range ⇒ `Types::AgeRange`

The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

Returns:

(Types::AgeRange)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#beard ⇒ `Types::Beard`

Indicates whether or not the face has a beard, and the confidence level in the determination.

Returns:

(Types::Beard)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#bounding_box ⇒ `Types::BoundingBox`

Bounding box of the face. Default attribute.

Returns:

(Types::BoundingBox)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#confidence ⇒ `Float`

Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

Returns:

(Float)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#emotions ⇒ `Array<Types::Emotion>`

The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person’s face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

Returns:

(Array<Types::Emotion>)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#eye_direction ⇒ `Types::EyeDirection`

Indicates the direction the eyes are gazing in, as defined by pitch and yaw.

Returns:

(Types::EyeDirection)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#eyeglasses ⇒ `Types::Eyeglasses`

Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

Returns:

(Types::Eyeglasses)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#eyes_open ⇒ `Types::EyeOpen`

Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

Returns:

(Types::EyeOpen)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#face_occluded ⇒ `Types::FaceOccluded`

‘FaceOccluded` should return “true” with a high confidence score if a detected face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other objects. `FaceOccluded` should return “false” with a high confidence score if common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair, and others.

Returns:

(Types::FaceOccluded)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#gender ⇒ `Types::Gender`

The predicted gender of a detected face.

Returns:

(Types::Gender)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#landmarks ⇒ `Array<Types::Landmark>`

Indicates the location of landmarks on the face. Default attribute.

Returns:

(Array<Types::Landmark>)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#mouth_open ⇒ `Types::MouthOpen`

Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

Returns:

(Types::MouthOpen)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#mustache ⇒ `Types::Mustache`

Indicates whether or not the face has a mustache, and the confidence level in the determination.

Returns:

(Types::Mustache)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#pose ⇒ `Types::Pose`

Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

Returns:

(Types::Pose)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#quality ⇒ `Types::ImageQuality`

Identifies image brightness and sharpness. Default attribute.

Returns:

(Types::ImageQuality)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#smile ⇒ `Types::Smile`

Indicates whether or not the face is smiling, and the confidence level in the determination.

Returns:

(Types::Smile)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

#sunglasses ⇒ `Types::Sunglasses`

Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

Returns:

(Types::Sunglasses)

# File 'lib/aws-sdk-rekognition/types.rb', line 3014

class FaceDetail < Struct.new(
  :bounding_box,
  :age_range,
  :smile,
  :eyeglasses,
  :sunglasses,
  :gender,
  :beard,
  :mustache,
  :eyes_open,
  :mouth_open,
  :emotions,
  :landmarks,
  :pose,
  :quality,
  :confidence,
  :face_occluded,
  :eye_direction)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Rekognition::Types::FaceDetail

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#age_range ⇒ Types::AgeRange

#beard ⇒ Types::Beard

#bounding_box ⇒ Types::BoundingBox

#confidence ⇒ Float

#emotions ⇒ Array<Types::Emotion>

#eye_direction ⇒ Types::EyeDirection

#eyeglasses ⇒ Types::Eyeglasses

#eyes_open ⇒ Types::EyeOpen

#face_occluded ⇒ Types::FaceOccluded

#gender ⇒ Types::Gender

#landmarks ⇒ Array<Types::Landmark>

#mouth_open ⇒ Types::MouthOpen

#mustache ⇒ Types::Mustache

#pose ⇒ Types::Pose

#quality ⇒ Types::ImageQuality

#smile ⇒ Types::Smile

#sunglasses ⇒ Types::Sunglasses

#age_range ⇒ `Types::AgeRange`

#beard ⇒ `Types::Beard`

#bounding_box ⇒ `Types::BoundingBox`

#confidence ⇒ `Float`

#emotions ⇒ `Array<Types::Emotion>`

#eye_direction ⇒ `Types::EyeDirection`

#eyeglasses ⇒ `Types::Eyeglasses`

#eyes_open ⇒ `Types::EyeOpen`

#face_occluded ⇒ `Types::FaceOccluded`

#gender ⇒ `Types::Gender`

#landmarks ⇒ `Array<Types::Landmark>`

#mouth_open ⇒ `Types::MouthOpen`

#mustache ⇒ `Types::Mustache`

#pose ⇒ `Types::Pose`

#quality ⇒ `Types::ImageQuality`

#smile ⇒ `Types::Smile`

#sunglasses ⇒ `Types::Sunglasses`