An object containing information about a specific utterance.
Contents
- associatedIntentName
-
The name of the intent that the utterance is associated to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$Required: No
- associatedSlotName
-
The name of the slot that the utterance is associated to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$Required: No
- audioVoiceDurationMillis
-
The duration in milliseconds of the audio associated with the utterance.
Type: Long
Required: No
- botAliasId
-
The identifier of the alias of the bot that the utterance was made to.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^(\bTSTALIASID\b|[0-9a-zA-Z]+)$Required: No
- botResponseAudioVoiceId
-
The identifier for the audio of the bot response.
Type: String
Required: No
- botResponses
-
A list of objects containing information about the bot response to the utterance.
Type: Array of UtteranceBotResponse objects
Required: No
- botVersion
-
The version of the bot that the utterance was made to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^[0-9]+$Required: No
- channel
-
The channel that is integrated with the bot that the utterance was made to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: No
- 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
sessionIdand anoriginatingRequestId.Type: Timestamp
Required: No
- 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
sessionIdand anoriginatingRequestId.Type: Timestamp
Required: No
- dialogActionType
-
The type of dialog action that the utterance is associated to. See the
typefield in DialogAction for more information.Type: String
Required: No
- 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
-
Type: String
Required: No
-
- intentState
-
The state of the intent that the utterance is associated to.
Type: String
Valid Values:
Failed | Fulfilled | InProgress | ReadyForFulfillment | Waiting | FulfillmentInProgressRequired: No
- localeId
-
The locale of the bot that the utterance was made to.
Type: String
Required: No
- 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.
Type: String
Valid Values:
Speech | Text | DTMF | MultiModeRequired: No
-
- outputType
-
The output type of the utterance. The possible values are as follows:
-
audio/mpeg -
audio/ogg -
audio/pcm (16 KHz) -
audio/(defaults tompeg) -
text/plain; charset=utf-8
Type: String
Required: No
-
- sessionId
-
The identifier of the session that the utterance was made in.
Type: String
Pattern:
[0-9a-zA-Z._:-]Required: No
- slotsFilledInSession
-
The slots that have been filled in the session by the time of the utterance.
Type: String
Required: No
- utterance
-
The text of the utterance.
Type: String
Required: No
- utteranceRequestId
-
The identifier of the request associated with the utterance.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: No
- utteranceTimestamp
-
The date and time when the utterance took place.
Type: Timestamp
Required: No
- utteranceUnderstood
-
Specifies whether the bot understood the utterance or not.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
