Amazonka.Comprehend.Types.KeyPhrase

Documentation

data KeyPhrase

Describes a key noun phrase.

See: newKeyPhrase smart constructor.

Constructors

KeyPhrase'

Fields

• beginOffset :: Maybe Int

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

• endOffset :: Maybe Int

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

• score :: Maybe Double

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

• text :: Maybe Text

  The text of a key noun phrase.

Instances

FromJSON KeyPhrase

Defined in Amazonka.Comprehend.Types.KeyPhrase

Methods

parseJSON :: Value -> Parser KeyPhrase

parseJSONList :: Value -> Parser [KeyPhrase]

Generic KeyPhrase

Defined in Amazonka.Comprehend.Types.KeyPhrase

Associated Types

type Rep KeyPhrase :: Type -> Type

Methods

from :: KeyPhrase -> Rep KeyPhrase x

to :: Rep KeyPhrase x -> KeyPhrase

Read KeyPhrase

Defined in Amazonka.Comprehend.Types.KeyPhrase

Methods

readsPrec :: Int -> ReadS KeyPhrase

readList :: ReadS [KeyPhrase]

readPrec :: ReadPrec KeyPhrase

readListPrec :: ReadPrec [KeyPhrase]

Show KeyPhrase

Defined in Amazonka.Comprehend.Types.KeyPhrase

Methods

showsPrec :: Int -> KeyPhrase -> ShowS

show :: KeyPhrase -> String

showList :: [KeyPhrase] -> ShowS

NFData KeyPhrase

Defined in Amazonka.Comprehend.Types.KeyPhrase

Methods

rnf :: KeyPhrase -> ()

Eq KeyPhrase

Defined in Amazonka.Comprehend.Types.KeyPhrase

Methods

(==) :: KeyPhrase -> KeyPhrase -> Bool

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

Hashable KeyPhrase

Defined in Amazonka.Comprehend.Types.KeyPhrase

Methods

hashWithSalt :: Int -> KeyPhrase -> Int

hash :: KeyPhrase -> Int

type Rep KeyPhrase

Defined in Amazonka.Comprehend.Types.KeyPhrase

type Rep KeyPhrase = D1 ('MetaData "KeyPhrase" "Amazonka.Comprehend.Types.KeyPhrase" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "KeyPhrase'" '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 "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newKeyPhrase :: KeyPhrase

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 - The zero-based offset from the beginning of the source text to the first character in the key phrase.

$sel:endOffset:KeyPhrase', keyPhrase_endOffset - The zero-based offset from the beginning of the source text to the last character in the key phrase.

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

$sel:text:KeyPhrase', keyPhrase_text - The text of a key noun phrase.

keyPhrase_beginOffset :: Lens' KeyPhrase (Maybe Int)

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

keyPhrase_endOffset :: Lens' KeyPhrase (Maybe Int)

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

keyPhrase_score :: Lens' KeyPhrase (Maybe Double)

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

keyPhrase_text :: Lens' KeyPhrase (Maybe Text)

The text of a key noun phrase.