AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

An object containing information about a specific utterance.

Inheritance Hierarchy

System.Object
  Amazon.LexModelsV2.Model.UtteranceSpecification

Namespace: Amazon.LexModelsV2.Model
Assembly: AWSSDK.LexModelsV2.dll
Version: 3.x.y.z

Syntax

C#
public class UtteranceSpecification

The UtteranceSpecification type exposes the following members

Constructors

NameDescription
Public Method UtteranceSpecification()

Properties

NameTypeDescription
Public Property AssociatedIntentName System.String

Gets and sets the property AssociatedIntentName.

The name of the intent that the utterance is associated to.

Public Property AssociatedSlotName System.String

Gets and sets the property AssociatedSlotName.

The name of the slot that the utterance is associated to.

Public Property AudioVoiceDurationMillis System.Int64

Gets and sets the property AudioVoiceDurationMillis.

The duration in milliseconds of the audio associated with the utterance.

Public Property BotAliasId System.String

Gets and sets the property BotAliasId.

The identifier of the alias of the bot that the utterance was made to.

Public Property BotResponseAudioVoiceId System.String

Gets and sets the property BotResponseAudioVoiceId.

The identifier for the audio of the bot response.

Public Property BotResponses System.Collections.Generic.List<Amazon.LexModelsV2.Model.UtteranceBotResponse>

Gets and sets the property BotResponses.

A list of objects containing information about the bot response to the utterance.

Public Property BotVersion System.String

Gets and sets the property BotVersion.

The version of the bot that the utterance was made to.

Public Property Channel System.String

Gets and sets the property Channel.

The channel that is integrated with the bot that the utterance was made to.

Public Property ConversationEndTime System.DateTime

Gets and sets the property 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 Property ConversationStartTime System.DateTime

Gets and sets the property 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 Property DialogActionType System.String

Gets and sets the property DialogActionType.

The type of dialog action that the utterance is associated to. See the type field in DialogAction for more information.

Public Property InputType System.String

Gets and sets the property 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 Property IntentState Amazon.LexModelsV2.IntentState

Gets and sets the property IntentState.

The state of the intent that the utterance is associated to.

Public Property LocaleId System.String

Gets and sets the property LocaleId.

The locale of the bot that the utterance was made to.

Public Property Mode Amazon.LexModelsV2.AnalyticsModality

Gets and sets the property 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.

Public Property OutputType System.String

Gets and sets the property 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 Property SessionId System.String

Gets and sets the property SessionId.

The identifier of the session that the utterance was made in.

Public Property SlotsFilledInSession System.String

Gets and sets the property SlotsFilledInSession.

The slots that have been filled in the session by the time of the utterance.

Public Property Utterance System.String

Gets and sets the property Utterance.

The text of the utterance.

Public Property UtteranceRequestId System.String

Gets and sets the property UtteranceRequestId.

The identifier of the request associated with the utterance.

Public Property UtteranceTimestamp System.DateTime

Gets and sets the property UtteranceTimestamp.

The date and time when the utterance took place.

Public Property UtteranceUnderstood System.Boolean

Gets and sets the property UtteranceUnderstood.

Specifies whether the bot understood the utterance or not.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5