« blib/lib/Paws/ComprehendMedical/ICD10CMConcept.pm
↑ Summary
blib/lib/Paws/ComprehendMedical/ICD10CMTrait.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ComprehendMedical::ICD10CMEntity; | ||
| 3 | use Moose; | ||
| 4 | has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::ComprehendMedical::ICD10CMAttribute]'); | ||
| 5 | has BeginOffset => (is => 'ro', isa => 'Int'); | ||
| 6 | has Category => (is => 'ro', isa => 'Str'); | ||
| 7 | has EndOffset => (is => 'ro', isa => 'Int'); | ||
| 8 | has ICD10CMConcepts => (is => 'ro', isa => 'ArrayRef[Paws::ComprehendMedical::ICD10CMConcept]'); | ||
| 9 | has Id => (is => 'ro', isa => 'Int'); | ||
| 10 | has Score => (is => 'ro', isa => 'Num'); | ||
| 11 | has Text => (is => 'ro', isa => 'Str'); | ||
| 12 | has Traits => (is => 'ro', isa => 'ArrayRef[Paws::ComprehendMedical::ICD10CMTrait]'); | ||
| 13 | has Type => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ComprehendMedical::ICD10CMEntity | ||
| 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::ICD10CMEntity 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::ICD10CMEntity 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::ICD10CMAttribute>] | ||
| 56 | |||
| 57 | The detected attributes that relate to the entity. An extracted segment | ||
| 58 | of the text that is an attribute of an entity, or otherwise related to | ||
| 59 | an entity, such as the nature of a medical condition. | ||
| 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. InferICD10CM detects entities in the | ||
| 71 | C<MEDICAL_CONDITION> category. | ||
| 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 ICD10CMConcepts => ArrayRef[L<Paws::ComprehendMedical::ICD10CMConcept>] | ||
| 81 | |||
| 82 | The ICD-10-CM concepts that the entity could refer to, along with a | ||
| 83 | score indicating the likelihood of the match. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 Id => Int | ||
| 87 | |||
| 88 | The numeric identifier for the entity. This is a monotonically | ||
| 89 | increasing id unique within this response rather than a global unique | ||
| 90 | identifier. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 Score => Num | ||
| 94 | |||
| 95 | The level of confidence that Amazon Comprehend Medical has in the | ||
| 96 | accuracy of the detection. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 Text => Str | ||
| 100 | |||
| 101 | The segment of input text that is matched to the detected entity. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 Traits => ArrayRef[L<Paws::ComprehendMedical::ICD10CMTrait>] | ||
| 105 | |||
| 106 | Provides Contextual information for the entity. The traits recognized | ||
| 107 | by InferICD10CM are C<DIAGNOSIS>, C<SIGN>, C<SYMPTOM>, and C<NEGATION.> | ||
| 108 | |||
| 109 | |||
| 110 | =head2 Type => Str | ||
| 111 | |||
| 112 | Describes the specific type of entity with category of entities. | ||
| 113 | InferICD10CM detects entities of the type C<DX_NAME> and | ||
| 114 | C<TIME_EXPRESSION>. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, describing an object used in L<Paws::ComprehendMedical> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |