Amazonka.ComprehendMedical.Types.Entity

Documentation

data Entity

Provides information about an extracted medical entity.

See: newEntity smart constructor.

Constructors

Entity'

Fields

• attributes :: Maybe [Attribute]

  The extracted attributes that relate to this entity.

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

• category :: Maybe EntityType

  The category of the 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.

• score :: Maybe Double

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

• text :: Maybe Text

  The segment of input text extracted as this entity.

• traits :: Maybe [Trait]

  Contextual information for the entity.

• type' :: Maybe EntitySubType

  Describes the specific type of entity with category of entities.

Instances

FromJSON Entity

Defined in Amazonka.ComprehendMedical.Types.Entity

Methods

parseJSON :: Value -> Parser Entity

parseJSONList :: Value -> Parser [Entity]

Generic Entity

Defined in Amazonka.ComprehendMedical.Types.Entity

Associated Types

type Rep Entity :: Type -> Type

Methods

from :: Entity -> Rep Entity x

to :: Rep Entity x -> Entity

Read Entity

Defined in Amazonka.ComprehendMedical.Types.Entity

Methods

readsPrec :: Int -> ReadS Entity

readList :: ReadS [Entity]

readPrec :: ReadPrec Entity

readListPrec :: ReadPrec [Entity]

Show Entity

Defined in Amazonka.ComprehendMedical.Types.Entity

Methods

showsPrec :: Int -> Entity -> ShowS

show :: Entity -> String

showList :: [Entity] -> ShowS

NFData Entity

Defined in Amazonka.ComprehendMedical.Types.Entity

Methods

rnf :: Entity -> ()

Eq Entity

Defined in Amazonka.ComprehendMedical.Types.Entity

Methods

(==) :: Entity -> Entity -> Bool

(/=) :: Entity -> Entity -> Bool

Hashable Entity

Defined in Amazonka.ComprehendMedical.Types.Entity

Methods

hashWithSalt :: Int -> Entity -> Int

hash :: Entity -> Int

type Rep Entity

Defined in Amazonka.ComprehendMedical.Types.Entity

type Rep Entity = D1 ('MetaData "Entity" "Amazonka.ComprehendMedical.Types.Entity" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "Entity'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attribute])) :*: S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityType)) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "traits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Trait])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntitySubType)))))))

newEntity :: Entity

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:attributes:Entity', entity_attributes - The extracted attributes that relate to this entity.

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.

Entity, entity_category - The category of the entity.

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.

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.

Entity, entity_score - The level of confidence that Comprehend Medical; has in the accuracy of the detection.

Entity, entity_text - The segment of input text extracted as this entity.

Entity, entity_traits - Contextual information for the entity.

Entity, entity_type - Describes the specific type of entity with category of entities.

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

The extracted attributes that relate to this entity.

entity_beginOffset :: Lens' Entity (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.

entity_category :: Lens' Entity (Maybe EntityType)

The category of the entity.

entity_endOffset :: Lens' Entity (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.

entity_id :: Lens' Entity (Maybe Int)

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

entity_score :: Lens' Entity (Maybe Double)

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

entity_text :: Lens' Entity (Maybe Text)

The segment of input text extracted as this entity.

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

Contextual information for the entity.

entity_type :: Lens' Entity (Maybe EntitySubType)

Describes the specific type of entity with category of entities.