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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.

For more information about targeted sentiment, see Targeted sentiment.

Synopsis

Creating a Request

data BatchDetectTargetedSentiment Source #

See: newBatchDetectTargetedSentiment smart constructor.

Constructors

BatchDetectTargetedSentiment'
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. Currently, English is the only supported language.

Instances

Instances details

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

newBatchDetectTargetedSentiment Source #

Arguments

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

Create a value of BatchDetectTargetedSentiment 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:BatchDetectTargetedSentiment', batchDetectTargetedSentiment_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.

BatchDetectTargetedSentiment, batchDetectTargetedSentiment_languageCode - The language of the input documents. Currently, English is the only supported language.

Request Lenses

batchDetectTargetedSentiment_textList :: Lens' BatchDetectTargetedSentiment (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.

batchDetectTargetedSentiment_languageCode :: Lens' BatchDetectTargetedSentiment LanguageCode Source #

The language of the input documents. Currently, English is the only supported language.

Destructuring the Response

data BatchDetectTargetedSentimentResponse Source #

See: newBatchDetectTargetedSentimentResponse smart constructor.

Constructors

BatchDetectTargetedSentimentResponse'

Fields

httpStatus :: Int
The response's http status code.
resultList :: [BatchDetectTargetedSentimentItemResult]
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]
List of errors that the operation can return.

Instances

Instances details

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

newBatchDetectTargetedSentimentResponse Source #

Arguments

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

Create a value of BatchDetectTargetedSentimentResponse 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:BatchDetectTargetedSentimentResponse', batchDetectTargetedSentimentResponse_httpStatus - The response's http status code.

$sel:resultList:BatchDetectTargetedSentimentResponse', batchDetectTargetedSentimentResponse_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:BatchDetectTargetedSentimentResponse', batchDetectTargetedSentimentResponse_errorList - List of errors that the operation can return.

Response Lenses

batchDetectTargetedSentimentResponse_httpStatus :: Lens' BatchDetectTargetedSentimentResponse Int Source #

The response's http status code.

batchDetectTargetedSentimentResponse_resultList :: Lens' BatchDetectTargetedSentimentResponse [BatchDetectTargetedSentimentItemResult] 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.

batchDetectTargetedSentimentResponse_errorList :: Lens' BatchDetectTargetedSentimentResponse [BatchItemError] Source #

List of errors that the operation can return.