Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Comprehend.Types.TargetedSentimentMention

Description

Synopsis

data TargetedSentimentMention = TargetedSentimentMention' {
- beginOffset :: Maybe Int
- endOffset :: Maybe Int
- groupScore :: Maybe Double
- mentionSentiment :: Maybe MentionSentiment
- score :: Maybe Double
- text :: Maybe Text
- type' :: Maybe TargetedSentimentEntityType
}
newTargetedSentimentMention :: TargetedSentimentMention
targetedSentimentMention_beginOffset :: Lens' TargetedSentimentMention (Maybe Int)
targetedSentimentMention_endOffset :: Lens' TargetedSentimentMention (Maybe Int)
targetedSentimentMention_groupScore :: Lens' TargetedSentimentMention (Maybe Double)
targetedSentimentMention_mentionSentiment :: Lens' TargetedSentimentMention (Maybe MentionSentiment)
targetedSentimentMention_score :: Lens' TargetedSentimentMention (Maybe Double)
targetedSentimentMention_text :: Lens' TargetedSentimentMention (Maybe Text)
targetedSentimentMention_type :: Lens' TargetedSentimentMention (Maybe TargetedSentimentEntityType)

Documentation

data TargetedSentimentMention Source #

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.

See: newTargetedSentimentMention smart constructor.

Constructors

TargetedSentimentMention'

Fields

beginOffset :: Maybe Int
The offset into the document text where the mention begins.
endOffset :: Maybe Int
The offset into the document text where the mention ends.
groupScore :: Maybe Double
The confidence that all the entities mentioned in the group relate to the same entity.
mentionSentiment :: Maybe MentionSentiment
Contains the sentiment and sentiment score for the mention.
score :: Maybe Double
Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.
text :: Maybe Text
The text in the document that identifies the entity.
type' :: Maybe TargetedSentimentEntityType
The type of the entity. Amazon Comprehend supports a variety of entity types.

Instances

Instances details

FromJSON TargetedSentimentMention Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentMention Methods parseJSON :: Value -> Parser TargetedSentimentMention # parseJSONList :: Value -> Parser [TargetedSentimentMention] #
Generic TargetedSentimentMention Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentMention Associated Types type Rep TargetedSentimentMention :: Type -> Type # Methods from :: TargetedSentimentMention -> Rep TargetedSentimentMention x # to :: Rep TargetedSentimentMention x -> TargetedSentimentMention #
Read TargetedSentimentMention Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentMention Methods readsPrec :: Int -> ReadS TargetedSentimentMention # readList :: ReadS [TargetedSentimentMention] # readPrec :: ReadPrec TargetedSentimentMention # readListPrec :: ReadPrec [TargetedSentimentMention] #
Show TargetedSentimentMention Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentMention Methods showsPrec :: Int -> TargetedSentimentMention -> ShowS # show :: TargetedSentimentMention -> String # showList :: [TargetedSentimentMention] -> ShowS #
NFData TargetedSentimentMention Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentMention Methods rnf :: TargetedSentimentMention -> () #
Eq TargetedSentimentMention Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentMention Methods (==) :: TargetedSentimentMention -> TargetedSentimentMention -> Bool # (/=) :: TargetedSentimentMention -> TargetedSentimentMention -> Bool #
Hashable TargetedSentimentMention Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentMention Methods hashWithSalt :: Int -> TargetedSentimentMention -> Int # hash :: TargetedSentimentMention -> Int #
type Rep TargetedSentimentMention Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentMention type Rep TargetedSentimentMention = D1 ('MetaData "TargetedSentimentMention" "Amazonka.Comprehend.Types.TargetedSentimentMention" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "TargetedSentimentMention'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "groupScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :: ((S1 ('MetaSel ('Just "mentionSentiment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MentionSentiment)) :: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TargetedSentimentEntityType))))))

newTargetedSentimentMention :: TargetedSentimentMention Source #

Create a value of TargetedSentimentMention with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:beginOffset:TargetedSentimentMention', targetedSentimentMention_beginOffset - The offset into the document text where the mention begins.

$sel:endOffset:TargetedSentimentMention', targetedSentimentMention_endOffset - The offset into the document text where the mention ends.

$sel:groupScore:TargetedSentimentMention', targetedSentimentMention_groupScore - The confidence that all the entities mentioned in the group relate to the same entity.

$sel:mentionSentiment:TargetedSentimentMention', targetedSentimentMention_mentionSentiment - Contains the sentiment and sentiment score for the mention.

$sel:score:TargetedSentimentMention', targetedSentimentMention_score - Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.

$sel:text:TargetedSentimentMention', targetedSentimentMention_text - The text in the document that identifies the entity.

$sel:type':TargetedSentimentMention', targetedSentimentMention_type - The type of the entity. Amazon Comprehend supports a variety of entity types.

targetedSentimentMention_beginOffset :: Lens' TargetedSentimentMention (Maybe Int) Source #

The offset into the document text where the mention begins.

targetedSentimentMention_endOffset :: Lens' TargetedSentimentMention (Maybe Int) Source #

The offset into the document text where the mention ends.

targetedSentimentMention_groupScore :: Lens' TargetedSentimentMention (Maybe Double) Source #

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

targetedSentimentMention_mentionSentiment :: Lens' TargetedSentimentMention (Maybe MentionSentiment) Source #

Contains the sentiment and sentiment score for the mention.

targetedSentimentMention_score :: Lens' TargetedSentimentMention (Maybe Double) Source #

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

targetedSentimentMention_text :: Lens' TargetedSentimentMention (Maybe Text) Source #

The text in the document that identifies the entity.

targetedSentimentMention_type :: Lens' TargetedSentimentMention (Maybe TargetedSentimentEntityType) Source #

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