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

filter: Statementstmt 0.0% 0 / 12 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 14 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Comprehend::DetectEntities;
3 use Moose;
4 has EndpointArn => (is => 'ro', isa => 'Str');
5 has LanguageCode => (is => 'ro', isa => 'Str');
6 has Text => (is => 'ro', isa => 'Str', required => 1);
7  
8 use MooseX::ClassAttribute;
9  
10 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DetectEntities');
11 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Comprehend::DetectEntitiesResponse');
12 class_has _result_key => (isa => 'Str', is => 'ro');
13 1;
14  
15 ### main pod documentation begin ###
16  
17 =head1 NAME
18  
19 Paws::Comprehend::DetectEntities - Arguments for method DetectEntities on L<Paws::Comprehend>
20  
21 =head1 DESCRIPTION
22  
23 This class represents the parameters used for calling the method DetectEntities on the
24 L<Amazon Comprehend|Paws::Comprehend> service. Use the attributes of this class
25 as arguments to method DetectEntities.
26  
27 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DetectEntities.
28  
29 =head1 SYNOPSIS
30  
31 my $comprehend = Paws->service('Comprehend');
32 my $DetectEntitiesResponse = $comprehend->DetectEntities(
33 Text => 'MyCustomerInputString',
34 EndpointArn => 'MyEntityRecognizerEndpointArn', # OPTIONAL
35 LanguageCode => 'en', # OPTIONAL
36 );
37  
38 # Results:
39 my $Entities = $DetectEntitiesResponse->Entities;
40  
41 # Returns a L<Paws::Comprehend::DetectEntitiesResponse> object.
42  
43 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.
44 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/comprehend/DetectEntities>
45  
46 =head1 ATTRIBUTES
47  
48  
49 =head2 EndpointArn => Str
50  
51 The Amazon Resource Name of an endpoint that is associated with a
52 custom entity recognition model. Provide an endpoint if you want to
53 detect entities by using your own custom model instead of the default
54 model that is used by Amazon Comprehend.
55  
56 If you specify an endpoint, Amazon Comprehend uses the language of your
57 custom model, and it ignores any language code that you provide in your
58 request.
59  
60  
61  
62 =head2 LanguageCode => Str
63  
64 The language of the input documents. You can specify any of the primary
65 languages supported by Amazon Comprehend. All documents must be in the
66 same language.
67  
68 If your request includes the endpoint for a custom entity recognition
69 model, Amazon Comprehend uses the language of your custom model, and it
70 ignores any language code that you specify here.
71  
72 Valid values are: C<"en">, C<"es">, C<"fr">, C<"de">, C<"it">, C<"pt">, C<"ar">, C<"hi">, C<"ja">, C<"ko">, C<"zh">, C<"zh-TW">
73  
74 =head2 B<REQUIRED> Text => Str
75  
76 A UTF-8 text string. Each string must contain fewer that 5,000 bytes of
77 UTF-8 encoded characters.
78  
79  
80  
81  
82 =head1 SEE ALSO
83  
84 This class forms part of L<Paws>, documenting arguments for method DetectEntities in L<Paws::Comprehend>
85  
86 =head1 BUGS and CONTRIBUTIONS
87  
88 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
89  
90 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
91  
92 =cut
93