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

Description

Synopsis

data KeyPhrase = KeyPhrase' {
- beginOffset :: Maybe Int
- text :: Maybe Text
- score :: Maybe Double
- endOffset :: Maybe Int
}
newKeyPhrase :: KeyPhrase
keyPhrase_beginOffset :: Lens' KeyPhrase (Maybe Int)
keyPhrase_text :: Lens' KeyPhrase (Maybe Text)
keyPhrase_score :: Lens' KeyPhrase (Maybe Double)
keyPhrase_endOffset :: Lens' KeyPhrase (Maybe Int)

Documentation

data KeyPhrase Source #

Describes a key noun phrase.

See: newKeyPhrase smart constructor.

Constructors

KeyPhrase'

Fields

beginOffset :: Maybe Int
A character offset in the input text that shows where the key phrase 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 a key noun phrase.
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 where the key phrase 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.

Instances

Instances details

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

newKeyPhrase :: KeyPhrase Source #

Create a value of KeyPhrase 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:KeyPhrase', keyPhrase_beginOffset - A character offset in the input text that shows where the key phrase 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:KeyPhrase', keyPhrase_text - The text of a key noun phrase.

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

$sel:endOffset:KeyPhrase', keyPhrase_endOffset - A character offset in the input text where the key phrase 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.

keyPhrase_beginOffset :: Lens' KeyPhrase (Maybe Int) Source #

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

keyPhrase_text :: Lens' KeyPhrase (Maybe Text) Source #

The text of a key noun phrase.

keyPhrase_score :: Lens' KeyPhrase (Maybe Double) Source #

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

keyPhrase_endOffset :: Lens' KeyPhrase (Maybe Int) Source #

A character offset in the input text where the key phrase 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.