« blib/lib/Paws/Rekognition/TestingDataResult.pm
↑ Summary
blib/lib/Paws/Rekognition/TextDetectionResult.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Rekognition::TextDetection; | ||
| 3 | use Moose; | ||
| 4 | has Confidence => (is => 'ro', isa => 'Num'); | ||
| 5 | has DetectedText => (is => 'ro', isa => 'Str'); | ||
| 6 | has Geometry => (is => 'ro', isa => 'Paws::Rekognition::Geometry'); | ||
| 7 | has Id => (is => 'ro', isa => 'Int'); | ||
| 8 | has ParentId => (is => 'ro', isa => 'Int'); | ||
| 9 | has Type => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Rekognition::TextDetection | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::Rekognition::TextDetection object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Confidence => $value, ..., Type => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::Rekognition::TextDetection object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Confidence | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Information about a word or line of text detected by DetectText. | ||
| 42 | |||
| 43 | The C<DetectedText> field contains the text that Amazon Rekognition | ||
| 44 | detected in the image. | ||
| 45 | |||
| 46 | Every word and line has an identifier (C<Id>). Each word belongs to a | ||
| 47 | line and has a parent identifier (C<ParentId>) that identifies the line | ||
| 48 | of text in which the word appears. The word C<Id> is also an index for | ||
| 49 | the word within a line of words. | ||
| 50 | |||
| 51 | For more information, see Detecting Text in the Amazon Rekognition | ||
| 52 | Developer Guide. | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Confidence => Num | ||
| 58 | |||
| 59 | The confidence that Amazon Rekognition has in the accuracy of the | ||
| 60 | detected text and the accuracy of the geometry points around the | ||
| 61 | detected text. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 DetectedText => Str | ||
| 65 | |||
| 66 | The word or line of text recognized by Amazon Rekognition. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Geometry => L<Paws::Rekognition::Geometry> | ||
| 70 | |||
| 71 | The location of the detected text on the image. Includes an axis | ||
| 72 | aligned coarse bounding box surrounding the text and a finer grain | ||
| 73 | polygon for more accurate spatial information. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 Id => Int | ||
| 77 | |||
| 78 | The identifier for the detected text. The identifier is only unique for | ||
| 79 | a single call to C<DetectText>. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 ParentId => Int | ||
| 83 | |||
| 84 | The Parent identifier for the detected text identified by the value of | ||
| 85 | C<ID>. If the type of detected text is C<LINE>, the value of | ||
| 86 | C<ParentId> is C<Null>. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 Type => Str | ||
| 90 | |||
| 91 | The type of text that was detected. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, describing an object used in L<Paws::Rekognition> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |