« blib/lib/Paws/ComprehendMedical/DetectPHIResponse.pm
↑ Summary
blib/lib/Paws/ComprehendMedical/ICD10CMAttribute.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ComprehendMedical::Entity; | ||
| 3 | use Moose; | ||
| 4 | has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::ComprehendMedical::Attribute]'); | ||
| 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 Score => (is => 'ro', isa => 'Num'); | ||
| 10 | has Text => (is => 'ro', isa => 'Str'); | ||
| 11 | has Traits => (is => 'ro', isa => 'ArrayRef[Paws::ComprehendMedical::Trait]'); | ||
| 12 | has Type => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ComprehendMedical::Entity | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::ComprehendMedical::Entity object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Attributes => $value, ..., Type => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::ComprehendMedical::Entity object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Attributes | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Provides information about an extracted medical entity. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Attributes => ArrayRef[L<Paws::ComprehendMedical::Attribute>] | ||
| 50 | |||
| 51 | The extracted attributes that relate to this entity. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 BeginOffset => Int | ||
| 55 | |||
| 56 | The 0-based character offset in the input text that shows where the | ||
| 57 | entity begins. The offset returns the UTF-8 code point in the string. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Category => Str | ||
| 61 | |||
| 62 | The category of the entity. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 EndOffset => Int | ||
| 66 | |||
| 67 | The 0-based character offset in the input text that shows where the | ||
| 68 | entity ends. The offset returns the UTF-8 code point in the string. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Id => Int | ||
| 72 | |||
| 73 | The numeric identifier for the entity. This is a monotonically | ||
| 74 | increasing id unique within this response rather than a global unique | ||
| 75 | identifier. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Score => Num | ||
| 79 | |||
| 80 | The level of confidence that Amazon Comprehend Medical has in the | ||
| 81 | accuracy of the detection. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 Text => Str | ||
| 85 | |||
| 86 | The segment of input text extracted as this entity. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 Traits => ArrayRef[L<Paws::ComprehendMedical::Trait>] | ||
| 90 | |||
| 91 | Contextual information for the entity. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 Type => Str | ||
| 95 | |||
| 96 | Describes the specific type of entity with category of entities. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, describing an object used in L<Paws::ComprehendMedical> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |