Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transcribe.Types.TranscriptFilter

Description

Documentation

data TranscriptFilter Source #

Matches the output of the transcription to either the specific phrases that you specify, or the intent of the phrases that you specify.

See: newTranscriptFilter smart constructor.

Constructors

TranscriptFilter'

Fields

participantRole :: Maybe ParticipantRole
Determines whether the customer or the agent is speaking the phrases that you've specified.
relativeTimeRange :: Maybe RelativeTimeRange
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
negate :: Maybe Bool
If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.
absoluteTimeRange :: Maybe AbsoluteTimeRange
A time range, set in seconds, between two points in the call.
transcriptFilterType :: TranscriptFilterType
Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
targets :: NonEmpty Text
The phrases that you're specifying for the transcript filter to match.

Instances

Instances details

Eq TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods (==) :: TranscriptFilter -> TranscriptFilter -> Bool # (/=) :: TranscriptFilter -> TranscriptFilter -> Bool #
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 #
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 #
NFData TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods rnf :: TranscriptFilter -> () #
Hashable TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods hashWithSalt :: Int -> TranscriptFilter -> Int # hash :: TranscriptFilter -> Int #
ToJSON TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods toJSON :: TranscriptFilter -> Value # toEncoding :: TranscriptFilter -> Encoding # toJSONList :: [TranscriptFilter] -> Value # toEncodingList :: [TranscriptFilter] -> Encoding #
FromJSON TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter Methods parseJSON :: Value -> Parser TranscriptFilter # parseJSONList :: Value -> Parser [TranscriptFilter] #
type Rep TranscriptFilter Source #
Instance details Defined in Amazonka.Transcribe.Types.TranscriptFilter type Rep TranscriptFilter = D1 ('MetaData "TranscriptFilter" "Amazonka.Transcribe.Types.TranscriptFilter" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "TranscriptFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "participantRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParticipantRole)) :: (S1 ('MetaSel ('Just "relativeTimeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RelativeTimeRange)) :: S1 ('MetaSel ('Just "negate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "absoluteTimeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AbsoluteTimeRange)) :: (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:participantRole:TranscriptFilter', transcriptFilter_participantRole - Determines whether the customer or the agent is speaking the phrases that you've specified.

$sel:relativeTimeRange:TranscriptFilter', transcriptFilter_relativeTimeRange - An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.

$sel:negate:TranscriptFilter', transcriptFilter_negate - If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.

$sel:absoluteTimeRange:TranscriptFilter', transcriptFilter_absoluteTimeRange - A time range, set in seconds, between two points in the call.

$sel:transcriptFilterType:TranscriptFilter', transcriptFilter_transcriptFilterType - Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.

$sel:targets:TranscriptFilter', transcriptFilter_targets - The phrases that you're specifying for the transcript filter to match.

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

Determines whether the customer or the agent is speaking the phrases that you've specified.

transcriptFilter_relativeTimeRange :: Lens' TranscriptFilter (Maybe RelativeTimeRange) Source #

An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.

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

If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.

transcriptFilter_absoluteTimeRange :: Lens' TranscriptFilter (Maybe AbsoluteTimeRange) Source #

A time range, set in seconds, between two points in the call.

transcriptFilter_transcriptFilterType :: Lens' TranscriptFilter TranscriptFilterType Source #

Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.

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

The phrases that you're specifying for the transcript filter to match.