libZSservicesZSamazonka-comprehendZSamazonka-comprehend
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Comprehend.Types.Entity

Description

 
Synopsis

Documentation

data Entity Source #

Provides information about an entity.

See: newEntity smart constructor.

Constructors

Entity' 

Fields

  • beginOffset :: Maybe Int

    A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

  • text :: Maybe Text

    The text of the entity.

  • score :: Maybe Double

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

  • endOffset :: Maybe Int

    A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

  • type' :: Maybe EntityType

    The entity's type.

Instances

Instances details
Eq Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

Methods

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

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

Read Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

Show Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

Generic Entity Source # 
Instance details

Defined in Amazonka.Comprehend.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.Comprehend.Types.Entity

Methods

rnf :: Entity -> () #

Hashable Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

Methods

hashWithSalt :: Int -> Entity -> Int #

hash :: Entity -> Int #

FromJSON Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

type Rep Entity Source # 
Instance details

Defined in Amazonka.Comprehend.Types.Entity

type Rep Entity = D1 ('MetaData "Entity" "Amazonka.Comprehend.Types.Entity" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" '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 "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntityType))))))

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 - A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

$sel:text:Entity', entity_text - The text of the entity.

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

$sel:endOffset:Entity', entity_endOffset - A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

$sel:type':Entity', entity_type - The entity's type.

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

A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

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

The text of the entity.

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

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

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

A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.