You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ComprehendMedical::Types::RxNormEntity
- Inherits:
-
Struct
- Object
- Struct
- Aws::ComprehendMedical::Types::RxNormEntity
- Defined in:
- (unknown)
Overview
The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
Instance Attribute Summary collapse
-
#attributes ⇒ Array<Types::RxNormAttribute>
The extracted attributes that relate to the entity.
-
#begin_offset ⇒ Integer
The 0-based character offset in the input text that shows where the entity begins.
-
#category ⇒ String
The category of the entity.
-
#end_offset ⇒ Integer
The 0-based character offset in the input text that shows where the entity ends.
-
#id ⇒ Integer
The numeric identifier for the entity.
-
#rx_norm_concepts ⇒ Array<Types::RxNormConcept>
The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
-
#score ⇒ Float
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
-
#text ⇒ String
The segment of input text extracted from which the entity was detected.
-
#traits ⇒ Array<Types::RxNormTrait>
Contextual information for the entity.
-
#type ⇒ String
Describes the specific type of entity.
Instance Attribute Details
#attributes ⇒ Array<Types::RxNormAttribute>
The extracted attributes that relate to the entity. The attributes
recognized by InferRxNorm are DOSAGE
, DURATION
, FORM
, FREQUENCY
,
RATE
, ROUTE_OR_MODE
, and STRENGTH
.
#begin_offset ⇒ Integer
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.
#category ⇒ String
The category of the entity. The recognized categories are GENERIC
or
BRAND_NAME
.
Possible values:
- MEDICATION
#end_offset ⇒ Integer
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.
#id ⇒ Integer
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
#rx_norm_concepts ⇒ Array<Types::RxNormConcept>
The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
#score ⇒ Float
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
#text ⇒ String
The segment of input text extracted from which the entity was detected.
#traits ⇒ Array<Types::RxNormTrait>
Contextual information for the entity.
#type ⇒ String
Describes the specific type of entity. For InferRxNorm, the recognized
entity type is MEDICATION
.
Possible values:
- BRAND_NAME
- GENERIC_NAME