Class IntentResultEvent
- java.lang.Object
-
- software.amazon.awssdk.services.lexruntimev2.model.IntentResultEvent
-
- All Implemented Interfaces:
Serializable,SdkPojo,StartConversationResponseEventStream,ToCopyableBuilder<IntentResultEvent.Builder,IntentResultEvent>
- Direct Known Subclasses:
DefaultIntentResultEvent
@Generated("software.amazon.awssdk:codegen") public class IntentResultEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IntentResultEvent.Builder,IntentResultEvent>, StartConversationResponseEventStream
Contains the current state of the conversation between the client application and Amazon Lex V2.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceIntentResultEvent.Builderprotected static classIntentResultEvent.BuilderImpl-
Nested classes/interfaces inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream
StartConversationResponseEventStream.EventType
-
-
Field Summary
-
Fields inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream
UNKNOWN
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedIntentResultEvent(IntentResultEvent.BuilderImpl builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(StartConversationResponseHandler.Visitor visitor)Calls the appropriate visit method depending on the subtype ofIntentResultEvent.static IntentResultEvent.Builderbuilder()IntentResultEventcopy(Consumer<? super IntentResultEvent.Builder> modifier)booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeventId()A unique identifier of the event sent by Amazon Lex V2.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasInterpretations()For responses, this returns true if the service returned a value for the Interpretations property.booleanhasRequestAttributes()For responses, this returns true if the service returned a value for the RequestAttributes property.InputModeinputMode()Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.StringinputModeAsString()Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.List<Interpretation>interpretations()A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.RecognizedBotMemberrecognizedBotMember()The bot member that is processing the intent.Map<String,String>requestAttributes()The attributes sent in the request.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends IntentResultEvent.Builder>serializableBuilderClass()StringsessionId()The identifier of the session in use.SessionStatesessionState()Returns the value of the SessionState property for this object.IntentResultEvent.BuildertoBuilder()StringtoString()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.services.lexruntimev2.model.StartConversationResponseEventStream
sdkEventType
-
-
-
-
Constructor Detail
-
IntentResultEvent
protected IntentResultEvent(IntentResultEvent.BuilderImpl builder)
-
-
Method Detail
-
inputMode
public final InputMode inputMode()
Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.
If the service returns an enum value that is not available in the current SDK version,
inputModewill returnInputMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominputModeAsString().- Returns:
- Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.
- See Also:
InputMode
-
inputModeAsString
public final String inputModeAsString()
Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.
If the service returns an enum value that is not available in the current SDK version,
inputModewill returnInputMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominputModeAsString().- Returns:
- Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.
- See Also:
InputMode
-
hasInterpretations
public final boolean hasInterpretations()
For responses, this returns true if the service returned a value for the Interpretations 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.
-
interpretations
public final List<Interpretation> interpretations()
A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
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
hasInterpretations()method.- Returns:
- A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.
Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
-
sessionState
public final SessionState sessionState()
Returns the value of the SessionState property for this object.- Returns:
- The value of the SessionState property for this object.
-
hasRequestAttributes
public final boolean hasRequestAttributes()
For responses, this returns true if the service returned a value for the RequestAttributes 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.
-
requestAttributes
public final Map<String,String> requestAttributes()
The attributes sent in the request.
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
hasRequestAttributes()method.- Returns:
- The attributes sent in the request.
-
sessionId
public final String sessionId()
The identifier of the session in use.
- Returns:
- The identifier of the session in use.
-
eventId
public final String eventId()
A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form
RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.- Returns:
- A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form
RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.
-
recognizedBotMember
public final RecognizedBotMember recognizedBotMember()
The bot member that is processing the intent.
- Returns:
- The bot member that is processing the intent.
-
toBuilder
public IntentResultEvent.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<IntentResultEvent.Builder,IntentResultEvent>
-
builder
public static IntentResultEvent.Builder builder()
-
serializableBuilderClass
public static Class<? extends IntentResultEvent.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
copy
public final IntentResultEvent copy(Consumer<? super IntentResultEvent.Builder> modifier)
- Specified by:
copyin interfaceToCopyableBuilder<IntentResultEvent.Builder,IntentResultEvent>
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
accept
public void accept(StartConversationResponseHandler.Visitor visitor)
Calls the appropriate visit method depending on the subtype ofIntentResultEvent.- Specified by:
acceptin interfaceStartConversationResponseEventStream- Parameters:
visitor- Visitor to invoke.
-
-