Struct aws_sdk_comprehend::types::TargetedSentimentMention

#[non_exhaustive]
pub struct TargetedSentimentMention {
    pub score: Option<f32>,
    pub group_score: Option<f32>,
    pub text: Option<String>,
    pub type: Option<TargetedSentimentEntityType>,
    pub mention_sentiment: Option<MentionSentiment>,
    pub begin_offset: Option<i32>,
    pub end_offset: Option<i32>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

score: Option<f32>

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

group_score: Option<f32>

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

text: Option<String>

The text in the document that identifies the entity.

type: Option<TargetedSentimentEntityType>

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

mention_sentiment: Option<MentionSentiment>

Contains the sentiment and sentiment score for the mention.

begin_offset: Option<i32>

The offset into the document text where the mention begins.

end_offset: Option<i32>

The offset into the document text where the mention ends.

Implementations

impl TargetedSentimentMention

pub fn score(&self) -> Option<f32>

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

pub fn group_score(&self) -> Option<f32>

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

pub fn text(&self) -> Option<&str>

The text in the document that identifies the entity.

pub fn type(&self) -> Option<&TargetedSentimentEntityType>

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

pub fn mention_sentiment(&self) -> Option<&MentionSentiment>

Contains the sentiment and sentiment score for the mention.

pub fn begin_offset(&self) -> Option<i32>

The offset into the document text where the mention begins.

pub fn end_offset(&self) -> Option<i32>

The offset into the document text where the mention ends.

impl TargetedSentimentMention

pub fn builder() -> TargetedSentimentMentionBuilder

Creates a new builder-style object to manufacture TargetedSentimentMention.

Trait Implementations

impl Clone for TargetedSentimentMention

fn clone(&self) -> TargetedSentimentMention

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TargetedSentimentMention

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for TargetedSentimentMention

fn eq(&self, other: &TargetedSentimentMention) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TargetedSentimentMention