Class RuntimeHints
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RuntimeHints.Builder,
RuntimeHints>
You can provide Amazon Lex 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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RuntimeHints.Builder
builder()
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()
final boolean
For responses, this returns true if the service returned a value for the SlotHints property.static Class
<? extends RuntimeHints.Builder> final Map
<String, Map<String, RuntimeHintDetails>> A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.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
-
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 theisEmpty()
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
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
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<RuntimeHints.Builder,
RuntimeHints> - 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
-