| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Rekognition::FaceDetail; | ||
| 3 | use Moose; | ||
| 4 | has AgeRange => (is => 'ro', isa => 'Paws::Rekognition::AgeRange'); | ||
| 5 | has Beard => (is => 'ro', isa => 'Paws::Rekognition::Beard'); | ||
| 6 | has BoundingBox => (is => 'ro', isa => 'Paws::Rekognition::BoundingBox'); | ||
| 7 | has Confidence => (is => 'ro', isa => 'Num'); | ||
| 8 | has Emotions => (is => 'ro', isa => 'ArrayRef[Paws::Rekognition::Emotion]'); | ||
| 9 | has Eyeglasses => (is => 'ro', isa => 'Paws::Rekognition::Eyeglasses'); | ||
| 10 | has EyesOpen => (is => 'ro', isa => 'Paws::Rekognition::EyeOpen'); | ||
| 11 | has Gender => (is => 'ro', isa => 'Paws::Rekognition::Gender'); | ||
| 12 | has Landmarks => (is => 'ro', isa => 'ArrayRef[Paws::Rekognition::Landmark]'); | ||
| 13 | has MouthOpen => (is => 'ro', isa => 'Paws::Rekognition::MouthOpen'); | ||
| 14 | has Mustache => (is => 'ro', isa => 'Paws::Rekognition::Mustache'); | ||
| 15 | has Pose => (is => 'ro', isa => 'Paws::Rekognition::Pose'); | ||
| 16 | has Quality => (is => 'ro', isa => 'Paws::Rekognition::ImageQuality'); | ||
| 17 | has Smile => (is => 'ro', isa => 'Paws::Rekognition::Smile'); | ||
| 18 | has Sunglasses => (is => 'ro', isa => 'Paws::Rekognition::Sunglasses'); | ||
| 19 | |||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::Rekognition::FaceDetail | ||
| 27 | |||
| 28 | =head1 USAGE | ||
| 29 | |||
| 30 | This class represents one of two things: | ||
| 31 | |||
| 32 | =head3 Arguments in a call to a service | ||
| 33 | |||
| 34 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 35 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 36 | |||
| 37 | As an example, if Att1 is expected to be a Paws::Rekognition::FaceDetail object: | ||
| 38 | |||
| 39 | $service_obj->Method(Att1 => { AgeRange => $value, ..., Sunglasses => $value }); | ||
| 40 | |||
| 41 | =head3 Results returned from an API call | ||
| 42 | |||
| 43 | Use accessors for each attribute. If Att1 is expected to be an Paws::Rekognition::FaceDetail object: | ||
| 44 | |||
| 45 | $result = $service_obj->Method(...); | ||
| 46 | $result->Att1->AgeRange | ||
| 47 | |||
| 48 | =head1 DESCRIPTION | ||
| 49 | |||
| 50 | Structure containing attributes of the face that the algorithm | ||
| 51 | detected. | ||
| 52 | |||
| 53 | A C<FaceDetail> object contains either the default facial attributes or | ||
| 54 | all facial attributes. The default attributes are C<BoundingBox>, | ||
| 55 | C<Confidence>, C<Landmarks>, C<Pose>, and C<Quality>. | ||
| 56 | |||
| 57 | GetFaceDetection is the only Amazon Rekognition Video stored video | ||
| 58 | operation that can return a C<FaceDetail> object with all attributes. | ||
| 59 | To specify which attributes to return, use the C<FaceAttributes> input | ||
| 60 | parameter for StartFaceDetection. The following Amazon Rekognition | ||
| 61 | Video operations return only the default attributes. The corresponding | ||
| 62 | Start operations don't have a C<FaceAttributes> input parameter. | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | GetCelebrityRecognition | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | GetPersonTracking | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | GetFaceSearch | ||
| 77 | |||
| 78 | =back | ||
| 79 | |||
| 80 | The Amazon Rekognition Image DetectFaces and IndexFaces operations can | ||
| 81 | return all facial attributes. To specify which attributes to return, | ||
| 82 | use the C<Attributes> input parameter for C<DetectFaces>. For | ||
| 83 | C<IndexFaces>, use the C<DetectAttributes> input parameter. | ||
| 84 | |||
| 85 | =head1 ATTRIBUTES | ||
| 86 | |||
| 87 | |||
| 88 | =head2 AgeRange => L<Paws::Rekognition::AgeRange> | ||
| 89 | |||
| 90 | The estimated age range, in years, for the face. Low represents the | ||
| 91 | lowest estimated age and High represents the highest estimated age. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 Beard => L<Paws::Rekognition::Beard> | ||
| 95 | |||
| 96 | Indicates whether or not the face has a beard, and the confidence level | ||
| 97 | in the determination. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 BoundingBox => L<Paws::Rekognition::BoundingBox> | ||
| 101 | |||
| 102 | Bounding box of the face. Default attribute. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 Confidence => Num | ||
| 106 | |||
| 107 | Confidence level that the bounding box contains a face (and not a | ||
| 108 | different object such as a tree). Default attribute. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 Emotions => ArrayRef[L<Paws::Rekognition::Emotion>] | ||
| 112 | |||
| 113 | The emotions that appear to be expressed on the face, and the | ||
| 114 | confidence level in the determination. The API is only making a | ||
| 115 | determination of the physical appearance of a person's face. It is not | ||
| 116 | a determination of the personE<rsquo>s internal emotional state and | ||
| 117 | should not be used in such a way. For example, a person pretending to | ||
| 118 | have a sad face might not be sad emotionally. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 Eyeglasses => L<Paws::Rekognition::Eyeglasses> | ||
| 122 | |||
| 123 | Indicates whether or not the face is wearing eye glasses, and the | ||
| 124 | confidence level in the determination. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 EyesOpen => L<Paws::Rekognition::EyeOpen> | ||
| 128 | |||
| 129 | Indicates whether or not the eyes on the face are open, and the | ||
| 130 | confidence level in the determination. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 Gender => L<Paws::Rekognition::Gender> | ||
| 134 | |||
| 135 | The predicted gender of a detected face. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 Landmarks => ArrayRef[L<Paws::Rekognition::Landmark>] | ||
| 139 | |||
| 140 | Indicates the location of landmarks on the face. Default attribute. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 MouthOpen => L<Paws::Rekognition::MouthOpen> | ||
| 144 | |||
| 145 | Indicates whether or not the mouth on the face is open, and the | ||
| 146 | confidence level in the determination. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 Mustache => L<Paws::Rekognition::Mustache> | ||
| 150 | |||
| 151 | Indicates whether or not the face has a mustache, and the confidence | ||
| 152 | level in the determination. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 Pose => L<Paws::Rekognition::Pose> | ||
| 156 | |||
| 157 | Indicates the pose of the face as determined by its pitch, roll, and | ||
| 158 | yaw. Default attribute. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 Quality => L<Paws::Rekognition::ImageQuality> | ||
| 162 | |||
| 163 | Identifies image brightness and sharpness. Default attribute. | ||
| 164 | |||
| 165 | |||
| 166 | =head2 Smile => L<Paws::Rekognition::Smile> | ||
| 167 | |||
| 168 | Indicates whether or not the face is smiling, and the confidence level | ||
| 169 | in the determination. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 Sunglasses => L<Paws::Rekognition::Sunglasses> | ||
| 173 | |||
| 174 | Indicates whether or not the face is wearing sunglasses, and the | ||
| 175 | confidence level in the determination. | ||
| 176 | |||
| 177 | |||
| 178 | |||
| 179 | =head1 SEE ALSO | ||
| 180 | |||
| 181 | This class forms part of L<Paws>, describing an object used in L<Paws::Rekognition> | ||
| 182 | |||
| 183 | =head1 BUGS and CONTRIBUTIONS | ||
| 184 | |||
| 185 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 186 | |||
| 187 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 188 | |||
| 189 | =cut | ||
| 190 |