/AWS1/CL_CPMENTITY¶
Provides information about an extracted medical entity.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_id TYPE /AWS1/CPMINTEGER /AWS1/CPMINTEGER¶
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
iv_beginoffset TYPE /AWS1/CPMINTEGER /AWS1/CPMINTEGER¶
The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.
iv_endoffset TYPE /AWS1/CPMINTEGER /AWS1/CPMINTEGER¶
The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.
iv_score TYPE /AWS1/RT_FLOAT_AS_STRING /AWS1/RT_FLOAT_AS_STRING¶
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
iv_text TYPE /AWS1/CPMSTRING /AWS1/CPMSTRING¶
The segment of input text extracted as this entity.
iv_category TYPE /AWS1/CPMENTITYTYPE /AWS1/CPMENTITYTYPE¶
The category of the entity.
iv_type TYPE /AWS1/CPMENTITYSUBTYPE /AWS1/CPMENTITYSUBTYPE¶
Describes the specific type of entity with category of entities.
it_traits TYPE /AWS1/CL_CPMTRAIT=>TT_TRAITLIST TT_TRAITLIST¶
Contextual information for the entity.
it_attributes TYPE /AWS1/CL_CPMATTRIBUTE=>TT_ATTRIBUTELIST TT_ATTRIBUTELIST¶
The extracted attributes that relate to this entity.
Queryable Attributes¶
Id¶
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
BeginOffset¶
The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BEGINOFFSET() |
Getter for BEGINOFFSET, with configurable default |
ASK_BEGINOFFSET() |
Getter for BEGINOFFSET w/ exceptions if field has no value |
HAS_BEGINOFFSET() |
Determine if BEGINOFFSET has a value |
EndOffset¶
The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDOFFSET() |
Getter for ENDOFFSET, with configurable default |
ASK_ENDOFFSET() |
Getter for ENDOFFSET w/ exceptions if field has no value |
HAS_ENDOFFSET() |
Determine if ENDOFFSET has a value |
Score¶
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCORE() |
Getter for SCORE, with configurable default |
ASK_SCORE() |
Getter for SCORE w/ exceptions if field has no value |
STR_SCORE() |
String format for SCORE, with configurable default |
HAS_SCORE() |
Determine if SCORE has a value |
Text¶
The segment of input text extracted as this entity.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEXT() |
Getter for TEXT, with configurable default |
ASK_TEXT() |
Getter for TEXT w/ exceptions if field has no value |
HAS_TEXT() |
Determine if TEXT has a value |
Category¶
The category of the entity.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CATEGORY() |
Getter for CATEGORY, with configurable default |
ASK_CATEGORY() |
Getter for CATEGORY w/ exceptions if field has no value |
HAS_CATEGORY() |
Determine if CATEGORY has a value |
Type¶
Describes the specific type of entity with category of entities.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
Traits¶
Contextual information for the entity.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRAITS() |
Getter for TRAITS, with configurable default |
ASK_TRAITS() |
Getter for TRAITS w/ exceptions if field has no value |
HAS_TRAITS() |
Determine if TRAITS has a value |
Attributes¶
The extracted attributes that relate to this entity.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ATTRIBUTES() |
Getter for ATTRIBUTES, with configurable default |
ASK_ATTRIBUTES() |
Getter for ATTRIBUTES w/ exceptions if field has no value |
HAS_ATTRIBUTES() |
Determine if ATTRIBUTES has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_ENTITYLIST¶
TYPES TT_ENTITYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_CPMENTITY WITH DEFAULT KEY
.