amazonka-comprehend-1.6.0: Amazon Comprehend SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Comprehend.DetectKeyPhrases

Contents

Description

Detects the key noun phrases found in the text.

Synopsis

Creating a Request

detectKeyPhrases Source #

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 Source #

See: detectKeyPhrases smart constructor.

Instances

Eq DetectKeyPhrases Source # 
Data DetectKeyPhrases Source # 

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 Source # 
Show DetectKeyPhrases Source # 
Generic DetectKeyPhrases Source # 
Hashable DetectKeyPhrases Source # 
ToJSON DetectKeyPhrases Source # 
NFData DetectKeyPhrases Source # 

Methods

rnf :: DetectKeyPhrases -> () #

AWSRequest DetectKeyPhrases Source # 
ToHeaders DetectKeyPhrases Source # 
ToPath DetectKeyPhrases Source # 
ToQuery DetectKeyPhrases Source # 
type Rep DetectKeyPhrases Source # 
type Rep DetectKeyPhrases = D1 * (MetaData "DetectKeyPhrases" "Network.AWS.Comprehend.DetectKeyPhrases" "amazonka-comprehend-1.6.0-7ky9kDszQAoCEHl21SoVpv" False) (C1 * (MetaCons "DetectKeyPhrases'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dkpText") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_dkpLanguageCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * LanguageCode))))
type Rs DetectKeyPhrases Source # 

Request Lenses

dkpText :: Lens' DetectKeyPhrases Text Source #

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

dkpLanguageCode :: Lens' DetectKeyPhrases LanguageCode Source #

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 Source #

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 Source #

See: detectKeyPhrasesResponse smart constructor.

Instances

Eq DetectKeyPhrasesResponse Source # 
Data DetectKeyPhrasesResponse Source # 

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 Source # 
Show DetectKeyPhrasesResponse Source # 
Generic DetectKeyPhrasesResponse Source # 
NFData DetectKeyPhrasesResponse Source # 
type Rep DetectKeyPhrasesResponse Source # 
type Rep DetectKeyPhrasesResponse = D1 * (MetaData "DetectKeyPhrasesResponse" "Network.AWS.Comprehend.DetectKeyPhrases" "amazonka-comprehend-1.6.0-7ky9kDszQAoCEHl21SoVpv" False) (C1 * (MetaCons "DetectKeyPhrasesResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dkprsKeyPhrases") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [KeyPhrase]))) (S1 * (MetaSel (Just Symbol "_dkprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

dkprsKeyPhrases :: Lens' DetectKeyPhrasesResponse [KeyPhrase] Source #

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.