Comprehend / Client / batch_detect_dominant_language

batch_detect_dominant_language#

Comprehend.Client.batch_detect_dominant_language(**kwargs)#

Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

Request Syntax

response = client.batch_detect_dominant_language(
    TextList=[
        'string',
    ]
)

Parameters:

TextList (list) –

[REQUIRED]

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

(string) –

Return type:

dict

Returns:

Response Syntax

{
    'ResultList': [
        {
            'Index': 123,
            'Languages': [
                {
                    'LanguageCode': 'string',
                    'Score': ...
                },
            ]
        },
    ],
    'ErrorList': [
        {
            'Index': 123,
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) –
- ResultList (list) –
  
  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.
  - (dict) –
    
    The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
    - Index (integer) –
      
      The zero-based index of the document in the input list.
    - Languages (list) –
      
      One or more DominantLanguage objects describing the dominant languages in the document.
      - (dict) –
        
        Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.
        
        LanguageCode (string) –
        
        The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
        
        Score (float) –
        
        The level of confidence that Amazon Comprehend has in the accuracy of the detection.
- ErrorList (list) –
  
  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.
  - (dict) –
    
    Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.
    - Index (integer) –
      
      The zero-based index of the document in the input list.
    - ErrorCode (string) –
      
      The numeric error code of the error.
    - ErrorMessage (string) –
      
      A text description of the error.

Exceptions

Comprehend.Client.exceptions.InvalidRequestException
Comprehend.Client.exceptions.TextSizeLimitExceededException
Comprehend.Client.exceptions.BatchSizeLimitExceededException
Comprehend.Client.exceptions.InternalServerException