Skip to content

Lex Runtime V2  >  Unions  >  StartConversationRequestEventStream

StartConversationRequestEventStream

Union Type

StartConversationRequestEventStream module-attribute 

StartConversationRequestEventStream = Union[StartConversationRequestEventStreamConfigurationEvent | StartConversationRequestEventStreamAudioInputEvent | StartConversationRequestEventStreamDTMFInputEvent | StartConversationRequestEventStreamTextInputEvent | StartConversationRequestEventStreamPlaybackCompletionEvent | StartConversationRequestEventStreamDisconnectionEvent | StartConversationRequestEventStreamUnknown]

Represents a stream of events between your application and Amazon Lex V2.

Union Member Types

StartConversationRequestEventStreamConfigurationEvent dataclass

Configuration information sent from your client application to Amazon Lex V2

Attributes

value instance-attribute 
value: ConfigurationEvent

StartConversationRequestEventStreamAudioInputEvent dataclass

Speech audio sent from your client application to Amazon Lex V2. Audio starts accumulating when Amazon Lex V2 identifies a voice and continues until a natural pause in the speech is found before processing.

Attributes

value instance-attribute 
value: AudioInputEvent

StartConversationRequestEventStreamDTMFInputEvent dataclass

DTMF information sent to Amazon Lex V2 by your application. Amazon Lex V2 accumulates the DMTF information from when the user sends the first character and ends

  • when there's a pause longer that the value configured for the end timeout.

  • when there's a digit that is the configured end character.

  • when Amazon Lex V2 accumulates characters equal to the maximum DTMF character configuration.

Attributes

value instance-attribute 
value: DTMFInputEvent

StartConversationRequestEventStreamTextInputEvent dataclass

Text sent from your client application to Amazon Lex V2. Each TextInputEvent is processed individually.

Attributes

value instance-attribute 
value: TextInputEvent

StartConversationRequestEventStreamPlaybackCompletionEvent dataclass

Event sent from the client application to Amazon Lex V2 to indicate that it has finished playing audio and that Amazon Lex V2 should start listening for user input.

Attributes

value instance-attribute 
value: PlaybackCompletionEvent

StartConversationRequestEventStreamDisconnectionEvent dataclass

Event sent from the client application to indicate to Amazon Lex V2 that the conversation is over.

Attributes

value instance-attribute 
value: DisconnectionEvent

StartConversationRequestEventStreamUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Attributes

tag instance-attribute 
tag: str