amazonka-lexv2-models-2.0: Amazon Lex Model Building V2 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.LexV2Models.Types.AggregatedUtterancesSummary

Description

 
Synopsis

Documentation

data AggregatedUtterancesSummary Source #

Provides summary information for aggregated utterances. The ListAggregatedUtterances operations combines all instances of the same utterance into a single aggregated summary.

See: newAggregatedUtterancesSummary smart constructor.

Constructors

AggregatedUtterancesSummary' 

Fields

  • containsDataFromDeletedResources :: Maybe Bool

    Aggregated utterance data may contain utterances from versions of your bot that have since been deleted. When the aggregated contains this kind of data, this field is set to true.

  • hitCount :: Maybe Int

    The number of times that the utterance was detected by Amazon Lex during the time period. When an utterance is detected, it activates an intent or a slot.

  • missedCount :: Maybe Int

    The number of times that the utterance was missed by Amazon Lex An utterance is missed when it doesn't activate an intent or slot.

  • utterance :: Maybe Text

    The text of the utterance. If the utterance was used with the RecognizeUtterance operation, the text is the transcription of the audio utterance.

  • utteranceFirstRecordedInAggregationDuration :: Maybe POSIX

    The date and time that the utterance was first recorded in the time window for aggregation. An utterance may have been sent to Amazon Lex before that time, but only utterances within the time window are counted.

  • utteranceLastRecordedInAggregationDuration :: Maybe POSIX

    The last date and time that an utterance was recorded in the time window for aggregation. An utterance may be sent to Amazon Lex after that time, but only utterances within the time window are counted.

Instances

Instances details
FromJSON AggregatedUtterancesSummary Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.AggregatedUtterancesSummary

Generic AggregatedUtterancesSummary Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.AggregatedUtterancesSummary

Associated Types

type Rep AggregatedUtterancesSummary :: Type -> Type #

Read AggregatedUtterancesSummary Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.AggregatedUtterancesSummary

Show AggregatedUtterancesSummary Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.AggregatedUtterancesSummary

NFData AggregatedUtterancesSummary Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.AggregatedUtterancesSummary

Eq AggregatedUtterancesSummary Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.AggregatedUtterancesSummary

Hashable AggregatedUtterancesSummary Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.AggregatedUtterancesSummary

type Rep AggregatedUtterancesSummary Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.AggregatedUtterancesSummary

type Rep AggregatedUtterancesSummary = D1 ('MetaData "AggregatedUtterancesSummary" "Amazonka.LexV2Models.Types.AggregatedUtterancesSummary" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "AggregatedUtterancesSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containsDataFromDeletedResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "hitCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "missedCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "utterance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "utteranceFirstRecordedInAggregationDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "utteranceLastRecordedInAggregationDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newAggregatedUtterancesSummary :: AggregatedUtterancesSummary Source #

Create a value of AggregatedUtterancesSummary 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:containsDataFromDeletedResources:AggregatedUtterancesSummary', aggregatedUtterancesSummary_containsDataFromDeletedResources - Aggregated utterance data may contain utterances from versions of your bot that have since been deleted. When the aggregated contains this kind of data, this field is set to true.

$sel:hitCount:AggregatedUtterancesSummary', aggregatedUtterancesSummary_hitCount - The number of times that the utterance was detected by Amazon Lex during the time period. When an utterance is detected, it activates an intent or a slot.

$sel:missedCount:AggregatedUtterancesSummary', aggregatedUtterancesSummary_missedCount - The number of times that the utterance was missed by Amazon Lex An utterance is missed when it doesn't activate an intent or slot.

$sel:utterance:AggregatedUtterancesSummary', aggregatedUtterancesSummary_utterance - The text of the utterance. If the utterance was used with the RecognizeUtterance operation, the text is the transcription of the audio utterance.

$sel:utteranceFirstRecordedInAggregationDuration:AggregatedUtterancesSummary', aggregatedUtterancesSummary_utteranceFirstRecordedInAggregationDuration - The date and time that the utterance was first recorded in the time window for aggregation. An utterance may have been sent to Amazon Lex before that time, but only utterances within the time window are counted.

$sel:utteranceLastRecordedInAggregationDuration:AggregatedUtterancesSummary', aggregatedUtterancesSummary_utteranceLastRecordedInAggregationDuration - The last date and time that an utterance was recorded in the time window for aggregation. An utterance may be sent to Amazon Lex after that time, but only utterances within the time window are counted.

aggregatedUtterancesSummary_containsDataFromDeletedResources :: Lens' AggregatedUtterancesSummary (Maybe Bool) Source #

Aggregated utterance data may contain utterances from versions of your bot that have since been deleted. When the aggregated contains this kind of data, this field is set to true.

aggregatedUtterancesSummary_hitCount :: Lens' AggregatedUtterancesSummary (Maybe Int) Source #

The number of times that the utterance was detected by Amazon Lex during the time period. When an utterance is detected, it activates an intent or a slot.

aggregatedUtterancesSummary_missedCount :: Lens' AggregatedUtterancesSummary (Maybe Int) Source #

The number of times that the utterance was missed by Amazon Lex An utterance is missed when it doesn't activate an intent or slot.

aggregatedUtterancesSummary_utterance :: Lens' AggregatedUtterancesSummary (Maybe Text) Source #

The text of the utterance. If the utterance was used with the RecognizeUtterance operation, the text is the transcription of the audio utterance.

aggregatedUtterancesSummary_utteranceFirstRecordedInAggregationDuration :: Lens' AggregatedUtterancesSummary (Maybe UTCTime) Source #

The date and time that the utterance was first recorded in the time window for aggregation. An utterance may have been sent to Amazon Lex before that time, but only utterances within the time window are counted.

aggregatedUtterancesSummary_utteranceLastRecordedInAggregationDuration :: Lens' AggregatedUtterancesSummary (Maybe UTCTime) Source #

The last date and time that an utterance was recorded in the time window for aggregation. An utterance may be sent to Amazon Lex after that time, but only utterances within the time window are counted.