« blib/lib/Paws/Rekognition/DetectProtectiveEquipmentResponse.pm
↑ Summary
blib/lib/Paws/Rekognition/DetectTextFilters.pm »
| 1 | |||
| 2 | package Paws::Rekognition::DetectText; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'Paws::Rekognition::DetectTextFilters'); | ||
| 5 | has Image => (is => 'ro', isa => 'Paws::Rekognition::Image', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DetectText'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::DetectTextResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Rekognition::DetectText - Arguments for method DetectText on L<Paws::Rekognition> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DetectText on the | ||
| 23 | L<Amazon Rekognition|Paws::Rekognition> service. Use the attributes of this class | ||
| 24 | as arguments to method DetectText. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DetectText. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $rekognition = Paws->service('Rekognition'); | ||
| 31 | my $DetectTextResponse = $rekognition->DetectText( | ||
| 32 | Image => { | ||
| 33 | Bytes => 'BlobImageBlob', # min: 1, max: 5242880; OPTIONAL | ||
| 34 | S3Object => { | ||
| 35 | Bucket => 'MyS3Bucket', # min: 3, max: 255; OPTIONAL | ||
| 36 | Name => 'MyS3ObjectName', # min: 1, max: 1024; OPTIONAL | ||
| 37 | Version => 'MyS3ObjectVersion', # min: 1, max: 1024; OPTIONAL | ||
| 38 | }, # OPTIONAL | ||
| 39 | }, | ||
| 40 | Filters => { | ||
| 41 | RegionsOfInterest => [ | ||
| 42 | { | ||
| 43 | BoundingBox => { | ||
| 44 | Height => 1.0, # OPTIONAL | ||
| 45 | Left => 1.0, # OPTIONAL | ||
| 46 | Top => 1.0, # OPTIONAL | ||
| 47 | Width => 1.0, # OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | }, | ||
| 50 | ... | ||
| 51 | ], # max: 10; OPTIONAL | ||
| 52 | WordFilter => { | ||
| 53 | MinBoundingBoxHeight => 1.0, # max: 1; OPTIONAL | ||
| 54 | MinBoundingBoxWidth => 1.0, # max: 1; OPTIONAL | ||
| 55 | MinConfidence => 1.0, # max: 100; OPTIONAL | ||
| 56 | }, # OPTIONAL | ||
| 57 | }, # OPTIONAL | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $TextDetections = $DetectTextResponse->TextDetections; | ||
| 62 | my $TextModelVersion = $DetectTextResponse->TextModelVersion; | ||
| 63 | |||
| 64 | # Returns a L<Paws::Rekognition::DetectTextResponse> object. | ||
| 65 | |||
| 66 | 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. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rekognition/DetectText> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 Filters => L<Paws::Rekognition::DetectTextFilters> | ||
| 73 | |||
| 74 | Optional parameters that let you set the criteria that the text must | ||
| 75 | meet to be included in your response. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> Image => L<Paws::Rekognition::Image> | ||
| 80 | |||
| 81 | The input image as base64-encoded bytes or an Amazon S3 object. If you | ||
| 82 | use the AWS CLI to call Amazon Rekognition operations, you can't pass | ||
| 83 | image bytes. | ||
| 84 | |||
| 85 | If you are using an AWS SDK to call Amazon Rekognition, you might not | ||
| 86 | need to base64-encode image bytes passed using the C<Bytes> field. For | ||
| 87 | more information, see Images in the Amazon Rekognition developer guide. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, documenting arguments for method DetectText in L<Paws::Rekognition> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 |