amazonka-transcribe-2.0: Amazon Transcribe Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transcribe.Types.SentimentFilter

Description

 
Synopsis

Documentation

data SentimentFilter Source #

Flag the presence or absence of specific sentiments detected in your Call Analytics transcription output.

Rules using SentimentFilter are designed to match:

  • The presence or absence of a positive sentiment felt by the customer, agent, or both at specified points in the call
  • The presence or absence of a negative sentiment felt by the customer, agent, or both at specified points in the call
  • The presence or absence of a neutral sentiment felt by the customer, agent, or both at specified points in the call
  • The presence or absence of a mixed sentiment felt by the customer, the agent, or both at specified points in the call

See Rule criteria for batch categories for usage examples.

See: newSentimentFilter smart constructor.

Constructors

SentimentFilter' 

Fields

  • absoluteTimeRange :: Maybe AbsoluteTimeRange

    Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

  • negate :: Maybe Bool

    Set to TRUE to flag the sentiments that you didn't include in your request. Set to FALSE to flag the sentiments that you specified in your request.

  • participantRole :: Maybe ParticipantRole

    Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying both participants.

  • relativeTimeRange :: Maybe RelativeTimeRange

    Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

  • sentiments :: NonEmpty SentimentValue

    Specify the sentiments that you want to flag.

Instances

Instances details
FromJSON SentimentFilter Source # 
Instance details

Defined in Amazonka.Transcribe.Types.SentimentFilter

ToJSON SentimentFilter Source # 
Instance details

Defined in Amazonka.Transcribe.Types.SentimentFilter

Generic SentimentFilter Source # 
Instance details

Defined in Amazonka.Transcribe.Types.SentimentFilter

Associated Types

type Rep SentimentFilter :: Type -> Type #

Read SentimentFilter Source # 
Instance details

Defined in Amazonka.Transcribe.Types.SentimentFilter

Show SentimentFilter Source # 
Instance details

Defined in Amazonka.Transcribe.Types.SentimentFilter

NFData SentimentFilter Source # 
Instance details

Defined in Amazonka.Transcribe.Types.SentimentFilter

Methods

rnf :: SentimentFilter -> () #

Eq SentimentFilter Source # 
Instance details

Defined in Amazonka.Transcribe.Types.SentimentFilter

Hashable SentimentFilter Source # 
Instance details

Defined in Amazonka.Transcribe.Types.SentimentFilter

type Rep SentimentFilter Source # 
Instance details

Defined in Amazonka.Transcribe.Types.SentimentFilter

type Rep SentimentFilter = D1 ('MetaData "SentimentFilter" "Amazonka.Transcribe.Types.SentimentFilter" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "SentimentFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "absoluteTimeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AbsoluteTimeRange)) :*: S1 ('MetaSel ('Just "negate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "participantRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParticipantRole)) :*: (S1 ('MetaSel ('Just "relativeTimeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RelativeTimeRange)) :*: S1 ('MetaSel ('Just "sentiments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty SentimentValue))))))

newSentimentFilter Source #

Create a value of SentimentFilter 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:absoluteTimeRange:SentimentFilter', sentimentFilter_absoluteTimeRange - Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

$sel:negate:SentimentFilter', sentimentFilter_negate - Set to TRUE to flag the sentiments that you didn't include in your request. Set to FALSE to flag the sentiments that you specified in your request.

$sel:participantRole:SentimentFilter', sentimentFilter_participantRole - Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying both participants.

$sel:relativeTimeRange:SentimentFilter', sentimentFilter_relativeTimeRange - Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

$sel:sentiments:SentimentFilter', sentimentFilter_sentiments - Specify the sentiments that you want to flag.

sentimentFilter_absoluteTimeRange :: Lens' SentimentFilter (Maybe AbsoluteTimeRange) Source #

Makes it possible to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.

sentimentFilter_negate :: Lens' SentimentFilter (Maybe Bool) Source #

Set to TRUE to flag the sentiments that you didn't include in your request. Set to FALSE to flag the sentiments that you specified in your request.

sentimentFilter_participantRole :: Lens' SentimentFilter (Maybe ParticipantRole) Source #

Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying both participants.

sentimentFilter_relativeTimeRange :: Lens' SentimentFilter (Maybe RelativeTimeRange) Source #

Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.

sentimentFilter_sentiments :: Lens' SentimentFilter (NonEmpty SentimentValue) Source #

Specify the sentiments that you want to flag.