Package software.amazon.awssdk.services.lexruntimev2.model

Class Interpretation

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.model.Interpretation

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class Interpretation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Interpretation.Builder,Interpretation>

An object containing information about an intent that Amazon Lex V2 determined might satisfy the user's utterance. The intents are ordered by the confidence score.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Interpretation.Builder

Method Summary

Modifier and Type	Method	Description
static Interpretation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Intent	intent()	A list of intents that might satisfy the user's utterance.
InterpretationSource	interpretationSource()	Specifies the service that interpreted the input.
String	interpretationSourceAsString()	Specifies the service that interpreted the input.
ConfidenceScore	nluConfidence()	Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response.
List<SdkField<?>>	sdkFields()
SentimentResponse	sentimentResponse()	The sentiment expressed in an utterance.
static Class<? extends Interpretation.Builder>	serializableBuilderClass()
Interpretation.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

nluConfidence

public final ConfidenceScore nluConfidence()

Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

Returns:

Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

sentimentResponse

public final SentimentResponse sentimentResponse()

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

Returns:

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

intent

public final Intent intent()

A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

Returns:

A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

interpretationSource

public final InterpretationSource interpretationSource()

Specifies the service that interpreted the input.

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

Returns:

Specifies the service that interpreted the input.

See Also:

InterpretationSource

interpretationSourceAsString

public final String interpretationSourceAsString()

Specifies the service that interpreted the input.

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

Returns:

Specifies the service that interpreted the input.

See Also:

InterpretationSource

toBuilder

public Interpretation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Interpretation.Builder,Interpretation>

builder

public static Interpretation.Builder builder()

serializableBuilderClass

public static Class<? extends Interpretation.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