Class IntentResultEvent
- All Implemented Interfaces:
Serializable
,SdkPojo
,StartConversationResponseEventStream
,ToCopyableBuilder<IntentResultEvent.Builder,
IntentResultEvent>
- Direct Known Subclasses:
DefaultIntentResultEvent
Contains the current state of the conversation between the client application and Amazon Lex V2.
- See Also:
-
Nested Class Summary
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Calls the appropriate visit method depending on the subtype ofIntentResultEvent
.static IntentResultEvent.Builder
builder()
final IntentResultEvent
copy
(Consumer<? super IntentResultEvent.Builder> modifier) A convenience method for callingToCopyableBuilder.toBuilder()
, updating the returned builder and then callingSdkBuilder.build()
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
eventId()
A unique identifier of the event sent by Amazon Lex V2.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 Interpretations property.final boolean
For responses, this returns true if the service returned a value for the RequestAttributes property.final InputMode
Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.final String
Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.final List
<Interpretation> A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.final RecognizedBotMember
The bot member that is processing the intent.The attributes sent in the request.static Class
<? extends IntentResultEvent.Builder> final String
The identifier of the session in use.final SessionState
Returns the value of the SessionState property for this object.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.services.lexruntimev2.model.StartConversationResponseEventStream
sdkEventType
-
Method Details
-
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,
inputMode
will 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:
-
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,
inputMode
will 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:
-
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
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
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
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
The identifier of the session in use.
- Returns:
- The identifier of the session in use.
-
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
The bot member that is processing the intent.
- Returns:
- The bot member that is processing the intent.
-
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<IntentResultEvent.Builder,
IntentResultEvent> - 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
-
copy
Description copied from interface:ToCopyableBuilder
A convenience method for callingToCopyableBuilder.toBuilder()
, updating the returned builder and then callingSdkBuilder.build()
. This is useful for making small modifications to the existing object.- Specified by:
copy
in interfaceToCopyableBuilder<IntentResultEvent.Builder,
IntentResultEvent> - Parameters:
modifier
- A function that mutates this immutable object using the provided builder.- Returns:
- A new copy of this object with the requested modifications.
-
sdkFields
-
accept
Calls the appropriate visit method depending on the subtype ofIntentResultEvent
.- Specified by:
accept
in interfaceStartConversationResponseEventStream
- Parameters:
visitor
- Visitor to invoke.
-