Network.AWS.Comprehend.DetectKeyPhrases

Detects the key noun phrases found in the text.

Creating a Request

detectKeyPhrases

Arguments

:: Text

dkpText

-> LanguageCode

dkpLanguageCode

-> DetectKeyPhrases

Creates a value of DetectKeyPhrases with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dkpText - A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
• dkpLanguageCode - The RFC 5646 language code for the input text. If you don't specify a language code, Amazon Comprehend detects the dominant language. If you specify the code for a language that Amazon Comprehend does not support, it returns and UnsupportedLanguageException . For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

data DetectKeyPhrases

See: detectKeyPhrases smart constructor.

Instances

Eq DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

(==) :: DetectKeyPhrases -> DetectKeyPhrases -> Bool

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

Data DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DetectKeyPhrases -> c DetectKeyPhrases

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DetectKeyPhrases

toConstr :: DetectKeyPhrases -> Constr

dataTypeOf :: DetectKeyPhrases -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DetectKeyPhrases)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DetectKeyPhrases)

gmapT :: (forall b. Data b => b -> b) -> DetectKeyPhrases -> DetectKeyPhrases

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DetectKeyPhrases -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DetectKeyPhrases -> r

gmapQ :: (forall d. Data d => d -> u) -> DetectKeyPhrases -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DetectKeyPhrases -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DetectKeyPhrases -> m DetectKeyPhrases

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectKeyPhrases -> m DetectKeyPhrases

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectKeyPhrases -> m DetectKeyPhrases

Read DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

readsPrec :: Int -> ReadS DetectKeyPhrases

readList :: ReadS [DetectKeyPhrases]

readPrec :: ReadPrec DetectKeyPhrases

readListPrec :: ReadPrec [DetectKeyPhrases]

Show DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

showsPrec :: Int -> DetectKeyPhrases -> ShowS

show :: DetectKeyPhrases -> String

showList :: [DetectKeyPhrases] -> ShowS

Generic DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Associated Types

type Rep DetectKeyPhrases :: Type -> Type

Methods

from :: DetectKeyPhrases -> Rep DetectKeyPhrases x

to :: Rep DetectKeyPhrases x -> DetectKeyPhrases

Hashable DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

hashWithSalt :: Int -> DetectKeyPhrases -> Int

hash :: DetectKeyPhrases -> Int

ToJSON DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

toJSON :: DetectKeyPhrases -> Value

toEncoding :: DetectKeyPhrases -> Encoding

toJSONList :: [DetectKeyPhrases] -> Value

toEncodingList :: [DetectKeyPhrases] -> Encoding

AWSRequest DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Associated Types

type Rs DetectKeyPhrases :: Type

Methods

request :: DetectKeyPhrases -> Request DetectKeyPhrases

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DetectKeyPhrases -> ClientResponse -> m (Response DetectKeyPhrases)

ToHeaders DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

toHeaders :: DetectKeyPhrases -> [Header]

ToPath DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

toPath :: DetectKeyPhrases -> ByteString

ToQuery DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

toQuery :: DetectKeyPhrases -> QueryString

NFData DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

rnf :: DetectKeyPhrases -> ()

type Rep DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

type Rep DetectKeyPhrases = D1 (MetaData "DetectKeyPhrases" "Network.AWS.Comprehend.DetectKeyPhrases" "amazonka-comprehend-1.6.1-JmZRhcK5vJN1rBy4HW0MWx" False) (C1 (MetaCons "DetectKeyPhrases'" PrefixI True) (S1 (MetaSel (Just "_dkpText") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_dkpLanguageCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LanguageCode)))

type Rs DetectKeyPhrases

Defined in Network.AWS.Comprehend.DetectKeyPhrases

type Rs DetectKeyPhrases = DetectKeyPhrasesResponse

Request Lenses

dkpText :: Lens' DetectKeyPhrases Text

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

dkpLanguageCode :: Lens' DetectKeyPhrases LanguageCode

The RFC 5646 language code for the input text. If you don't specify a language code, Amazon Comprehend detects the dominant language. If you specify the code for a language that Amazon Comprehend does not support, it returns and UnsupportedLanguageException . For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

Destructuring the Response

detectKeyPhrasesResponse

Arguments

:: Int

dkprsResponseStatus

-> DetectKeyPhrasesResponse

Creates a value of DetectKeyPhrasesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dkprsKeyPhrases - A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.
• dkprsResponseStatus - -- | The response status code.

data DetectKeyPhrasesResponse

See: detectKeyPhrasesResponse smart constructor.

Instances

Eq DetectKeyPhrasesResponse

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

(==) :: DetectKeyPhrasesResponse -> DetectKeyPhrasesResponse -> Bool

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

Data DetectKeyPhrasesResponse

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DetectKeyPhrasesResponse -> c DetectKeyPhrasesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DetectKeyPhrasesResponse

toConstr :: DetectKeyPhrasesResponse -> Constr

dataTypeOf :: DetectKeyPhrasesResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DetectKeyPhrasesResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DetectKeyPhrasesResponse)

gmapT :: (forall b. Data b => b -> b) -> DetectKeyPhrasesResponse -> DetectKeyPhrasesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DetectKeyPhrasesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DetectKeyPhrasesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DetectKeyPhrasesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DetectKeyPhrasesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DetectKeyPhrasesResponse -> m DetectKeyPhrasesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectKeyPhrasesResponse -> m DetectKeyPhrasesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectKeyPhrasesResponse -> m DetectKeyPhrasesResponse

Read DetectKeyPhrasesResponse

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

readsPrec :: Int -> ReadS DetectKeyPhrasesResponse

readList :: ReadS [DetectKeyPhrasesResponse]

readPrec :: ReadPrec DetectKeyPhrasesResponse

readListPrec :: ReadPrec [DetectKeyPhrasesResponse]

Show DetectKeyPhrasesResponse

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

showsPrec :: Int -> DetectKeyPhrasesResponse -> ShowS

show :: DetectKeyPhrasesResponse -> String

showList :: [DetectKeyPhrasesResponse] -> ShowS

Generic DetectKeyPhrasesResponse

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Associated Types

type Rep DetectKeyPhrasesResponse :: Type -> Type

Methods

from :: DetectKeyPhrasesResponse -> Rep DetectKeyPhrasesResponse x

to :: Rep DetectKeyPhrasesResponse x -> DetectKeyPhrasesResponse

NFData DetectKeyPhrasesResponse

Defined in Network.AWS.Comprehend.DetectKeyPhrases

Methods

rnf :: DetectKeyPhrasesResponse -> ()

type Rep DetectKeyPhrasesResponse

Defined in Network.AWS.Comprehend.DetectKeyPhrases

type Rep DetectKeyPhrasesResponse = D1 (MetaData "DetectKeyPhrasesResponse" "Network.AWS.Comprehend.DetectKeyPhrases" "amazonka-comprehend-1.6.1-JmZRhcK5vJN1rBy4HW0MWx" False) (C1 (MetaCons "DetectKeyPhrasesResponse'" PrefixI True) (S1 (MetaSel (Just "_dkprsKeyPhrases") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [KeyPhrase])) :*: S1 (MetaSel (Just "_dkprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

dkprsKeyPhrases :: Lens' DetectKeyPhrasesResponse [KeyPhrase]

A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

dkprsResponseStatus :: Lens' DetectKeyPhrasesResponse Int

• - | The response status code.