software.amazon.awssdk.services.lexruntimev2.model

Class RuntimeHints

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.model.RuntimeHints

All Implemented Interfaces:

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

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

You can provide Amazon Lex V2 with hints to the phrases that a customer is likely to use for a slot. When a slot with hints is resolved, the phrases in the runtime hints are preferred in the resolution. You can provide hints for a maximum of 100 intents. You can provide a maximum of 100 slots.

Before you can use runtime hints with an existing bot, you must first rebuild the bot.

For more information, see Using runtime hints to improve recognition of slot values.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RuntimeHints.Builder

Method Summary

Modifier and Type	Method and Description
static RuntimeHints.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSlotHints() For responses, this returns true if the service returned a value for the SlotHints property.
List<SdkField<?>>	sdkFields()
static Class<? extends RuntimeHints.Builder>	serializableBuilderClass()
Map<String,Map<String,RuntimeHintDetails>>	slotHints() A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.
RuntimeHints.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

hasSlotHints

public final boolean hasSlotHints()

For responses, this returns true if the service returned a value for the SlotHints 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.

slotHints

public final Map<String,Map<String,RuntimeHintDetails>> slotHints()

A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.

The first level of the slotHints map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.

The intent name and slot name must exist.

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 hasSlotHints() method.

Returns:

A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.

The first level of the slotHints map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.

The intent name and slot name must exist.

toBuilder

public RuntimeHints.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuntimeHints.Builder,RuntimeHints>

builder

public static RuntimeHints.Builder builder()

serializableBuilderClass

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