Comprehend / Client / batch_detect_targeted_sentiment

batch_detect_targeted_sentiment#

Comprehend.Client.batch_detect_targeted_sentiment(**kwargs)#

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 in the Amazon Comprehend Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.batch_detect_targeted_sentiment(
    TextList=[
        'string',
    ],
    LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
)
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. The maximum size of each document is 5 KB.

    • (string) –

  • LanguageCode (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ResultList': [
        {
            'Index': 123,
            'Entities': [
                {
                    'DescriptiveMentionIndex': [
                        123,
                    ],
                    'Mentions': [
                        {
                            'Score': ...,
                            'GroupScore': ...,
                            'Text': 'string',
                            'Type': 'PERSON'|'LOCATION'|'ORGANIZATION'|'FACILITY'|'BRAND'|'COMMERCIAL_ITEM'|'MOVIE'|'MUSIC'|'BOOK'|'SOFTWARE'|'GAME'|'PERSONAL_TITLE'|'EVENT'|'DATE'|'QUANTITY'|'ATTRIBUTE'|'OTHER',
                            'MentionSentiment': {
                                'Sentiment': 'POSITIVE'|'NEGATIVE'|'NEUTRAL'|'MIXED',
                                'SentimentScore': {
                                    'Positive': ...,
                                    'Negative': ...,
                                    'Neutral': ...,
                                    'Mixed': ...
                                }
                            },
                            'BeginOffset': 123,
                            'EndOffset': 123
                        },
                    ]
                },
            ]
        },
    ],
    '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) –

        Analysis results for one of the documents in the batch.

        • Index (integer) –

          The zero-based index of this result in the input list.

        • Entities (list) –

          An array of targeted sentiment entities.

          • (dict) –

            Information about one of the entities found by targeted sentiment analysis.

            For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

            • DescriptiveMentionIndex (list) –

              One or more index into the Mentions array that provides the best name for the entity group.

              • (integer) –

            • Mentions (list) –

              An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.

              • (dict) –

                Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.

                For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.

                • Score (float) –

                  Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.

                • GroupScore (float) –

                  The confidence that all the entities mentioned in the group relate to the same entity.

                • Text (string) –

                  The text in the document that identifies the entity.

                • Type (string) –

                  The type of the entity. Amazon Comprehend supports a variety of entity types.

                • MentionSentiment (dict) –

                  Contains the sentiment and sentiment score for the mention.

                  • Sentiment (string) –

                    The sentiment of the mention.

                  • SentimentScore (dict) –

                    Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

                    • Positive (float) –

                      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.

                    • Negative (float) –

                      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.

                    • Neutral (float) –

                      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.

                    • Mixed (float) –

                      The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.

                • BeginOffset (integer) –

                  The offset into the document text where the mention begins.

                • EndOffset (integer) –

                  The offset into the document text where the mention ends.

    • ErrorList (list) –

      List of errors that the operation can return.

      • (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