blib/lib/Paws/Comprehend/EntityRecognizerInputDataConfig.pm untested

filter: Statementstmt 0.0% 0 / 9 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 10 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Comprehend::EntityRecognizerInputDataConfig;
3 use Moose;
4 has Annotations => (is => 'ro', isa => 'Paws::Comprehend::EntityRecognizerAnnotations');
5 has AugmentedManifests => (is => 'ro', isa => 'ArrayRef[Paws::Comprehend::AugmentedManifestsListItem]');
6 has DataFormat => (is => 'ro', isa => 'Str');
7 has Documents => (is => 'ro', isa => 'Paws::Comprehend::EntityRecognizerDocuments');
8 has EntityList => (is => 'ro', isa => 'Paws::Comprehend::EntityRecognizerEntityList');
9 has EntityTypes => (is => 'ro', isa => 'ArrayRef[Paws::Comprehend::EntityTypesListItem]', required => 1);
10  
11 1;
12  
13 ### main pod documentation begin ###
14  
15 =head1 NAME
16  
17 Paws::Comprehend::EntityRecognizerInputDataConfig
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::Comprehend::EntityRecognizerInputDataConfig object:
29  
30 $service_obj->Method(Att1 => { Annotations => $value, ..., EntityTypes => $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::Comprehend::EntityRecognizerInputDataConfig object:
35  
36 $result = $service_obj->Method(...);
37 $result->Att1->Annotations
38  
39 =head1 DESCRIPTION
40  
41 Specifies the format and location of the input data.
42  
43 =head1 ATTRIBUTES
44  
45  
46 =head2 Annotations => L<Paws::Comprehend::EntityRecognizerAnnotations>
47  
48 The S3 location of the CSV file that annotates your training documents.
49  
50  
51 =head2 AugmentedManifests => ArrayRef[L<Paws::Comprehend::AugmentedManifestsListItem>]
52  
53 A list of augmented manifest files that provide training data for your
54 custom model. An augmented manifest file is a labeled dataset that is
55 produced by Amazon SageMaker Ground Truth.
56  
57 This parameter is required if you set C<DataFormat> to
58 C<AUGMENTED_MANIFEST>.
59  
60  
61 =head2 DataFormat => Str
62  
63 The format of your training data:
64  
65 =over
66  
67 =item *
68  
69 C<COMPREHEND_CSV>: A CSV file that supplements your training documents.
70 The CSV file contains information about the custom entities that your
71 trained model will detect. The required format of the file depends on
72 whether you are providing annotations or an entity list.
73  
74 If you use this value, you must provide your CSV file by using either
75 the C<Annotations> or C<EntityList> parameters. You must provide your
76 training documents by using the C<Documents> parameter.
77  
78 =item *
79  
80 C<AUGMENTED_MANIFEST>: A labeled dataset that is produced by Amazon
81 SageMaker Ground Truth. This file is in JSON lines format. Each line is
82 a complete JSON object that contains a training document and its
83 labels. Each label annotates a named entity in the training document.
84  
85 If you use this value, you must provide the C<AugmentedManifests>
86 parameter in your request.
87  
88 =back
89  
90 If you don't specify a value, Amazon Comprehend uses C<COMPREHEND_CSV>
91 as the default.
92  
93  
94 =head2 Documents => L<Paws::Comprehend::EntityRecognizerDocuments>
95  
96 The S3 location of the folder that contains the training documents for
97 your custom entity recognizer.
98  
99 This parameter is required if you set C<DataFormat> to
100 C<COMPREHEND_CSV>.
101  
102  
103 =head2 EntityList => L<Paws::Comprehend::EntityRecognizerEntityList>
104  
105 The S3 location of the CSV file that has the entity list for your
106 custom entity recognizer.
107  
108  
109 =head2 B<REQUIRED> EntityTypes => ArrayRef[L<Paws::Comprehend::EntityTypesListItem>]
110  
111 The entity types in the labeled training data that Amazon Comprehend
112 uses to train the custom entity recognizer. Any entity types that you
113 don't specify are ignored.
114  
115 A maximum of 25 entity types can be used at one time to train an entity
116 recognizer. Entity types must not contain the following invalid
117 characters: \n (line break), \\n (escaped line break), \r (carriage
118 return), \\r (escaped carriage return), \t (tab), \\t (escaped tab),
119 space, and , (comma).
120  
121  
122  
123 =head1 SEE ALSO
124  
125 This class forms part of L<Paws>, describing an object used in L<Paws::Comprehend>
126  
127 =head1 BUGS and CONTRIBUTIONS
128  
129 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
130  
131 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
132  
133 =cut
134