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.BatchDetectEntities

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Inspects the text of a batch of documents and returns information about them. For more information about entities, see 'how-entities'

Creating a Request

batchDetectEntities Source #

Arguments

:: Text	`bdeLanguageCode`
-> BatchDetectEntities

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

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

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

data BatchDetectEntities Source #

See: batchDetectEntities smart constructor.

Instances

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

Request Lenses

bdeTextList :: Lens' BatchDetectEntities [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 than 5,000 bytes of UTF-8 encoded characters.

bdeLanguageCode :: Lens' BatchDetectEntities Text Source #

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

Destructuring the Response

batchDetectEntitiesResponse Source #

Arguments

:: Int	`bdersResponseStatus`
-> BatchDetectEntitiesResponse

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

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

bdersResponseStatus - -- | The response status code.
bdersResultList - 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.
bdersErrorList - 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 BatchDetectEntitiesResponse Source #

See: batchDetectEntitiesResponse smart constructor.

Instances

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

Response Lenses

bdersResponseStatus :: Lens' BatchDetectEntitiesResponse Int Source #

- | The response status code.

bdersResultList :: Lens' BatchDetectEntitiesResponse [BatchDetectEntitiesItemResult] 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.

bdersErrorList :: Lens' BatchDetectEntitiesResponse [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.