Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ComprehendMedical.Types.Attribute

Description

Synopsis

data Attribute = Attribute' {
- relationshipScore :: Maybe Double
- beginOffset :: Maybe Int
- text :: Maybe Text
- category :: Maybe EntityType
- score :: Maybe Double
- traits :: Maybe [Trait]
- relationshipType :: Maybe RelationshipType
- endOffset :: Maybe Int
- id :: Maybe Int
- type' :: Maybe EntitySubType
}
newAttribute :: Attribute
attribute_relationshipScore :: Lens' Attribute (Maybe Double)
attribute_beginOffset :: Lens' Attribute (Maybe Int)
attribute_text :: Lens' Attribute (Maybe Text)
attribute_category :: Lens' Attribute (Maybe EntityType)
attribute_score :: Lens' Attribute (Maybe Double)
attribute_traits :: Lens' Attribute (Maybe [Trait])
attribute_relationshipType :: Lens' Attribute (Maybe RelationshipType)
attribute_endOffset :: Lens' Attribute (Maybe Int)
attribute_id :: Lens' Attribute (Maybe Int)
attribute_type :: Lens' Attribute (Maybe EntitySubType)

Documentation

data Attribute Source #

An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text.

See: newAttribute smart constructor.

Constructors

Attribute'

Fields

relationshipScore :: Maybe Double
The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
beginOffset :: Maybe Int
The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.
text :: Maybe Text
The segment of input text extracted as this attribute.
category :: Maybe EntityType
The category of attribute.
score :: Maybe Double
The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
traits :: Maybe [Trait]
Contextual information for this attribute.
relationshipType :: Maybe RelationshipType
The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.
endOffset :: Maybe Int
The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.
id :: Maybe Int
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
type' :: Maybe EntitySubType
The type of attribute.

Instances

Instances details

Eq Attribute Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Attribute Methods (==) :: Attribute -> Attribute -> Bool # (/=) :: Attribute -> Attribute -> Bool #
Read Attribute Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Attribute Methods readsPrec :: Int -> ReadS Attribute # readList :: ReadS [Attribute] # readPrec :: ReadPrec Attribute # readListPrec :: ReadPrec [Attribute] #
Show Attribute Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Attribute Methods showsPrec :: Int -> Attribute -> ShowS # show :: Attribute -> String # showList :: [Attribute] -> ShowS #
Generic Attribute Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Attribute Associated Types type Rep Attribute :: Type -> Type # Methods from :: Attribute -> Rep Attribute x # to :: Rep Attribute x -> Attribute #
NFData Attribute Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Attribute Methods rnf :: Attribute -> () #
Hashable Attribute Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Attribute Methods hashWithSalt :: Int -> Attribute -> Int # hash :: Attribute -> Int #
FromJSON Attribute Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Attribute Methods parseJSON :: Value -> Parser Attribute # parseJSONList :: Value -> Parser [Attribute] #
type Rep Attribute Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Attribute type Rep Attribute = D1 ('MetaData "Attribute" "Amazonka.ComprehendMedical.Types.Attribute" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "Attribute'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "relationshipScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityType)) :: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))) :: ((S1 ('MetaSel ('Just "traits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Trait])) :: S1 ('MetaSel ('Just "relationshipType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RelationshipType))) :: (S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntitySubType)))))))

newAttribute :: Attribute Source #

Create a value of Attribute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:relationshipScore:Attribute', attribute_relationshipScore - The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

$sel:beginOffset:Attribute', attribute_beginOffset - The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

$sel:text:Attribute', attribute_text - The segment of input text extracted as this attribute.

$sel:category:Attribute', attribute_category - The category of attribute.

$sel:score:Attribute', attribute_score - The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

$sel:traits:Attribute', attribute_traits - Contextual information for this attribute.

$sel:relationshipType:Attribute', attribute_relationshipType - The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

$sel:endOffset:Attribute', attribute_endOffset - The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.

$sel:id:Attribute', attribute_id - The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

$sel:type':Attribute', attribute_type - The type of attribute.

attribute_relationshipScore :: Lens' Attribute (Maybe Double) Source #

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

attribute_beginOffset :: Lens' Attribute (Maybe Int) Source #

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

attribute_text :: Lens' Attribute (Maybe Text) Source #

The segment of input text extracted as this attribute.

attribute_category :: Lens' Attribute (Maybe EntityType) Source #

The category of attribute.

attribute_score :: Lens' Attribute (Maybe Double) Source #

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

attribute_traits :: Lens' Attribute (Maybe [Trait]) Source #

Contextual information for this attribute.

attribute_relationshipType :: Lens' Attribute (Maybe RelationshipType) Source #

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

attribute_endOffset :: Lens' Attribute (Maybe Int) Source #

The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.

attribute_id :: Lens' Attribute (Maybe Int) Source #

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

attribute_type :: Lens' Attribute (Maybe EntitySubType) Source #

The type of attribute.