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 |
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.
Synopsis
- data BatchDetectSyntax = BatchDetectSyntax' {}
- newBatchDetectSyntax :: SyntaxLanguageCode -> BatchDetectSyntax
- batchDetectSyntax_textList :: Lens' BatchDetectSyntax [Text]
- batchDetectSyntax_languageCode :: Lens' BatchDetectSyntax SyntaxLanguageCode
- data BatchDetectSyntaxResponse = BatchDetectSyntaxResponse' {}
- newBatchDetectSyntaxResponse :: Int -> BatchDetectSyntaxResponse
- batchDetectSyntaxResponse_httpStatus :: Lens' BatchDetectSyntaxResponse Int
- batchDetectSyntaxResponse_resultList :: Lens' BatchDetectSyntaxResponse [BatchDetectSyntaxItemResult]
- batchDetectSyntaxResponse_errorList :: Lens' BatchDetectSyntaxResponse [BatchItemError]
Creating a Request
data BatchDetectSyntax Source #
See: newBatchDetectSyntax
smart constructor.
BatchDetectSyntax' | |
|
Instances
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.
BatchDetectSyntaxResponse' | |
|
Instances
newBatchDetectSyntaxResponse Source #
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.