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.Entity

Description

Synopsis

data Entity = Entity' {
- beginOffset :: Maybe Int
- text :: Maybe Text
- category :: Maybe EntityType
- score :: Maybe Double
- traits :: Maybe [Trait]
- attributes :: Maybe [Attribute]
- endOffset :: Maybe Int
- id :: Maybe Int
- type' :: Maybe EntitySubType
}
newEntity :: Entity
entity_beginOffset :: Lens' Entity (Maybe Int)
entity_text :: Lens' Entity (Maybe Text)
entity_category :: Lens' Entity (Maybe EntityType)
entity_score :: Lens' Entity (Maybe Double)
entity_traits :: Lens' Entity (Maybe [Trait])
entity_attributes :: Lens' Entity (Maybe [Attribute])
entity_endOffset :: Lens' Entity (Maybe Int)
entity_id :: Lens' Entity (Maybe Int)
entity_type :: Lens' Entity (Maybe EntitySubType)

Documentation

data Entity Source #

Provides information about an extracted medical entity.

See: newEntity smart constructor.

Constructors

Entity'

Fields

beginOffset :: Maybe Int
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.
text :: Maybe Text
The segment of input text extracted as this entity.
category :: Maybe EntityType
The category of the entity.
score :: Maybe Double
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
traits :: Maybe [Trait]
Contextual information for the entity.
attributes :: Maybe [Attribute]
The extracted attributes that relate to this entity.
endOffset :: Maybe Int
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 :: Maybe Int
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
type' :: Maybe EntitySubType
Describes the specific type of entity with category of entities.

Instances

Instances details

Eq Entity Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Entity Methods (==) :: Entity -> Entity -> Bool # (/=) :: Entity -> Entity -> Bool #
Read Entity Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Entity Methods readsPrec :: Int -> ReadS Entity # readList :: ReadS [Entity] # readPrec :: ReadPrec Entity # readListPrec :: ReadPrec [Entity] #
Show Entity Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Entity Methods showsPrec :: Int -> Entity -> ShowS # show :: Entity -> String # showList :: [Entity] -> ShowS #
Generic Entity Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Entity Associated Types type Rep Entity :: Type -> Type # Methods from :: Entity -> Rep Entity x # to :: Rep Entity x -> Entity #
NFData Entity Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Entity Methods rnf :: Entity -> () #
Hashable Entity Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Entity Methods hashWithSalt :: Int -> Entity -> Int # hash :: Entity -> Int #
FromJSON Entity Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Entity Methods parseJSON :: Value -> Parser Entity # parseJSONList :: Value -> Parser [Entity] #
type Rep Entity Source #
Instance details Defined in Amazonka.ComprehendMedical.Types.Entity type Rep Entity = D1 ('MetaData "Entity" "Amazonka.ComprehendMedical.Types.Entity" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "Entity'" 'PrefixI 'True) (((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 "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attribute]))) :: (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)))))))

newEntity :: Entity Source #

Create a value of Entity 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:beginOffset:Entity', entity_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.

$sel:text:Entity', entity_text - The segment of input text extracted as this entity.

$sel:category:Entity', entity_category - The category of the entity.

$sel:score:Entity', entity_score - The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

$sel:traits:Entity', entity_traits - Contextual information for the entity.

$sel:attributes:Entity', entity_attributes - The extracted attributes that relate to this entity.

$sel:endOffset:Entity', entity_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.

$sel:id:Entity', entity_id - The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

$sel:type':Entity', entity_type - Describes the specific type of entity with category of entities.

entity_beginOffset :: Lens' Entity (Maybe Int) Source #

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.

entity_text :: Lens' Entity (Maybe Text) Source #

The segment of input text extracted as this entity.

entity_category :: Lens' Entity (Maybe EntityType) Source #

The category of the entity.

entity_score :: Lens' Entity (Maybe Double) Source #

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

entity_traits :: Lens' Entity (Maybe [Trait]) Source #

Contextual information for the entity.

entity_attributes :: Lens' Entity (Maybe [Attribute]) Source #

The extracted attributes that relate to this entity.

entity_endOffset :: Lens' Entity (Maybe Int) Source #

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.

entity_id :: Lens' Entity (Maybe Int) Source #

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

entity_type :: Lens' Entity (Maybe EntitySubType) Source #

Describes the specific type of entity with category of entities.