DetectTargetedSentimentCommand

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ComprehendClient, DetectTargetedSentimentCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
// const { ComprehendClient, DetectTargetedSentimentCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
const client = new ComprehendClient(config);
const input = { // DetectTargetedSentimentRequest
  Text: "STRING_VALUE", // required
  LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
};
const command = new DetectTargetedSentimentCommand(input);
const response = await client.send(command);
// { // DetectTargetedSentimentResponse
//   Entities: [ // ListOfTargetedSentimentEntities
//     { // TargetedSentimentEntity
//       DescriptiveMentionIndex: [ // ListOfDescriptiveMentionIndices
//         Number("int"),
//       ],
//       Mentions: [ // ListOfMentions
//         { // TargetedSentimentMention
//           Score: Number("float"),
//           GroupScore: Number("float"),
//           Text: "STRING_VALUE",
//           Type: "PERSON" || "LOCATION" || "ORGANIZATION" || "FACILITY" || "BRAND" || "COMMERCIAL_ITEM" || "MOVIE" || "MUSIC" || "BOOK" || "SOFTWARE" || "GAME" || "PERSONAL_TITLE" || "EVENT" || "DATE" || "QUANTITY" || "ATTRIBUTE" || "OTHER",
//           MentionSentiment: { // MentionSentiment
//             Sentiment: "POSITIVE" || "NEGATIVE" || "NEUTRAL" || "MIXED",
//             SentimentScore: { // SentimentScore
//               Positive: Number("float"),
//               Negative: Number("float"),
//               Neutral: Number("float"),
//               Mixed: Number("float"),
//             },
//           },
//           BeginOffset: Number("int"),
//           EndOffset: Number("int"),
//         },
//       ],
//     },
//   ],
// };

DetectTargetedSentimentCommand Input

Parameter
Type
Description
LanguageCode
Required
LanguageCode | undefined

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

Text
Required
string | undefined

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

DetectTargetedSentimentCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Entities
TargetedSentimentEntity[] | undefined

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

Throws

Name
Fault
Details
InternalServerException
server

An internal server error occurred. Retry your request.

InvalidRequestException
client

The request is invalid.

TextSizeLimitExceededException
client

The size of the input text exceeds the limit. Use a smaller document.

UnsupportedLanguageException
client

Amazon Comprehend can't process the language of the input text. For a list of supported languages, Supported languages  in the Comprehend Developer Guide.

ComprehendServiceException
Base exception class for all service exceptions from Comprehend service.