Network.AWS.Comprehend.BatchDetectKeyPhrases

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

Creating a Request

batchDetectKeyPhrases

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

See: batchDetectKeyPhrases smart constructor.

Instances

Eq BatchDetectKeyPhrases

Methods

(==) :: BatchDetectKeyPhrases -> BatchDetectKeyPhrases -> Bool

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

Data BatchDetectKeyPhrases

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

Methods

readsPrec :: Int -> ReadS BatchDetectKeyPhrases

readList :: ReadS [BatchDetectKeyPhrases]

readPrec :: ReadPrec BatchDetectKeyPhrases

readListPrec :: ReadPrec [BatchDetectKeyPhrases]

Show BatchDetectKeyPhrases

Methods

showsPrec :: Int -> BatchDetectKeyPhrases -> ShowS

show :: BatchDetectKeyPhrases -> String

showList :: [BatchDetectKeyPhrases] -> ShowS

Generic BatchDetectKeyPhrases

Associated Types

type Rep BatchDetectKeyPhrases :: * -> *

Methods

from :: BatchDetectKeyPhrases -> Rep BatchDetectKeyPhrases x

to :: Rep BatchDetectKeyPhrases x -> BatchDetectKeyPhrases

Hashable BatchDetectKeyPhrases

Methods

hashWithSalt :: Int -> BatchDetectKeyPhrases -> Int

hash :: BatchDetectKeyPhrases -> Int

ToJSON BatchDetectKeyPhrases

Methods

toJSON :: BatchDetectKeyPhrases -> Value

toEncoding :: BatchDetectKeyPhrases -> Encoding

toJSONList :: [BatchDetectKeyPhrases] -> Value

toEncodingList :: [BatchDetectKeyPhrases] -> Encoding

NFData BatchDetectKeyPhrases

Methods

rnf :: BatchDetectKeyPhrases -> ()

AWSRequest BatchDetectKeyPhrases

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

Methods

toHeaders :: BatchDetectKeyPhrases -> [Header]

ToPath BatchDetectKeyPhrases

Methods

toPath :: BatchDetectKeyPhrases -> ByteString

ToQuery BatchDetectKeyPhrases

Methods

toQuery :: BatchDetectKeyPhrases -> QueryString

type Rep BatchDetectKeyPhrases

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

type Rs BatchDetectKeyPhrases = BatchDetectKeyPhrasesResponse

Request Lenses

bdkpTextList :: Lens' BatchDetectKeyPhrases [Text]

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

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

Destructuring the Response

batchDetectKeyPhrasesResponse

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

See: batchDetectKeyPhrasesResponse smart constructor.

Instances

Eq BatchDetectKeyPhrasesResponse

Methods

(==) :: BatchDetectKeyPhrasesResponse -> BatchDetectKeyPhrasesResponse -> Bool

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

Data BatchDetectKeyPhrasesResponse

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

Methods

readsPrec :: Int -> ReadS BatchDetectKeyPhrasesResponse

readList :: ReadS [BatchDetectKeyPhrasesResponse]

readPrec :: ReadPrec BatchDetectKeyPhrasesResponse

readListPrec :: ReadPrec [BatchDetectKeyPhrasesResponse]

Show BatchDetectKeyPhrasesResponse

Methods

showsPrec :: Int -> BatchDetectKeyPhrasesResponse -> ShowS

show :: BatchDetectKeyPhrasesResponse -> String

showList :: [BatchDetectKeyPhrasesResponse] -> ShowS

Generic BatchDetectKeyPhrasesResponse

Associated Types

type Rep BatchDetectKeyPhrasesResponse :: * -> *

Methods

from :: BatchDetectKeyPhrasesResponse -> Rep BatchDetectKeyPhrasesResponse x

to :: Rep BatchDetectKeyPhrasesResponse x -> BatchDetectKeyPhrasesResponse

NFData BatchDetectKeyPhrasesResponse

Methods

rnf :: BatchDetectKeyPhrasesResponse -> ()

type Rep BatchDetectKeyPhrasesResponse

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

• - | The response status code.

bdkprsResultList :: Lens' BatchDetectKeyPhrasesResponse [BatchDetectKeyPhrasesItemResult]

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]

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.