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

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::TargetedSentimentMention

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #begin_offset ⇒ Integer

  The offset into the document text where the mention begins.

• #end_offset ⇒ Integer

  The offset into the document text where the mention ends.

• #group_score ⇒ Float

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

• #mention_sentiment ⇒ Types::MentionSentiment

  Contains the sentiment and sentiment score for the mention.

• #score ⇒ Float

  Model confidence that the entity is relevant.

• #text ⇒ String

  The text in the document that identifies the entity.

• #type ⇒ String

  The type of the entity.

Instance Attribute Details

#begin_offset ⇒ Integer

The offset into the document text where the mention begins.

Returns:

• (Integer)

# 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_offset ⇒ Integer

The offset into the document text where the mention ends.

Returns:

• (Integer)

# 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_score ⇒ Float

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

Returns:

• (Float)

# 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_sentiment ⇒ Types::MentionSentiment

Contains the sentiment and sentiment score for the mention.

Returns:

• (Types::MentionSentiment)

# 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

#score ⇒ Float

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

Returns:

• (Float)

# 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

#text ⇒ String

The text in the document that identifies the entity.

Returns:

• (String)

# 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

#type ⇒ String

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)

# 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