BatchDetectKeyPhrases
Detects the key noun phrases found in a batch of documents.
Request Syntax
{
"LanguageCode": "string
",
"TextList": [ "string
" ]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- 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.
Type: String
Valid Values:
en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW
Required: Yes
- 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.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1.
Required: Yes
Response Syntax
{
"ErrorList": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"Index": number
}
],
"ResultList": [
{
"Index": number,
"KeyPhrases": [
{
"BeginOffset": number,
"EndOffset": number,
"Score": number,
"Text": "string"
}
]
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ErrorList
-
A list containing one BatchItemError 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, theErrorList
is empty.Type: Array of BatchItemError objects
- ResultList
-
A list of BatchDetectKeyPhrasesItemResult 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, theResultList
is empty.Type: Array of BatchDetectKeyPhrasesItemResult objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- BatchSizeLimitExceededException
-
The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
HTTP Status Code: 400
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- InvalidRequestException
-
The request is invalid.
HTTP Status Code: 400
- TextSizeLimitExceededException
-
The size of the input text exceeds the limit. Use a smaller document.
HTTP Status Code: 400
- UnsupportedLanguageException
-
Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages in the Comprehend Developer Guide.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: