Copyright	(c) 2013-2021 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

Amazonka.Comprehend.BatchDetectSyntax

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see how-syntax.

Creating a Request

data BatchDetectSyntax Source #

See: newBatchDetectSyntax smart constructor.

Constructors

BatchDetectSyntax'

Fields

textList :: Sensitive [Sensitive 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.
languageCode :: SyntaxLanguageCode
The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

Instances

Instances details

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

newBatchDetectSyntax Source #

Arguments

:: SyntaxLanguageCode	`$sel:languageCode:BatchDetectSyntax'`
-> BatchDetectSyntax

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

$sel:languageCode:BatchDetectSyntax', batchDetectSyntax_languageCode - The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

Request Lenses

batchDetectSyntax_textList :: Lens' BatchDetectSyntax [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.

batchDetectSyntax_languageCode :: Lens' BatchDetectSyntax SyntaxLanguageCode Source #

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

Destructuring the Response

data BatchDetectSyntaxResponse Source #

See: newBatchDetectSyntaxResponse smart constructor.

Constructors

BatchDetectSyntaxResponse'

Fields

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

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

newBatchDetectSyntaxResponse Source #

Arguments

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

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

$sel:resultList:BatchDetectSyntaxResponse', batchDetectSyntaxResponse_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:BatchDetectSyntaxResponse', batchDetectSyntaxResponse_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

batchDetectSyntaxResponse_httpStatus :: Lens' BatchDetectSyntaxResponse Int Source #

The response's http status code.

batchDetectSyntaxResponse_resultList :: Lens' BatchDetectSyntaxResponse [BatchDetectSyntaxItemResult] 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.

batchDetectSyntaxResponse_errorList :: Lens' BatchDetectSyntaxResponse [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.