Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Comprehend.BatchDetectEntities

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.

Synopsis

Creating a Request

data BatchDetectEntities Source #

See: newBatchDetectEntities smart constructor.

Constructors

BatchDetectEntities'
Fields textList :: Sensitive (NonEmpty (Sensitive Text)) A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB. languageCode :: LanguageCode The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Instances

Instances details

ToJSON BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Methods toJSON :: BatchDetectEntities -> Value # toEncoding :: BatchDetectEntities -> Encoding # toJSONList :: [BatchDetectEntities] -> Value # toEncodingList :: [BatchDetectEntities] -> Encoding #
ToHeaders BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Methods toHeaders :: BatchDetectEntities -> [Header] #
ToPath BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Methods toPath :: BatchDetectEntities -> ByteString #
ToQuery BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Methods toQuery :: BatchDetectEntities -> QueryString #
AWSRequest BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Associated Types type AWSResponse BatchDetectEntities # Methods request :: (Service -> Service) -> BatchDetectEntities -> Request BatchDetectEntities # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy BatchDetectEntities -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchDetectEntities))) #
Generic BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Associated Types type Rep BatchDetectEntities :: Type -> Type # Methods from :: BatchDetectEntities -> Rep BatchDetectEntities x # to :: Rep BatchDetectEntities x -> BatchDetectEntities #
Show BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Methods showsPrec :: Int -> BatchDetectEntities -> ShowS # show :: BatchDetectEntities -> String # showList :: [BatchDetectEntities] -> ShowS #
NFData BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Methods rnf :: BatchDetectEntities -> () #
Eq BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Methods (==) :: BatchDetectEntities -> BatchDetectEntities -> Bool # (/=) :: BatchDetectEntities -> BatchDetectEntities -> Bool #
Hashable BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Methods hashWithSalt :: Int -> BatchDetectEntities -> Int # hash :: BatchDetectEntities -> Int #
type AWSResponse BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities type AWSResponse BatchDetectEntities = BatchDetectEntitiesResponse
type Rep BatchDetectEntities Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities type Rep BatchDetectEntities = D1 ('MetaData "BatchDetectEntities" "Amazonka.Comprehend.BatchDetectEntities" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "BatchDetectEntities'" 'PrefixI 'True) (S1 ('MetaSel ('Just "textList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive (NonEmpty (Sensitive Text)))) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))

newBatchDetectEntities Source #

Arguments

:: NonEmpty Text	`$sel:textList:BatchDetectEntities'`
-> LanguageCode	`BatchDetectEntities`
-> BatchDetectEntities

Create a value of BatchDetectEntities with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:textList:BatchDetectEntities', batchDetectEntities_textList - A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

BatchDetectEntities, batchDetectEntities_languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Request Lenses

batchDetectEntities_textList :: Lens' BatchDetectEntities (NonEmpty Text) Source #

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

batchDetectEntities_languageCode :: Lens' BatchDetectEntities LanguageCode Source #

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Destructuring the Response

data BatchDetectEntitiesResponse Source #

See: newBatchDetectEntitiesResponse smart constructor.

Constructors

BatchDetectEntitiesResponse'

Fields

httpStatus :: Int
The response's http status code.
resultList :: [BatchDetectEntitiesItemResult]
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.
errorList :: [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.

Instances

Instances details

Generic BatchDetectEntitiesResponse Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Associated Types type Rep BatchDetectEntitiesResponse :: Type -> Type # Methods from :: BatchDetectEntitiesResponse -> Rep BatchDetectEntitiesResponse x # to :: Rep BatchDetectEntitiesResponse x -> BatchDetectEntitiesResponse #
Show BatchDetectEntitiesResponse Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Methods showsPrec :: Int -> BatchDetectEntitiesResponse -> ShowS # show :: BatchDetectEntitiesResponse -> String # showList :: [BatchDetectEntitiesResponse] -> ShowS #
NFData BatchDetectEntitiesResponse Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Methods rnf :: BatchDetectEntitiesResponse -> () #
Eq BatchDetectEntitiesResponse Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities Methods (==) :: BatchDetectEntitiesResponse -> BatchDetectEntitiesResponse -> Bool # (/=) :: BatchDetectEntitiesResponse -> BatchDetectEntitiesResponse -> Bool #
type Rep BatchDetectEntitiesResponse Source #
Instance details Defined in Amazonka.Comprehend.BatchDetectEntities type Rep BatchDetectEntitiesResponse = D1 ('MetaData "BatchDetectEntitiesResponse" "Amazonka.Comprehend.BatchDetectEntities" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "BatchDetectEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "resultList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchDetectEntitiesItemResult]) :: S1 ('MetaSel ('Just "errorList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchItemError]))))

newBatchDetectEntitiesResponse Source #

Arguments

:: Int	`$sel:httpStatus:BatchDetectEntitiesResponse'`
-> BatchDetectEntitiesResponse

Create a value of BatchDetectEntitiesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:BatchDetectEntitiesResponse', batchDetectEntitiesResponse_httpStatus - The response's http status code.

$sel:resultList:BatchDetectEntitiesResponse', batchDetectEntitiesResponse_resultList - 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.

$sel:errorList:BatchDetectEntitiesResponse', batchDetectEntitiesResponse_errorList - 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.

Response Lenses

batchDetectEntitiesResponse_httpStatus :: Lens' BatchDetectEntitiesResponse Int Source #

The response's http status code.

batchDetectEntitiesResponse_resultList :: 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.

batchDetectEntitiesResponse_errorList :: 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.