« blib/lib/Paws/Rekognition/DetectFacesResponse.pm
↑ Summary
blib/lib/Paws/Rekognition/DetectLabelsResponse.pm »
| 1 | |||
| 2 | package Paws::Rekognition::DetectLabels; | ||
| 3 | use Moose; | ||
| 4 | has Image => (is => 'ro', isa => 'Paws::Rekognition::Image', required => 1); | ||
| 5 | has MaxLabels => (is => 'ro', isa => 'Int'); | ||
| 6 | has MinConfidence => (is => 'ro', isa => 'Num'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DetectLabels'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::DetectLabelsResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Rekognition::DetectLabels - Arguments for method DetectLabels on L<Paws::Rekognition> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DetectLabels on the | ||
| 24 | L<Amazon Rekognition|Paws::Rekognition> service. Use the attributes of this class | ||
| 25 | as arguments to method DetectLabels. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DetectLabels. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $rekognition = Paws->service('Rekognition'); | ||
| 32 | # To detect labels | ||
| 33 | # This operation detects labels in the supplied image | ||
| 34 | my $DetectLabelsResponse = $rekognition->DetectLabels( | ||
| 35 | 'Image' => { | ||
| 36 | 'S3Object' => { | ||
| 37 | 'Bucket' => 'mybucket', | ||
| 38 | 'Name' => 'myphoto' | ||
| 39 | } | ||
| 40 | }, | ||
| 41 | 'MaxLabels' => 123, | ||
| 42 | 'MinConfidence' => 70 | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $Labels = $DetectLabelsResponse->Labels; | ||
| 47 | |||
| 48 | # Returns a L<Paws::Rekognition::DetectLabelsResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rekognition/DetectLabels> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> Image => L<Paws::Rekognition::Image> | ||
| 57 | |||
| 58 | The input image as base64-encoded bytes or an S3 object. If you use the | ||
| 59 | AWS CLI to call Amazon Rekognition operations, passing image bytes is | ||
| 60 | not supported. Images stored in an S3 Bucket do not need to be | ||
| 61 | base64-encoded. | ||
| 62 | |||
| 63 | If you are using an AWS SDK to call Amazon Rekognition, you might not | ||
| 64 | need to base64-encode image bytes passed using the C<Bytes> field. For | ||
| 65 | more information, see Images in the Amazon Rekognition developer guide. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 MaxLabels => Int | ||
| 70 | |||
| 71 | Maximum number of labels you want the service to return in the | ||
| 72 | response. The service returns the specified number of highest | ||
| 73 | confidence labels. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 MinConfidence => Num | ||
| 78 | |||
| 79 | Specifies the minimum confidence level for the labels to return. Amazon | ||
| 80 | Rekognition doesn't return any labels with confidence lower than this | ||
| 81 | specified value. | ||
| 82 | |||
| 83 | If C<MinConfidence> is not specified, the operation returns labels with | ||
| 84 | a confidence values greater than or equal to 55 percent. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, documenting arguments for method DetectLabels in L<Paws::Rekognition> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |