| 1 | |||
| 2 | package Paws::Rekognition::SearchFaces; | ||
| 3 | use Moose; | ||
| 4 | has CollectionId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has FaceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has FaceMatchThreshold => (is => 'ro', isa => 'Num'); | ||
| 7 | has MaxFaces => (is => 'ro', isa => 'Int'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchFaces'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::SearchFacesResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Rekognition::SearchFaces - Arguments for method SearchFaces on L<Paws::Rekognition> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method SearchFaces on the | ||
| 25 | L<Amazon Rekognition|Paws::Rekognition> service. Use the attributes of this class | ||
| 26 | as arguments to method SearchFaces. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchFaces. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rekognition = Paws->service('Rekognition'); | ||
| 33 | # To delete a face | ||
| 34 | # This operation searches for matching faces in the collection the supplied face | ||
| 35 | # belongs to. | ||
| 36 | my $SearchFacesResponse = $rekognition->SearchFaces( | ||
| 37 | 'CollectionId' => 'myphotos', | ||
| 38 | 'FaceId' => '70008e50-75e4-55d0-8e80-363fb73b3a14', | ||
| 39 | 'FaceMatchThreshold' => 90, | ||
| 40 | 'MaxFaces' => 10 | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $FaceMatches = $SearchFacesResponse->FaceMatches; | ||
| 45 | my $SearchedFaceId = $SearchFacesResponse->SearchedFaceId; | ||
| 46 | |||
| 47 | # Returns a L<Paws::Rekognition::SearchFacesResponse> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rekognition/SearchFaces> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> CollectionId => Str | ||
| 56 | |||
| 57 | ID of the collection the face belongs to. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> FaceId => Str | ||
| 62 | |||
| 63 | ID of a face to find matches for in the collection. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 FaceMatchThreshold => Num | ||
| 68 | |||
| 69 | Optional value specifying the minimum confidence in the face match to | ||
| 70 | return. For example, don't return any matches where confidence in | ||
| 71 | matches is less than 70%. The default value is 80%. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 MaxFaces => Int | ||
| 76 | |||
| 77 | Maximum number of faces to return. The operation returns the maximum | ||
| 78 | number of faces with the highest confidence in the match. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method SearchFaces in L<Paws::Rekognition> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |