Package software.amazon.awssdk.services.lexruntime.model

Class PredictedIntent

java.lang.Object

software.amazon.awssdk.services.lexruntime.model.PredictedIntent

All Implemented Interfaces:

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

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

An intent that Amazon Lex suggests satisfies the user's intent. Includes the name of the intent, the confidence that Amazon Lex has that the user's intent is satisfied, and the slots defined for the intent.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PredictedIntent.Builder

Method Summary

Modifier and Type	Method	Description
static PredictedIntent.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSlots()	For responses, this returns true if the service returned a value for the Slots property.
String	intentName()	The name of the intent that Amazon Lex suggests satisfies the user's intent.
IntentConfidence	nluIntentConfidence()	Indicates how confident Amazon Lex is that an intent satisfies the user's intent.
List<SdkField<?>>	sdkFields()
static Class<? extends PredictedIntent.Builder>	serializableBuilderClass()
Map<String,String>	slots()	The slot and slot values associated with the predicted intent.
PredictedIntent.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

intentName

public final String intentName()

The name of the intent that Amazon Lex suggests satisfies the user's intent.

Returns:

The name of the intent that Amazon Lex suggests satisfies the user's intent.

nluIntentConfidence

public final IntentConfidence nluIntentConfidence()

Indicates how confident Amazon Lex is that an intent satisfies the user's intent.

Returns:

Indicates how confident Amazon Lex is that an intent satisfies the user's intent.

hasSlots

public final boolean hasSlots()

For responses, this returns true if the service returned a value for the Slots property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

slots

public final Map<String,String> slots()

The slot and slot values associated with the predicted intent.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSlots() method.

Returns:

The slot and slot values associated with the predicted intent.

toBuilder

public PredictedIntent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PredictedIntent.Builder,PredictedIntent>

builder

public static PredictedIntent.Builder builder()

serializableBuilderClass

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