« blib/lib/Paws/Comprehend/EventsDetectionJobProperties.pm
↑ Summary
blib/lib/Paws/Comprehend/KeyPhrase.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Comprehend::InputDataConfig; | ||
| 3 | use Moose; | ||
| 4 | has InputFormat => (is => 'ro', isa => 'Str'); | ||
| 5 | has S3Uri => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Comprehend::InputDataConfig | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Comprehend::InputDataConfig object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { InputFormat => $value, ..., S3Uri => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Comprehend::InputDataConfig object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->InputFormat | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The input properties for a topic detection job. | ||
| 38 | |||
| 39 | =head1 ATTRIBUTES | ||
| 40 | |||
| 41 | |||
| 42 | =head2 InputFormat => Str | ||
| 43 | |||
| 44 | Specifies how the text in an input file should be processed: | ||
| 45 | |||
| 46 | =over | ||
| 47 | |||
| 48 | =item * | ||
| 49 | |||
| 50 | C<ONE_DOC_PER_FILE> - Each file is considered a separate document. Use | ||
| 51 | this option when you are processing large documents, such as newspaper | ||
| 52 | articles or scientific papers. | ||
| 53 | |||
| 54 | =item * | ||
| 55 | |||
| 56 | C<ONE_DOC_PER_LINE> - Each line in a file is considered a separate | ||
| 57 | document. Use this option when you are processing many short documents, | ||
| 58 | such as text messages. | ||
| 59 | |||
| 60 | =back | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> S3Uri => Str | ||
| 65 | |||
| 66 | The Amazon S3 URI for the input data. The URI must be in same region as | ||
| 67 | the API endpoint that you are calling. The URI can point to a single | ||
| 68 | input file or it can provide the prefix for a collection of data files. | ||
| 69 | |||
| 70 | For example, if you use the URI C<S3://bucketName/prefix>, if the | ||
| 71 | prefix is a single file, Amazon Comprehend uses that file as input. If | ||
| 72 | more than one file begins with the prefix, Amazon Comprehend uses all | ||
| 73 | of them as input. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, describing an object used in L<Paws::Comprehend> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |