« blib/lib/Paws/ComprehendMedical.pm
↑ Summary
blib/lib/Paws/ComprehendMedical/ComprehendMedicalAsyncJobFilter.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ComprehendMedical::Attribute; | ||
| 3 | use Moose; | ||
| 4 | has BeginOffset => (is => 'ro', isa => 'Int'); | ||
| 5 | has Category => (is => 'ro', isa => 'Str'); | ||
| 6 | has EndOffset => (is => 'ro', isa => 'Int'); | ||
| 7 | has Id => (is => 'ro', isa => 'Int'); | ||
| 8 | has RelationshipScore => (is => 'ro', isa => 'Num'); | ||
| 9 | has RelationshipType => (is => 'ro', isa => 'Str'); | ||
| 10 | has Score => (is => 'ro', isa => 'Num'); | ||
| 11 | has Text => (is => 'ro', isa => 'Str'); | ||
| 12 | has Traits => (is => 'ro', isa => 'ArrayRef[Paws::ComprehendMedical::Trait]'); | ||
| 13 | has Type => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ComprehendMedical::Attribute | ||
| 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::Attribute object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { BeginOffset => $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::Attribute object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->BeginOffset | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | An extracted segment of the text that is an attribute of an entity, or | ||
| 46 | otherwise related to an entity, such as the dosage of a medication | ||
| 47 | taken. It contains information about the attribute such as id, begin | ||
| 48 | and end offset within the input text, and the segment of the input | ||
| 49 | text. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 BeginOffset => Int | ||
| 55 | |||
| 56 | The 0-based character offset in the input text that shows where the | ||
| 57 | attribute begins. The offset returns the UTF-8 code point in the | ||
| 58 | string. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Category => Str | ||
| 62 | |||
| 63 | The category of attribute. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 EndOffset => Int | ||
| 67 | |||
| 68 | The 0-based character offset in the input text that shows where the | ||
| 69 | attribute ends. The offset returns the UTF-8 code point in the string. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 Id => Int | ||
| 73 | |||
| 74 | The numeric identifier for this attribute. This is a monotonically | ||
| 75 | increasing id unique within this response rather than a global unique | ||
| 76 | identifier. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 RelationshipScore => Num | ||
| 80 | |||
| 81 | The level of confidence that Amazon Comprehend Medical has that this | ||
| 82 | attribute is correctly related to this entity. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 RelationshipType => Str | ||
| 86 | |||
| 87 | The type of relationship between the entity and attribute. Type for the | ||
| 88 | relationship is C<OVERLAP>, indicating that the entity occurred at the | ||
| 89 | same time as the C<Date_Expression>. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 Score => Num | ||
| 93 | |||
| 94 | The level of confidence that Amazon Comprehend Medical has that the | ||
| 95 | segment of text is correctly recognized as an attribute. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 Text => Str | ||
| 99 | |||
| 100 | The segment of input text extracted as this attribute. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 Traits => ArrayRef[L<Paws::ComprehendMedical::Trait>] | ||
| 104 | |||
| 105 | Contextual information for this attribute. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 Type => Str | ||
| 109 | |||
| 110 | The type of attribute. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head1 SEE ALSO | ||
| 115 | |||
| 116 | This class forms part of L<Paws>, describing an object used in L<Paws::ComprehendMedical> | ||
| 117 | |||
| 118 | =head1 BUGS and CONTRIBUTIONS | ||
| 119 | |||
| 120 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 121 | |||
| 122 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 123 | |||
| 124 | =cut | ||
| 125 |