Class AnalyticsUtteranceMetric
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AnalyticsUtteranceMetric.Builder,
AnalyticsUtteranceMetric>
Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the utterances across the user sessions with the bot.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
name()
The metric for which you want to get utterance summary statistics.final String
The metric for which you want to get utterance summary statistics.final AnalyticsSortOrder
order()
Specifies whether to sort the results in ascending or descending order.final String
Specifies whether to sort the results in ascending or descending order.static Class
<? extends AnalyticsUtteranceMetric.Builder> final AnalyticsMetricStatistic
The summary statistic to calculate.final String
The summary statistic to calculate.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The metric for which you want to get utterance summary statistics.
-
Count
– The number of utterances. -
Missed
– The number of utterances that Amazon Lex failed to recognize. -
Detected
– The number of utterances that Amazon Lex managed to detect. -
UtteranceTimestamp
– The date and time of the utterance.
If the service returns an enum value that is not available in the current SDK version,
name
will returnAnalyticsUtteranceMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The metric for which you want to get utterance summary statistics.
-
Count
– The number of utterances. -
Missed
– The number of utterances that Amazon Lex failed to recognize. -
Detected
– The number of utterances that Amazon Lex managed to detect. -
UtteranceTimestamp
– The date and time of the utterance.
-
- See Also:
-
-
nameAsString
The metric for which you want to get utterance summary statistics.
-
Count
– The number of utterances. -
Missed
– The number of utterances that Amazon Lex failed to recognize. -
Detected
– The number of utterances that Amazon Lex managed to detect. -
UtteranceTimestamp
– The date and time of the utterance.
If the service returns an enum value that is not available in the current SDK version,
name
will returnAnalyticsUtteranceMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The metric for which you want to get utterance summary statistics.
-
Count
– The number of utterances. -
Missed
– The number of utterances that Amazon Lex failed to recognize. -
Detected
– The number of utterances that Amazon Lex managed to detect. -
UtteranceTimestamp
– The date and time of the utterance.
-
- See Also:
-
-
statistic
The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of utterances in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
If the service returns an enum value that is not available in the current SDK version,
statistic
will returnAnalyticsMetricStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of utterances in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
-
- See Also:
-
-
statisticAsString
The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of utterances in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
If the service returns an enum value that is not available in the current SDK version,
statistic
will returnAnalyticsMetricStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of utterances in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
-
- See Also:
-
-
order
Specifies whether to sort the results in ascending or descending order.
If the service returns an enum value that is not available in the current SDK version,
order
will returnAnalyticsSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromorderAsString()
.- Returns:
- Specifies whether to sort the results in ascending or descending order.
- See Also:
-
orderAsString
Specifies whether to sort the results in ascending or descending order.
If the service returns an enum value that is not available in the current SDK version,
order
will returnAnalyticsSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromorderAsString()
.- Returns:
- Specifies whether to sort the results in ascending or descending order.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AnalyticsUtteranceMetric.Builder,
AnalyticsUtteranceMetric> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-