Skip to content

TargetedSentimentMention

Source code in docs_src/capo_comprehend/types/targeted_sentiment_mention.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class TargetedSentimentMention(TypedDict, closed=True):
    score: NotRequired["capo_comprehend.types.float.Float"]
    """<p>Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.</p>"""
    group_score: NotRequired["capo_comprehend.types.float.Float"]
    """<p>The confidence that all the entities mentioned in the group relate to the same entity.</p>"""
    text: NotRequired["capo_comprehend.types.string.String"]
    """<p>The text in the document that identifies the entity.</p>"""
    type: NotRequired[
        "capo_comprehend.types.targeted_sentiment_entity_type.TargetedSentimentEntityType"
    ]
    """<p>The type of the entity. Amazon Comprehend supports a variety of <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-entities">entity types</a>.</p>"""
    mention_sentiment: NotRequired[
        "capo_comprehend.types.mention_sentiment.MentionSentiment"
    ]
    """<p>Contains the sentiment and sentiment score for the mention.</p>"""
    begin_offset: NotRequired["capo_comprehend.types.integer.Integer"]
    """<p>The offset into the document text where the mention begins.</p>"""
    end_offset: NotRequired["capo_comprehend.types.integer.Integer"]
    """<p>The offset into the document text where the mention ends.</p>"""

begin_offset instance-attribute 

begin_offset: NotRequired[Integer]

The offset into the document text where the mention begins.

end_offset instance-attribute 

end_offset: NotRequired[Integer]

The offset into the document text where the mention ends.

group_score instance-attribute 

group_score: NotRequired[Float]

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

mention_sentiment instance-attribute 

mention_sentiment: NotRequired[MentionSentiment]

Contains the sentiment and sentiment score for the mention.

score instance-attribute 

score: NotRequired[Float]

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

text instance-attribute 

text: NotRequired[String]

The text in the document that identifies the entity.

type instance-attribute 

type: NotRequired[TargetedSentimentEntityType]

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