Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.Comprehend.BatchDetectKeyPhrases

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Detects the key noun phrases found in a batch of documents.

Creating a Request

batchDetectKeyPhrases Source #

Arguments

:: Text	`bdkpLanguageCode`
-> BatchDetectKeyPhrases

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

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

bdkpTextList - A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
bdkpLanguageCode - The language of the input documents. All documents must be in the same language.

data BatchDetectKeyPhrases Source #

See: batchDetectKeyPhrases smart constructor.

Instances

Eq BatchDetectKeyPhrases Source #
Methods (==) :: BatchDetectKeyPhrases -> BatchDetectKeyPhrases -> Bool # (/=) :: BatchDetectKeyPhrases -> BatchDetectKeyPhrases -> Bool #
Data BatchDetectKeyPhrases Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BatchDetectKeyPhrases -> c BatchDetectKeyPhrases # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BatchDetectKeyPhrases # toConstr :: BatchDetectKeyPhrases -> Constr # dataTypeOf :: BatchDetectKeyPhrases -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c BatchDetectKeyPhrases) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BatchDetectKeyPhrases) # gmapT :: (forall b. Data b => b -> b) -> BatchDetectKeyPhrases -> BatchDetectKeyPhrases # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BatchDetectKeyPhrases -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BatchDetectKeyPhrases -> r # gmapQ :: (forall d. Data d => d -> u) -> BatchDetectKeyPhrases -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BatchDetectKeyPhrases -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BatchDetectKeyPhrases -> m BatchDetectKeyPhrases # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BatchDetectKeyPhrases -> m BatchDetectKeyPhrases # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BatchDetectKeyPhrases -> m BatchDetectKeyPhrases #
Read BatchDetectKeyPhrases Source #
Methods readsPrec :: Int -> ReadS BatchDetectKeyPhrases # readList :: ReadS [BatchDetectKeyPhrases] # readPrec :: ReadPrec BatchDetectKeyPhrases # readListPrec :: ReadPrec [BatchDetectKeyPhrases] #
Show BatchDetectKeyPhrases Source #
Methods showsPrec :: Int -> BatchDetectKeyPhrases -> ShowS # show :: BatchDetectKeyPhrases -> String # showList :: [BatchDetectKeyPhrases] -> ShowS #
Generic BatchDetectKeyPhrases Source #
Associated Types type Rep BatchDetectKeyPhrases :: * -> * # Methods from :: BatchDetectKeyPhrases -> Rep BatchDetectKeyPhrases x # to :: Rep BatchDetectKeyPhrases x -> BatchDetectKeyPhrases #
Hashable BatchDetectKeyPhrases Source #
Methods hashWithSalt :: Int -> BatchDetectKeyPhrases -> Int # hash :: BatchDetectKeyPhrases -> Int #
ToJSON BatchDetectKeyPhrases Source #
Methods toJSON :: BatchDetectKeyPhrases -> Value # toEncoding :: BatchDetectKeyPhrases -> Encoding # toJSONList :: [BatchDetectKeyPhrases] -> Value # toEncodingList :: [BatchDetectKeyPhrases] -> Encoding #
NFData BatchDetectKeyPhrases Source #
Methods rnf :: BatchDetectKeyPhrases -> () #
AWSRequest BatchDetectKeyPhrases Source #
Associated Types type Rs BatchDetectKeyPhrases :: * # Methods request :: BatchDetectKeyPhrases -> Request BatchDetectKeyPhrases # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * BatchDetectKeyPhrases -> ClientResponse -> m (Response BatchDetectKeyPhrases) #
ToHeaders BatchDetectKeyPhrases Source #
Methods toHeaders :: BatchDetectKeyPhrases -> [Header] #
ToPath BatchDetectKeyPhrases Source #
Methods toPath :: BatchDetectKeyPhrases -> ByteString #
ToQuery BatchDetectKeyPhrases Source #
Methods toQuery :: BatchDetectKeyPhrases -> QueryString #
type Rep BatchDetectKeyPhrases Source #
type Rep BatchDetectKeyPhrases = D1 * (MetaData "BatchDetectKeyPhrases" "Network.AWS.Comprehend.BatchDetectKeyPhrases" "amazonka-comprehend-1.6.0-7ky9kDszQAoCEHl21SoVpv" False) (C1 * (MetaCons "BatchDetectKeyPhrases'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_bdkpTextList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Text])) (S1 * (MetaSel (Just Symbol "_bdkpLanguageCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))
type Rs BatchDetectKeyPhrases Source #
type Rs BatchDetectKeyPhrases = BatchDetectKeyPhrasesResponse

Request Lenses

bdkpTextList :: Lens' BatchDetectKeyPhrases [Text] Source #

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

bdkpLanguageCode :: Lens' BatchDetectKeyPhrases Text Source #

The language of the input documents. All documents must be in the same language.

Destructuring the Response

batchDetectKeyPhrasesResponse Source #

Arguments

:: Int	`bdkprsResponseStatus`
-> BatchDetectKeyPhrasesResponse

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

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

bdkprsResponseStatus - -- | The response status code.
bdkprsResultList - A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
bdkprsErrorList - A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

data BatchDetectKeyPhrasesResponse Source #

See: batchDetectKeyPhrasesResponse smart constructor.

Instances

Eq BatchDetectKeyPhrasesResponse Source #
Methods (==) :: BatchDetectKeyPhrasesResponse -> BatchDetectKeyPhrasesResponse -> Bool # (/=) :: BatchDetectKeyPhrasesResponse -> BatchDetectKeyPhrasesResponse -> Bool #
Data BatchDetectKeyPhrasesResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BatchDetectKeyPhrasesResponse -> c BatchDetectKeyPhrasesResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BatchDetectKeyPhrasesResponse # toConstr :: BatchDetectKeyPhrasesResponse -> Constr # dataTypeOf :: BatchDetectKeyPhrasesResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c BatchDetectKeyPhrasesResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BatchDetectKeyPhrasesResponse) # gmapT :: (forall b. Data b => b -> b) -> BatchDetectKeyPhrasesResponse -> BatchDetectKeyPhrasesResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BatchDetectKeyPhrasesResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BatchDetectKeyPhrasesResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> BatchDetectKeyPhrasesResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BatchDetectKeyPhrasesResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BatchDetectKeyPhrasesResponse -> m BatchDetectKeyPhrasesResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BatchDetectKeyPhrasesResponse -> m BatchDetectKeyPhrasesResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BatchDetectKeyPhrasesResponse -> m BatchDetectKeyPhrasesResponse #
Read BatchDetectKeyPhrasesResponse Source #
Methods readsPrec :: Int -> ReadS BatchDetectKeyPhrasesResponse # readList :: ReadS [BatchDetectKeyPhrasesResponse] # readPrec :: ReadPrec BatchDetectKeyPhrasesResponse # readListPrec :: ReadPrec [BatchDetectKeyPhrasesResponse] #
Show BatchDetectKeyPhrasesResponse Source #
Methods showsPrec :: Int -> BatchDetectKeyPhrasesResponse -> ShowS # show :: BatchDetectKeyPhrasesResponse -> String # showList :: [BatchDetectKeyPhrasesResponse] -> ShowS #
Generic BatchDetectKeyPhrasesResponse Source #
Associated Types type Rep BatchDetectKeyPhrasesResponse :: * -> * # Methods from :: BatchDetectKeyPhrasesResponse -> Rep BatchDetectKeyPhrasesResponse x # to :: Rep BatchDetectKeyPhrasesResponse x -> BatchDetectKeyPhrasesResponse #
NFData BatchDetectKeyPhrasesResponse Source #
Methods rnf :: BatchDetectKeyPhrasesResponse -> () #
type Rep BatchDetectKeyPhrasesResponse Source #
type Rep BatchDetectKeyPhrasesResponse = D1 * (MetaData "BatchDetectKeyPhrasesResponse" "Network.AWS.Comprehend.BatchDetectKeyPhrases" "amazonka-comprehend-1.6.0-7ky9kDszQAoCEHl21SoVpv" False) (C1 * (MetaCons "BatchDetectKeyPhrasesResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_bdkprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) ((::) (S1 * (MetaSel (Just Symbol "_bdkprsResultList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [BatchDetectKeyPhrasesItemResult])) (S1 * (MetaSel (Just Symbol "_bdkprsErrorList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [BatchItemError])))))

Response Lenses

bdkprsResponseStatus :: Lens' BatchDetectKeyPhrasesResponse Int Source #

- | The response status code.

bdkprsResultList :: Lens' BatchDetectKeyPhrasesResponse [BatchDetectKeyPhrasesItemResult] Source #

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

bdkprsErrorList :: Lens' BatchDetectKeyPhrasesResponse [BatchItemError] Source #

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.