@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UtteranceSpecification extends Object implements Serializable, Cloneable, StructuredPojo
An object containing information about a specific utterance.
Constructor and Description |
---|
UtteranceSpecification() |
Modifier and Type | Method and Description |
---|---|
UtteranceSpecification |
clone() |
boolean |
equals(Object obj) |
String |
getAssociatedIntentName()
The name of the intent that the utterance is associated to.
|
String |
getAssociatedSlotName()
The name of the slot that the utterance is associated to.
|
Long |
getAudioVoiceDurationMillis()
The duration in milliseconds of the audio associated with the utterance.
|
String |
getBotAliasId()
The identifier of the alias of the bot that the utterance was made to.
|
String |
getBotResponseAudioVoiceId()
The identifier for the audio of the bot response.
|
List<UtteranceBotResponse> |
getBotResponses()
A list of objects containing information about the bot response to the utterance.
|
String |
getBotVersion()
The version of the bot that the utterance was made to.
|
String |
getChannel()
The channel that is integrated with the bot that the utterance was made to.
|
Date |
getConversationEndTime()
The date and time when the conversation in which the utterance took place ended.
|
Date |
getConversationStartTime()
The date and time when the conversation in which the utterance took place began.
|
String |
getDialogActionType()
The type of dialog action that the utterance is associated to.
|
String |
getInputType()
The input type of the utterance.
|
String |
getIntentState()
The state of the intent that the utterance is associated to.
|
String |
getLocaleId()
The locale of the bot that the utterance was made to.
|
String |
getMode()
The mode of the session.
|
String |
getOutputType()
The output type of the utterance.
|
String |
getSessionId()
The identifier of the session that the utterance was made in.
|
String |
getSlotsFilledInSession()
The slots that have been filled in the session by the time of the utterance.
|
String |
getUtterance()
The text of the utterance.
|
String |
getUtteranceRequestId()
The identifier of the request associated with the utterance.
|
Date |
getUtteranceTimestamp()
The date and time when the utterance took place.
|
Boolean |
getUtteranceUnderstood()
Specifies whether the bot understood the utterance or not.
|
int |
hashCode() |
Boolean |
isUtteranceUnderstood()
Specifies whether the bot understood the utterance or not.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAssociatedIntentName(String associatedIntentName)
The name of the intent that the utterance is associated to.
|
void |
setAssociatedSlotName(String associatedSlotName)
The name of the slot that the utterance is associated to.
|
void |
setAudioVoiceDurationMillis(Long audioVoiceDurationMillis)
The duration in milliseconds of the audio associated with the utterance.
|
void |
setBotAliasId(String botAliasId)
The identifier of the alias of the bot that the utterance was made to.
|
void |
setBotResponseAudioVoiceId(String botResponseAudioVoiceId)
The identifier for the audio of the bot response.
|
void |
setBotResponses(Collection<UtteranceBotResponse> botResponses)
A list of objects containing information about the bot response to the utterance.
|
void |
setBotVersion(String botVersion)
The version of the bot that the utterance was made to.
|
void |
setChannel(String channel)
The channel that is integrated with the bot that the utterance was made to.
|
void |
setConversationEndTime(Date conversationEndTime)
The date and time when the conversation in which the utterance took place ended.
|
void |
setConversationStartTime(Date conversationStartTime)
The date and time when the conversation in which the utterance took place began.
|
void |
setDialogActionType(String dialogActionType)
The type of dialog action that the utterance is associated to.
|
void |
setInputType(String inputType)
The input type of the utterance.
|
void |
setIntentState(String intentState)
The state of the intent that the utterance is associated to.
|
void |
setLocaleId(String localeId)
The locale of the bot that the utterance was made to.
|
void |
setMode(String mode)
The mode of the session.
|
void |
setOutputType(String outputType)
The output type of the utterance.
|
void |
setSessionId(String sessionId)
The identifier of the session that the utterance was made in.
|
void |
setSlotsFilledInSession(String slotsFilledInSession)
The slots that have been filled in the session by the time of the utterance.
|
void |
setUtterance(String utterance)
The text of the utterance.
|
void |
setUtteranceRequestId(String utteranceRequestId)
The identifier of the request associated with the utterance.
|
void |
setUtteranceTimestamp(Date utteranceTimestamp)
The date and time when the utterance took place.
|
void |
setUtteranceUnderstood(Boolean utteranceUnderstood)
Specifies whether the bot understood the utterance or not.
|
String |
toString()
Returns a string representation of this object.
|
UtteranceSpecification |
withAssociatedIntentName(String associatedIntentName)
The name of the intent that the utterance is associated to.
|
UtteranceSpecification |
withAssociatedSlotName(String associatedSlotName)
The name of the slot that the utterance is associated to.
|
UtteranceSpecification |
withAudioVoiceDurationMillis(Long audioVoiceDurationMillis)
The duration in milliseconds of the audio associated with the utterance.
|
UtteranceSpecification |
withBotAliasId(String botAliasId)
The identifier of the alias of the bot that the utterance was made to.
|
UtteranceSpecification |
withBotResponseAudioVoiceId(String botResponseAudioVoiceId)
The identifier for the audio of the bot response.
|
UtteranceSpecification |
withBotResponses(Collection<UtteranceBotResponse> botResponses)
A list of objects containing information about the bot response to the utterance.
|
UtteranceSpecification |
withBotResponses(UtteranceBotResponse... botResponses)
A list of objects containing information about the bot response to the utterance.
|
UtteranceSpecification |
withBotVersion(String botVersion)
The version of the bot that the utterance was made to.
|
UtteranceSpecification |
withChannel(String channel)
The channel that is integrated with the bot that the utterance was made to.
|
UtteranceSpecification |
withConversationEndTime(Date conversationEndTime)
The date and time when the conversation in which the utterance took place ended.
|
UtteranceSpecification |
withConversationStartTime(Date conversationStartTime)
The date and time when the conversation in which the utterance took place began.
|
UtteranceSpecification |
withDialogActionType(String dialogActionType)
The type of dialog action that the utterance is associated to.
|
UtteranceSpecification |
withInputType(String inputType)
The input type of the utterance.
|
UtteranceSpecification |
withIntentState(IntentState intentState)
The state of the intent that the utterance is associated to.
|
UtteranceSpecification |
withIntentState(String intentState)
The state of the intent that the utterance is associated to.
|
UtteranceSpecification |
withLocaleId(String localeId)
The locale of the bot that the utterance was made to.
|
UtteranceSpecification |
withMode(AnalyticsModality mode)
The mode of the session.
|
UtteranceSpecification |
withMode(String mode)
The mode of the session.
|
UtteranceSpecification |
withOutputType(String outputType)
The output type of the utterance.
|
UtteranceSpecification |
withSessionId(String sessionId)
The identifier of the session that the utterance was made in.
|
UtteranceSpecification |
withSlotsFilledInSession(String slotsFilledInSession)
The slots that have been filled in the session by the time of the utterance.
|
UtteranceSpecification |
withUtterance(String utterance)
The text of the utterance.
|
UtteranceSpecification |
withUtteranceRequestId(String utteranceRequestId)
The identifier of the request associated with the utterance.
|
UtteranceSpecification |
withUtteranceTimestamp(Date utteranceTimestamp)
The date and time when the utterance took place.
|
UtteranceSpecification |
withUtteranceUnderstood(Boolean utteranceUnderstood)
Specifies whether the bot understood the utterance or not.
|
public void setBotAliasId(String botAliasId)
The identifier of the alias of the bot that the utterance was made to.
botAliasId
- The identifier of the alias of the bot that the utterance was made to.public String getBotAliasId()
The identifier of the alias of the bot that the utterance was made to.
public UtteranceSpecification withBotAliasId(String botAliasId)
The identifier of the alias of the bot that the utterance was made to.
botAliasId
- The identifier of the alias of the bot that the utterance was made to.public void setBotVersion(String botVersion)
The version of the bot that the utterance was made to.
botVersion
- The version of the bot that the utterance was made to.public String getBotVersion()
The version of the bot that the utterance was made to.
public UtteranceSpecification withBotVersion(String botVersion)
The version of the bot that the utterance was made to.
botVersion
- The version of the bot that the utterance was made to.public void setLocaleId(String localeId)
The locale of the bot that the utterance was made to.
localeId
- The locale of the bot that the utterance was made to.public String getLocaleId()
The locale of the bot that the utterance was made to.
public UtteranceSpecification withLocaleId(String localeId)
The locale of the bot that the utterance was made to.
localeId
- The locale of the bot that the utterance was made to.public void setSessionId(String sessionId)
The identifier of the session that the utterance was made in.
sessionId
- The identifier of the session that the utterance was made in.public String getSessionId()
The identifier of the session that the utterance was made in.
public UtteranceSpecification withSessionId(String sessionId)
The identifier of the session that the utterance was made in.
sessionId
- The identifier of the session that the utterance was made in.public void setChannel(String channel)
The channel that is integrated with the bot that the utterance was made to.
channel
- The channel that is integrated with the bot that the utterance was made to.public String getChannel()
The channel that is integrated with the bot that the utterance was made to.
public UtteranceSpecification withChannel(String channel)
The channel that is integrated with the bot that the utterance was made to.
channel
- The channel that is integrated with the bot that the utterance was made to.public void setMode(String mode)
The mode of the session. The possible values are as follows:
Speech
– The session consisted of spoken dialogue.
Text
– The session consisted of written dialogue.
DTMF
– The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.
MultiMode
– The session consisted of multiple modes.
mode
- The mode of the session. The possible values are as follows:
Speech
– The session consisted of spoken dialogue.
Text
– The session consisted of written dialogue.
DTMF
– The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.
MultiMode
– The session consisted of multiple modes.
AnalyticsModality
public String getMode()
The mode of the session. The possible values are as follows:
Speech
– The session consisted of spoken dialogue.
Text
– The session consisted of written dialogue.
DTMF
– The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.
MultiMode
– The session consisted of multiple modes.
Speech
– The session consisted of spoken dialogue.
Text
– The session consisted of written dialogue.
DTMF
– The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.
MultiMode
– The session consisted of multiple modes.
AnalyticsModality
public UtteranceSpecification withMode(String mode)
The mode of the session. The possible values are as follows:
Speech
– The session consisted of spoken dialogue.
Text
– The session consisted of written dialogue.
DTMF
– The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.
MultiMode
– The session consisted of multiple modes.
mode
- The mode of the session. The possible values are as follows:
Speech
– The session consisted of spoken dialogue.
Text
– The session consisted of written dialogue.
DTMF
– The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.
MultiMode
– The session consisted of multiple modes.
AnalyticsModality
public UtteranceSpecification withMode(AnalyticsModality mode)
The mode of the session. The possible values are as follows:
Speech
– The session consisted of spoken dialogue.
Text
– The session consisted of written dialogue.
DTMF
– The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.
MultiMode
– The session consisted of multiple modes.
mode
- The mode of the session. The possible values are as follows:
Speech
– The session consisted of spoken dialogue.
Text
– The session consisted of written dialogue.
DTMF
– The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.
MultiMode
– The session consisted of multiple modes.
AnalyticsModality
public void setConversationStartTime(Date conversationStartTime)
The date and time when the conversation in which the utterance took place began. A conversation is defined as a
unique combination of a sessionId
and an originatingRequestId
.
conversationStartTime
- The date and time when the conversation in which the utterance took place began. A conversation is defined
as a unique combination of a sessionId
and an originatingRequestId
.public Date getConversationStartTime()
The date and time when the conversation in which the utterance took place began. A conversation is defined as a
unique combination of a sessionId
and an originatingRequestId
.
sessionId
and an originatingRequestId
.public UtteranceSpecification withConversationStartTime(Date conversationStartTime)
The date and time when the conversation in which the utterance took place began. A conversation is defined as a
unique combination of a sessionId
and an originatingRequestId
.
conversationStartTime
- The date and time when the conversation in which the utterance took place began. A conversation is defined
as a unique combination of a sessionId
and an originatingRequestId
.public void setConversationEndTime(Date conversationEndTime)
The date and time when the conversation in which the utterance took place ended. A conversation is defined as a
unique combination of a sessionId
and an originatingRequestId
.
conversationEndTime
- The date and time when the conversation in which the utterance took place ended. A conversation is defined
as a unique combination of a sessionId
and an originatingRequestId
.public Date getConversationEndTime()
The date and time when the conversation in which the utterance took place ended. A conversation is defined as a
unique combination of a sessionId
and an originatingRequestId
.
sessionId
and an originatingRequestId
.public UtteranceSpecification withConversationEndTime(Date conversationEndTime)
The date and time when the conversation in which the utterance took place ended. A conversation is defined as a
unique combination of a sessionId
and an originatingRequestId
.
conversationEndTime
- The date and time when the conversation in which the utterance took place ended. A conversation is defined
as a unique combination of a sessionId
and an originatingRequestId
.public void setUtterance(String utterance)
The text of the utterance.
utterance
- The text of the utterance.public String getUtterance()
The text of the utterance.
public UtteranceSpecification withUtterance(String utterance)
The text of the utterance.
utterance
- The text of the utterance.public void setUtteranceTimestamp(Date utteranceTimestamp)
The date and time when the utterance took place.
utteranceTimestamp
- The date and time when the utterance took place.public Date getUtteranceTimestamp()
The date and time when the utterance took place.
public UtteranceSpecification withUtteranceTimestamp(Date utteranceTimestamp)
The date and time when the utterance took place.
utteranceTimestamp
- The date and time when the utterance took place.public void setAudioVoiceDurationMillis(Long audioVoiceDurationMillis)
The duration in milliseconds of the audio associated with the utterance.
audioVoiceDurationMillis
- The duration in milliseconds of the audio associated with the utterance.public Long getAudioVoiceDurationMillis()
The duration in milliseconds of the audio associated with the utterance.
public UtteranceSpecification withAudioVoiceDurationMillis(Long audioVoiceDurationMillis)
The duration in milliseconds of the audio associated with the utterance.
audioVoiceDurationMillis
- The duration in milliseconds of the audio associated with the utterance.public void setUtteranceUnderstood(Boolean utteranceUnderstood)
Specifies whether the bot understood the utterance or not.
utteranceUnderstood
- Specifies whether the bot understood the utterance or not.public Boolean getUtteranceUnderstood()
Specifies whether the bot understood the utterance or not.
public UtteranceSpecification withUtteranceUnderstood(Boolean utteranceUnderstood)
Specifies whether the bot understood the utterance or not.
utteranceUnderstood
- Specifies whether the bot understood the utterance or not.public Boolean isUtteranceUnderstood()
Specifies whether the bot understood the utterance or not.
public void setInputType(String inputType)
The input type of the utterance. The possible values are as follows:
PCM format: audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
inputType
- The input type of the utterance. The possible values are as follows:
PCM format: audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
public String getInputType()
The input type of the utterance. The possible values are as follows:
PCM format: audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
PCM format: audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
public UtteranceSpecification withInputType(String inputType)
The input type of the utterance. The possible values are as follows:
PCM format: audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
inputType
- The input type of the utterance. The possible values are as follows:
PCM format: audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
public void setOutputType(String outputType)
The output type of the utterance. The possible values are as follows:
audio/mpeg
audio/ogg
audio/pcm (16 KHz)
audio/
(defaults to mpeg
)
text/plain; charset=utf-8
outputType
- The output type of the utterance. The possible values are as follows:
audio/mpeg
audio/ogg
audio/pcm (16 KHz)
audio/
(defaults to mpeg
)
text/plain; charset=utf-8
public String getOutputType()
The output type of the utterance. The possible values are as follows:
audio/mpeg
audio/ogg
audio/pcm (16 KHz)
audio/
(defaults to mpeg
)
text/plain; charset=utf-8
audio/mpeg
audio/ogg
audio/pcm (16 KHz)
audio/
(defaults to mpeg
)
text/plain; charset=utf-8
public UtteranceSpecification withOutputType(String outputType)
The output type of the utterance. The possible values are as follows:
audio/mpeg
audio/ogg
audio/pcm (16 KHz)
audio/
(defaults to mpeg
)
text/plain; charset=utf-8
outputType
- The output type of the utterance. The possible values are as follows:
audio/mpeg
audio/ogg
audio/pcm (16 KHz)
audio/
(defaults to mpeg
)
text/plain; charset=utf-8
public void setAssociatedIntentName(String associatedIntentName)
The name of the intent that the utterance is associated to.
associatedIntentName
- The name of the intent that the utterance is associated to.public String getAssociatedIntentName()
The name of the intent that the utterance is associated to.
public UtteranceSpecification withAssociatedIntentName(String associatedIntentName)
The name of the intent that the utterance is associated to.
associatedIntentName
- The name of the intent that the utterance is associated to.public void setAssociatedSlotName(String associatedSlotName)
The name of the slot that the utterance is associated to.
associatedSlotName
- The name of the slot that the utterance is associated to.public String getAssociatedSlotName()
The name of the slot that the utterance is associated to.
public UtteranceSpecification withAssociatedSlotName(String associatedSlotName)
The name of the slot that the utterance is associated to.
associatedSlotName
- The name of the slot that the utterance is associated to.public void setIntentState(String intentState)
The state of the intent that the utterance is associated to.
intentState
- The state of the intent that the utterance is associated to.IntentState
public String getIntentState()
The state of the intent that the utterance is associated to.
IntentState
public UtteranceSpecification withIntentState(String intentState)
The state of the intent that the utterance is associated to.
intentState
- The state of the intent that the utterance is associated to.IntentState
public UtteranceSpecification withIntentState(IntentState intentState)
The state of the intent that the utterance is associated to.
intentState
- The state of the intent that the utterance is associated to.IntentState
public void setDialogActionType(String dialogActionType)
The type of dialog action that the utterance is associated to. See the type
field in DialogAction for
more information.
dialogActionType
- The type of dialog action that the utterance is associated to. See the type
field in DialogAction for more information.public String getDialogActionType()
The type of dialog action that the utterance is associated to. See the type
field in DialogAction for
more information.
type
field in DialogAction
for more information.public UtteranceSpecification withDialogActionType(String dialogActionType)
The type of dialog action that the utterance is associated to. See the type
field in DialogAction for
more information.
dialogActionType
- The type of dialog action that the utterance is associated to. See the type
field in DialogAction for more information.public void setBotResponseAudioVoiceId(String botResponseAudioVoiceId)
The identifier for the audio of the bot response.
botResponseAudioVoiceId
- The identifier for the audio of the bot response.public String getBotResponseAudioVoiceId()
The identifier for the audio of the bot response.
public UtteranceSpecification withBotResponseAudioVoiceId(String botResponseAudioVoiceId)
The identifier for the audio of the bot response.
botResponseAudioVoiceId
- The identifier for the audio of the bot response.public void setSlotsFilledInSession(String slotsFilledInSession)
The slots that have been filled in the session by the time of the utterance.
slotsFilledInSession
- The slots that have been filled in the session by the time of the utterance.public String getSlotsFilledInSession()
The slots that have been filled in the session by the time of the utterance.
public UtteranceSpecification withSlotsFilledInSession(String slotsFilledInSession)
The slots that have been filled in the session by the time of the utterance.
slotsFilledInSession
- The slots that have been filled in the session by the time of the utterance.public void setUtteranceRequestId(String utteranceRequestId)
The identifier of the request associated with the utterance.
utteranceRequestId
- The identifier of the request associated with the utterance.public String getUtteranceRequestId()
The identifier of the request associated with the utterance.
public UtteranceSpecification withUtteranceRequestId(String utteranceRequestId)
The identifier of the request associated with the utterance.
utteranceRequestId
- The identifier of the request associated with the utterance.public List<UtteranceBotResponse> getBotResponses()
A list of objects containing information about the bot response to the utterance.
public void setBotResponses(Collection<UtteranceBotResponse> botResponses)
A list of objects containing information about the bot response to the utterance.
botResponses
- A list of objects containing information about the bot response to the utterance.public UtteranceSpecification withBotResponses(UtteranceBotResponse... botResponses)
A list of objects containing information about the bot response to the utterance.
NOTE: This method appends the values to the existing list (if any). Use
setBotResponses(java.util.Collection)
or withBotResponses(java.util.Collection)
if you want to
override the existing values.
botResponses
- A list of objects containing information about the bot response to the utterance.public UtteranceSpecification withBotResponses(Collection<UtteranceBotResponse> botResponses)
A list of objects containing information about the bot response to the utterance.
botResponses
- A list of objects containing information about the bot response to the utterance.public String toString()
toString
in class Object
Object.toString()
public UtteranceSpecification clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.