« blib/lib/Paws/Rekognition/SearchFaces.pm
↑ Summary
blib/lib/Paws/Rekognition/SearchFacesByImageResponse.pm »
| 1 | |||
| 2 | package Paws::Rekognition::SearchFacesByImage; | ||
| 3 | use Moose; | ||
| 4 | has CollectionId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has FaceMatchThreshold => (is => 'ro', isa => 'Num'); | ||
| 6 | has Image => (is => 'ro', isa => 'Paws::Rekognition::Image', required => 1); | ||
| 7 | has MaxFaces => (is => 'ro', isa => 'Int'); | ||
| 8 | has QualityFilter => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchFacesByImage'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::SearchFacesByImageResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Rekognition::SearchFacesByImage - Arguments for method SearchFacesByImage on L<Paws::Rekognition> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method SearchFacesByImage on the | ||
| 26 | L<Amazon Rekognition|Paws::Rekognition> service. Use the attributes of this class | ||
| 27 | as arguments to method SearchFacesByImage. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchFacesByImage. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $rekognition = Paws->service('Rekognition'); | ||
| 34 | # To search for faces matching a supplied image | ||
| 35 | # This operation searches for faces in a Rekognition collection that match the | ||
| 36 | # largest face in an S3 bucket stored image. | ||
| 37 | my $SearchFacesByImageResponse = $rekognition->SearchFacesByImage( | ||
| 38 | 'CollectionId' => 'myphotos', | ||
| 39 | 'FaceMatchThreshold' => 95, | ||
| 40 | 'Image' => { | ||
| 41 | 'S3Object' => { | ||
| 42 | 'Bucket' => 'mybucket', | ||
| 43 | 'Name' => 'myphoto' | ||
| 44 | } | ||
| 45 | }, | ||
| 46 | 'MaxFaces' => 5 | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $FaceMatches = $SearchFacesByImageResponse->FaceMatches; | ||
| 51 | my $SearchedFaceBoundingBox = | ||
| 52 | $SearchFacesByImageResponse->SearchedFaceBoundingBox; | ||
| 53 | my $SearchedFaceConfidence = | ||
| 54 | $SearchFacesByImageResponse->SearchedFaceConfidence; | ||
| 55 | |||
| 56 | # Returns a L<Paws::Rekognition::SearchFacesByImageResponse> object. | ||
| 57 | |||
| 58 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rekognition/SearchFacesByImage> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> CollectionId => Str | ||
| 65 | |||
| 66 | ID of the collection to search. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 FaceMatchThreshold => Num | ||
| 71 | |||
| 72 | (Optional) Specifies the minimum confidence in the face match to | ||
| 73 | return. For example, don't return any matches where confidence in | ||
| 74 | matches is less than 70%. The default value is 80%. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> Image => L<Paws::Rekognition::Image> | ||
| 79 | |||
| 80 | The input image as base64-encoded bytes or an S3 object. If you use the | ||
| 81 | AWS CLI to call Amazon Rekognition operations, passing base64-encoded | ||
| 82 | image bytes is not supported. | ||
| 83 | |||
| 84 | If you are using an AWS SDK to call Amazon Rekognition, you might not | ||
| 85 | need to base64-encode image bytes passed using the C<Bytes> field. For | ||
| 86 | more information, see Images in the Amazon Rekognition developer guide. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 MaxFaces => Int | ||
| 91 | |||
| 92 | Maximum number of faces to return. The operation returns the maximum | ||
| 93 | number of faces with the highest confidence in the match. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 QualityFilter => Str | ||
| 98 | |||
| 99 | A filter that specifies a quality bar for how much filtering is done to | ||
| 100 | identify faces. Filtered faces aren't searched for in the collection. | ||
| 101 | If you specify C<AUTO>, Amazon Rekognition chooses the quality bar. If | ||
| 102 | you specify C<LOW>, C<MEDIUM>, or C<HIGH>, filtering removes all faces | ||
| 103 | that donE<rsquo>t meet the chosen quality bar. The quality bar is based | ||
| 104 | on a variety of common use cases. Low-quality detections can occur for | ||
| 105 | a number of reasons. Some examples are an object that's misidentified | ||
| 106 | as a face, a face that's too blurry, or a face with a pose that's too | ||
| 107 | extreme to use. If you specify C<NONE>, no filtering is performed. The | ||
| 108 | default value is C<NONE>. | ||
| 109 | |||
| 110 | To use quality filtering, the collection you are using must be | ||
| 111 | associated with version 3 of the face model or higher. | ||
| 112 | |||
| 113 | Valid values are: C<"NONE">, C<"AUTO">, C<"LOW">, C<"MEDIUM">, C<"HIGH"> | ||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, documenting arguments for method SearchFacesByImage in L<Paws::Rekognition> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |