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.Comprehend.Types.PiiEntity

Description

Synopsis

data PiiEntity = PiiEntity' {
- beginOffset :: Maybe Int
- score :: Maybe Double
- endOffset :: Maybe Int
- type' :: Maybe PiiEntityType
}
newPiiEntity :: PiiEntity
piiEntity_beginOffset :: Lens' PiiEntity (Maybe Int)
piiEntity_score :: Lens' PiiEntity (Maybe Double)
piiEntity_endOffset :: Lens' PiiEntity (Maybe Int)
piiEntity_type :: Lens' PiiEntity (Maybe PiiEntityType)

Documentation

data PiiEntity Source #

Provides information about a PII entity.

See: newPiiEntity smart constructor.

Constructors

PiiEntity'

Fields

beginOffset :: Maybe Int
A character offset in the input text that shows where the PII 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.
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 PII 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 PiiEntityType
The entity's type.

Instances

Instances details

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

newPiiEntity :: PiiEntity Source #

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 - A character offset in the input text that shows where the PII 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:score:PiiEntity', piiEntity_score - The level of confidence that Amazon Comprehend has in the accuracy of the detection.

$sel:endOffset:PiiEntity', piiEntity_endOffset - A character offset in the input text that shows where the PII 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':PiiEntity', piiEntity_type - The entity's type.

piiEntity_beginOffset :: Lens' PiiEntity (Maybe Int) Source #

A character offset in the input text that shows where the PII 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.

piiEntity_score :: Lens' PiiEntity (Maybe Double) Source #

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

piiEntity_endOffset :: Lens' PiiEntity (Maybe Int) Source #

A character offset in the input text that shows where the PII 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.

piiEntity_type :: Lens' PiiEntity (Maybe PiiEntityType) Source #

The entity's type.