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.Transcribe.Types.TranscriptFilter

Description

Documentation

data TranscriptFilter Source #

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

Rules using TranscriptFilter are designed to match:

Custom words or phrases spoken by the agent, the customer, or both
Custom words or phrases not spoken by the agent, the customer, or either
Custom words or phrases that occur at a specific time frame

See Rule criteria for batch categories and Rule criteria for streaming categories for usage examples.

See: newTranscriptFilter smart constructor.

Constructors

TranscriptFilter'

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 key words or phrases. See for more detail.
negate :: Maybe Bool
Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase 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 key words or phrases. See for more detail.
transcriptFilterType :: TranscriptFilterType
Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.
Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.
targets :: NonEmpty Text
Specify the phrases that you want to flag.

Instances

Instances details

FromJSON TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods parseJSON :: Value -> Parser TranscriptFilter # parseJSONList :: Value -> Parser [TranscriptFilter] #
ToJSON TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods toJSON :: TranscriptFilter -> Value # toEncoding :: TranscriptFilter -> Encoding # toJSONList :: [TranscriptFilter] -> Value # toEncodingList :: [TranscriptFilter] -> Encoding #
Generic TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Associated Types type Rep TranscriptFilter :: Type -> Type # Methods from :: TranscriptFilter -> Rep TranscriptFilter x # to :: Rep TranscriptFilter x -> TranscriptFilter #
Read TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods readsPrec :: Int -> ReadS TranscriptFilter # readList :: ReadS [TranscriptFilter] # readPrec :: ReadPrec TranscriptFilter # readListPrec :: ReadPrec [TranscriptFilter] #
Show TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods showsPrec :: Int -> TranscriptFilter -> ShowS # show :: TranscriptFilter -> String # showList :: [TranscriptFilter] -> ShowS #
NFData TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods rnf :: TranscriptFilter -> () #
Eq TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods (==) :: TranscriptFilter -> TranscriptFilter -> Bool # (/=) :: TranscriptFilter -> TranscriptFilter -> Bool #
Hashable TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods hashWithSalt :: Int -> TranscriptFilter -> Int # hash :: TranscriptFilter -> Int #
type Rep TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter type Rep TranscriptFilter = D1 ('MetaData "TranscriptFilter" "Amazonka.Transcribe.Types.TranscriptFilter" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "TranscriptFilter'" '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 "transcriptFilterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TranscriptFilterType) :*: S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))))

newTranscriptFilter Source #

Arguments

:: TranscriptFilterType	`$sel:transcriptFilterType:TranscriptFilter'`
-> NonEmpty Text	`$sel:targets:TranscriptFilter'`
-> TranscriptFilter

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

$sel:negate:TranscriptFilter', transcriptFilter_negate - Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

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

$sel:relativeTimeRange:TranscriptFilter', transcriptFilter_relativeTimeRange - Makes it possible to specify a time range (in percentage) in your media file, during which you want to search for the specified key words or phrases. See for more detail.

$sel:transcriptFilterType:TranscriptFilter', transcriptFilter_transcriptFilterType - Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

$sel:targets:TranscriptFilter', transcriptFilter_targets - Specify the phrases that you want to flag.

transcriptFilter_absoluteTimeRange :: Lens' TranscriptFilter (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 key words or phrases. See for more detail.

transcriptFilter_negate :: Lens' TranscriptFilter (Maybe Bool) Source #

Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag the presence of the phrase that you specified in your request.

transcriptFilter_participantRole :: Lens' TranscriptFilter (Maybe ParticipantRole) Source #

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

transcriptFilter_relativeTimeRange :: Lens' TranscriptFilter (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 key words or phrases. See for more detail.

transcriptFilter_transcriptFilterType :: Lens' TranscriptFilter TranscriptFilterType Source #

Flag the presence or absence of an exact match to the phrases that you specify. For example, if you specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged.

Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.

transcriptFilter_targets :: Lens' TranscriptFilter (NonEmpty Text) Source #

Specify the phrases that you want to flag.