Class: Aws::Comprehend::Types::TargetedSentimentMention

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-comprehend/types.rb

Overview

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

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#begin_offsetInteger

The offset into the document text where the mention begins.

Returns:

  • (Integer)


8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
# File 'lib/aws-sdk-comprehend/types.rb', line 8424

class TargetedSentimentMention < Struct.new(
  :score,
  :group_score,
  :text,
  :type,
  :mention_sentiment,
  :begin_offset,
  :end_offset)
  SENSITIVE = []
  include Aws::Structure
end

#end_offsetInteger

The offset into the document text where the mention ends.

Returns:

  • (Integer)


8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
# File 'lib/aws-sdk-comprehend/types.rb', line 8424

class TargetedSentimentMention < Struct.new(
  :score,
  :group_score,
  :text,
  :type,
  :mention_sentiment,
  :begin_offset,
  :end_offset)
  SENSITIVE = []
  include Aws::Structure
end

#group_scoreFloat

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

Returns:

  • (Float)


8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
# File 'lib/aws-sdk-comprehend/types.rb', line 8424

class TargetedSentimentMention < Struct.new(
  :score,
  :group_score,
  :text,
  :type,
  :mention_sentiment,
  :begin_offset,
  :end_offset)
  SENSITIVE = []
  include Aws::Structure
end

#mention_sentimentTypes::MentionSentiment

Contains the sentiment and sentiment score for the mention.



8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
# File 'lib/aws-sdk-comprehend/types.rb', line 8424

class TargetedSentimentMention < Struct.new(
  :score,
  :group_score,
  :text,
  :type,
  :mention_sentiment,
  :begin_offset,
  :end_offset)
  SENSITIVE = []
  include Aws::Structure
end

#scoreFloat

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

Returns:

  • (Float)


8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
# File 'lib/aws-sdk-comprehend/types.rb', line 8424

class TargetedSentimentMention < Struct.new(
  :score,
  :group_score,
  :text,
  :type,
  :mention_sentiment,
  :begin_offset,
  :end_offset)
  SENSITIVE = []
  include Aws::Structure
end

#textString

The text in the document that identifies the entity.

Returns:

  • (String)


8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
# File 'lib/aws-sdk-comprehend/types.rb', line 8424

class TargetedSentimentMention < Struct.new(
  :score,
  :group_score,
  :text,
  :type,
  :mention_sentiment,
  :begin_offset,
  :end_offset)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

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

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-entities

Returns:

  • (String)


8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
# File 'lib/aws-sdk-comprehend/types.rb', line 8424

class TargetedSentimentMention < Struct.new(
  :score,
  :group_score,
  :text,
  :type,
  :mention_sentiment,
  :begin_offset,
  :end_offset)
  SENSITIVE = []
  include Aws::Structure
end