Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . comprehend ]

batch-detect-targeted-sentiment

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 .

See also: AWS API Documentation

Synopsis

  batch-detect-targeted-sentiment
--text-list <value>
--language-code <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--text-list (list)

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)

Syntax:

"string" "string" ...

--language-code (string)

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

Possible values:

  • en
  • es
  • fr
  • de
  • it
  • pt
  • ar
  • hi
  • ja
  • ko
  • zh
  • zh-TW

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

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.

(structure)

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.

(structure)

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

For more information about targeted sentiment, see Targeted sentiment .

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.

(structure)

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 .

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 -> (structure)

Contains the sentiment and sentiment score for the mention.

Sentiment -> (string)

The sentiment of the mention.

SentimentScore -> (structure)

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.

(structure)

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.