Package software.amazon.awssdk.services.lexmodelsv2.model

Class AnalyticsUtteranceMetric

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.AnalyticsUtteranceMetric

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AnalyticsUtteranceMetric.Builder,AnalyticsUtteranceMetric>

@Generated("software.amazon.awssdk:codegen")
public final class AnalyticsUtteranceMetric
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalyticsUtteranceMetric.Builder

Method Summary

Modifier and Type	Method	Description
static AnalyticsUtteranceMetric.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
AnalyticsUtteranceMetricName	name()	The metric for which you want to get utterance summary statistics.
String	nameAsString()	The metric for which you want to get utterance summary statistics.
AnalyticsSortOrder	order()	Specifies whether to sort the results in ascending or descending order.
String	orderAsString()	Specifies whether to sort the results in ascending or descending order.
List<SdkField<?>>	sdkFields()
static Class<? extends AnalyticsUtteranceMetric.Builder>	serializableBuilderClass()
AnalyticsMetricStatistic	statistic()	The summary statistic to calculate.
String	statisticAsString()	The summary statistic to calculate.
AnalyticsUtteranceMetric.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final AnalyticsUtteranceMetricName 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 return AnalyticsUtteranceMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

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:

AnalyticsUtteranceMetricName

nameAsString

public final String 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 return AnalyticsUtteranceMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

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:

AnalyticsUtteranceMetricName

statistic

public final AnalyticsMetricStatistic statistic()

The summary statistic to calculate.

• Sum – The total count for the category you provide in name.

• Average – The total count divided by the number of utterances in the category you provide in name.

• Max – The highest count in the category you provide in name.

If the service returns an enum value that is not available in the current SDK version, statistic will return AnalyticsMetricStatistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().

Returns:

The summary statistic to calculate.

• Sum – The total count for the category you provide in name.

• Average – The total count divided by the number of utterances in the category you provide in name.

• Max – The highest count in the category you provide in name.

See Also:

AnalyticsMetricStatistic

statisticAsString

public final String statisticAsString()

The summary statistic to calculate.

• Sum – The total count for the category you provide in name.

• Average – The total count divided by the number of utterances in the category you provide in name.

• Max – The highest count in the category you provide in name.

If the service returns an enum value that is not available in the current SDK version, statistic will return AnalyticsMetricStatistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().

Returns:

The summary statistic to calculate.

• Sum – The total count for the category you provide in name.

• Average – The total count divided by the number of utterances in the category you provide in name.

• Max – The highest count in the category you provide in name.

See Also:

AnalyticsMetricStatistic

order

public final AnalyticsSortOrder 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 return AnalyticsSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

Returns:

Specifies whether to sort the results in ascending or descending order.

See Also:

AnalyticsSortOrder

orderAsString

public final String 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 return AnalyticsSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

Returns:

Specifies whether to sort the results in ascending or descending order.

See Also:

AnalyticsSortOrder

toBuilder

public AnalyticsUtteranceMetric.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalyticsUtteranceMetric.Builder,AnalyticsUtteranceMetric>

builder

public static AnalyticsUtteranceMetric.Builder builder()

serializableBuilderClass

public static Class<? extends AnalyticsUtteranceMetric.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo