Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DetectTargetedSentiment

Inspects the input text and returns a sentiment analysis for each entity identified in the text.

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

Request Syntax


{
   "LanguageCode": "string",
   "Text": "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. Currently, English is the only supported language.

Type: String

Valid Values: en

Required: Yes

Text

A UTF-8 text string. The maximum string length is 5 KB.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax


{
   "Entities": [ 
      { 
         "DescriptiveMentionIndex": [ number ],
         "Mentions": [ 
            { 
               "BeginOffset": number,
               "EndOffset": number,
               "GroupScore": number,
               "MentionSentiment": { 
                  "Sentiment": "string",
                  "SentimentScore": { 
                     "Mixed": number,
                     "Negative": number,
                     "Neutral": number,
                     "Positive": number
                  }
               },
               "Score": number,
               "Text": "string",
               "Type": "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.

Entities

Targeted sentiment analysis for each of the entities identified in the input text.

Type: Array of TargetedSentimentEntity objects

Errors

For information about the errors that are common to all actions, see Common Errors.

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