Amazonka.Comprehend.Types.PiiEntity

Documentation

data PiiEntity

Provides information about a PII entity.

See: newPiiEntity smart constructor.

Constructors

PiiEntity'

Fields

• beginOffset :: Maybe Int

  The zero-based offset from the beginning of the source text to the first character in the entity.

• endOffset :: Maybe Int

  The zero-based offset from the beginning of the source text to the last character in the entity.

• score :: Maybe Double

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

• type' :: Maybe PiiEntityType

  The entity's type.

Instances

FromJSON PiiEntity

Defined in Amazonka.Comprehend.Types.PiiEntity

Methods

parseJSON :: Value -> Parser PiiEntity

parseJSONList :: Value -> Parser [PiiEntity]

Generic PiiEntity

Defined in Amazonka.Comprehend.Types.PiiEntity

Associated Types

type Rep PiiEntity :: Type -> Type

Methods

from :: PiiEntity -> Rep PiiEntity x

to :: Rep PiiEntity x -> PiiEntity

Read PiiEntity

Defined in Amazonka.Comprehend.Types.PiiEntity

Methods

readsPrec :: Int -> ReadS PiiEntity

readList :: ReadS [PiiEntity]

readPrec :: ReadPrec PiiEntity

readListPrec :: ReadPrec [PiiEntity]

Show PiiEntity

Defined in Amazonka.Comprehend.Types.PiiEntity

Methods

showsPrec :: Int -> PiiEntity -> ShowS

show :: PiiEntity -> String

showList :: [PiiEntity] -> ShowS

NFData PiiEntity

Defined in Amazonka.Comprehend.Types.PiiEntity

Methods

rnf :: PiiEntity -> ()

Eq PiiEntity

Defined in Amazonka.Comprehend.Types.PiiEntity

Methods

(==) :: PiiEntity -> PiiEntity -> Bool

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

Hashable PiiEntity

Defined in Amazonka.Comprehend.Types.PiiEntity

Methods

hashWithSalt :: Int -> PiiEntity -> Int

hash :: PiiEntity -> Int

type Rep PiiEntity

Defined in Amazonka.Comprehend.Types.PiiEntity

type Rep PiiEntity = D1 ('MetaData "PiiEntity" "Amazonka.Comprehend.Types.PiiEntity" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "PiiEntity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiEntityType)))))

newPiiEntity :: PiiEntity

Create a value of PiiEntity 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:PiiEntity', piiEntity_beginOffset - The zero-based offset from the beginning of the source text to the first character in the entity.

$sel:endOffset:PiiEntity', piiEntity_endOffset - The zero-based offset from the beginning of the source text to the last character in the entity.

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

$sel:type':PiiEntity', piiEntity_type - The entity's type.

piiEntity_beginOffset :: Lens' PiiEntity (Maybe Int)

The zero-based offset from the beginning of the source text to the first character in the entity.

piiEntity_endOffset :: Lens' PiiEntity (Maybe Int)

The zero-based offset from the beginning of the source text to the last character in the entity.

piiEntity_score :: Lens' PiiEntity (Maybe Double)

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

piiEntity_type :: Lens' PiiEntity (Maybe PiiEntityType)

The entity's type.