blib/lib/Paws/ComprehendMedical/RxNormEntity.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 14 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::ComprehendMedical::RxNormEntity;
3 use Moose;
4 has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::ComprehendMedical::RxNormAttribute]');
5 has BeginOffset => (is => 'ro', isa => 'Int');
6 has Category => (is => 'ro', isa => 'Str');
7 has EndOffset => (is => 'ro', isa => 'Int');
8 has Id => (is => 'ro', isa => 'Int');
9 has RxNormConcepts => (is => 'ro', isa => 'ArrayRef[Paws::ComprehendMedical::RxNormConcept]');
10 has Score => (is => 'ro', isa => 'Num');
11 has Text => (is => 'ro', isa => 'Str');
12 has Traits => (is => 'ro', isa => 'ArrayRef[Paws::ComprehendMedical::RxNormTrait]');
13 has Type => (is => 'ro', isa => 'Str');
14  
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::ComprehendMedical::RxNormEntity
22  
23 =head1 USAGE
24  
25 This class represents one of two things:
26  
27 =head3 Arguments in a call to a service
28  
29 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30 Each attribute should be used as a named argument in the calls that expect this type of object.
31  
32 As an example, if Att1 is expected to be a Paws::ComprehendMedical::RxNormEntity object:
33  
34 $service_obj->Method(Att1 => { Attributes => $value, ..., Type => $value });
35  
36 =head3 Results returned from an API call
37  
38 Use accessors for each attribute. If Att1 is expected to be an Paws::ComprehendMedical::RxNormEntity object:
39  
40 $result = $service_obj->Method(...);
41 $result->Att1->Attributes
42  
43 =head1 DESCRIPTION
44  
45 The collection of medical entities extracted from the input text and
46 their associated information. For each entity, the response provides
47 the entity text, the entity category, where the entity text begins and
48 ends, and the level of confidence that Amazon Comprehend Medical has in
49 the detection and analysis. Attributes and traits of the entity are
50 also returned.
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 Attributes => ArrayRef[L<Paws::ComprehendMedical::RxNormAttribute>]
56  
57 The extracted attributes that relate to the entity. The attributes
58 recognized by InferRxNorm are C<DOSAGE>, C<DURATION>, C<FORM>,
59 C<FREQUENCY>, C<RATE>, C<ROUTE_OR_MODE>, and C<STRENGTH>.
60  
61  
62 =head2 BeginOffset => Int
63  
64 The 0-based character offset in the input text that shows where the
65 entity begins. The offset returns the UTF-8 code point in the string.
66  
67  
68 =head2 Category => Str
69  
70 The category of the entity. The recognized categories are C<GENERIC> or
71 C<BRAND_NAME>.
72  
73  
74 =head2 EndOffset => Int
75  
76 The 0-based character offset in the input text that shows where the
77 entity ends. The offset returns the UTF-8 code point in the string.
78  
79  
80 =head2 Id => Int
81  
82 The numeric identifier for the entity. This is a monotonically
83 increasing id unique within this response rather than a global unique
84 identifier.
85  
86  
87 =head2 RxNormConcepts => ArrayRef[L<Paws::ComprehendMedical::RxNormConcept>]
88  
89 The RxNorm concepts that the entity could refer to, along with a score
90 indicating the likelihood of the match.
91  
92  
93 =head2 Score => Num
94  
95 The level of confidence that Amazon Comprehend Medical has in the
96 accuracy of the detected entity.
97  
98  
99 =head2 Text => Str
100  
101 The segment of input text extracted from which the entity was detected.
102  
103  
104 =head2 Traits => ArrayRef[L<Paws::ComprehendMedical::RxNormTrait>]
105  
106 Contextual information for the entity.
107  
108  
109 =head2 Type => Str
110  
111 Describes the specific type of entity. For InferRxNorm, the recognized
112 entity type is C<MEDICATION>.
113  
114  
115  
116 =head1 SEE ALSO
117  
118 This class forms part of L<Paws>, describing an object used in L<Paws::ComprehendMedical>
119  
120 =head1 BUGS and CONTRIBUTIONS
121  
122 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
123  
124 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
125  
126 =cut
127