Batch Detect Targeted Sentiment

comprehend_batch_detect_targeted_sentiment

R Documentation

Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents

Description

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.

Usage

comprehend_batch_detect_targeted_sentiment(TextList, LanguageCode)

Arguments

TextList

[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.

LanguageCode

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

Value

A list with the following syntax:

list(
  ResultList = list(
    list(
      Index = 123,
      Entities = list(
        list(
          DescriptiveMentionIndex = list(
            123
          ),
          Mentions = list(
            list(
              Score = 123.0,
              GroupScore = 123.0,
              Text = "string",
              Type = "PERSON"|"LOCATION"|"ORGANIZATION"|"FACILITY"|"BRAND"|"COMMERCIAL_ITEM"|"MOVIE"|"MUSIC"|"BOOK"|"SOFTWARE"|"GAME"|"PERSONAL_TITLE"|"EVENT"|"DATE"|"QUANTITY"|"ATTRIBUTE"|"OTHER",
              MentionSentiment = list(
                Sentiment = "POSITIVE"|"NEGATIVE"|"NEUTRAL"|"MIXED",
                SentimentScore = list(
                  Positive = 123.0,
                  Negative = 123.0,
                  Neutral = 123.0,
                  Mixed = 123.0
                )
              ),
              BeginOffset = 123,
              EndOffset = 123
            )
          )
        )
      )
    )
  ),
  ErrorList = list(
    list(
      Index = 123,
      ErrorCode = "string",
      ErrorMessage = "string"
    )
  )
)

Request syntax

svc$batch_detect_targeted_sentiment(
  TextList = list(
    "string"
  ),
  LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|"ar"|"hi"|"ja"|"ko"|"zh"|"zh-TW"
)