class Aws::LexRuntimeV2::EventStreams::StartConversationRequestEventStream

Attributes

event_emitter[R]

@api private @return Aws::EventEmitter

Public Class Methods

new() click to toggle source
# File lib/aws-sdk-lexruntimev2/event_streams.rb, line 14
def initialize
  @event_emitter = Aws::EventEmitter.new
end

Public Instance Methods

signal_audio_input_event_event(params = {}) click to toggle source

@option params [String, StringIO, File] :audio_chunk

An encoded stream of audio.

@option params [String] :content_type

The encoding used for the audio chunk. You must use 8 KHz PCM 16-bit
mono-channel little-endian format. The value of the field should be:

`audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1;
is-big-endian=false`

@option params [String] :event_id

A unique identifier that your application assigns to the event. You
can use this to identify events in logs.

@option params [Integer] :client_timestamp_millis

A timestamp set by the client of the date and time that the event was
sent to Amazon Lex V2.
# File lib/aws-sdk-lexruntimev2/event_streams.rb, line 95
def signal_audio_input_event_event(params = {})
  @event_emitter.emit(:audio_input_event, params)
end
signal_configuration_event_event(params = {}) click to toggle source

@option params [Hash<String,String>] :request_attributes

Request-specific information passed between the client application and
Amazon Lex V2.

The namespace `x-amz-lex:` is reserved for special attributes. Don't
create any request attributes for prefix `x-amz-lex:`.

@option params [String] :response_content_type

The message that Amazon Lex V2 returns in the response can be either
text or speech based on the `responseContentType` value.

* If the value is `text/plain;charset=utf-8`, Amazon Lex V2 returns
  text in the response.

* If the value begins with `audio/`, Amazon Lex V2 returns speech in
  the response. Amazon Lex V2 uses Amazon Polly to generate the speech
  using the configuration that you specified in the
  `requestContentType` parameter. For example, if you specify
  `audio/mpeg` as the value, Amazon Lex V2 returns speech in the MPEG
  format.

* If the value is `audio/pcm`, the speech returned is audio/pcm in
  16-bit, little-endian format.

* The following are the accepted values:

  * audio/mpeg

  * audio/ogg

  * audio/pcm

  * audio/* (defaults to mpeg)

  * text/plain; charset=utf-8

@option params [Types::SessionState] :session_state

The state of the user's session with Amazon Lex V2.

@option params [Array<Types::Message>] :welcome_messages

A list of messages to send to the user.

@option params [Boolean] :disable_playback

Determines whether Amazon Lex V2 should send audio responses to the
client application. When this parameter if `false`, the client
application needs to create responses for the user.

@option params [String] :event_id

A unique identifier that your application assigns to the event. You
can use this to identify events in logs.

@option params [Integer] :client_timestamp_millis

A timestamp set by the client of the date and time that the event was
sent to Amazon Lex V2.
# File lib/aws-sdk-lexruntimev2/event_streams.rb, line 73
def signal_configuration_event_event(params = {})
  @event_emitter.emit(:configuration_event, params)
end
signal_disconnection_event_event(params = {}) click to toggle source

@option params [String] :event_id

A unique identifier that your application assigns to the event. You
can use this to identify events in logs.

@option params [Integer] :client_timestamp_millis

A timestamp set by the client of the date and time that the event was
sent to Amazon Lex V2.
# File lib/aws-sdk-lexruntimev2/event_streams.rb, line 151
def signal_disconnection_event_event(params = {})
  @event_emitter.emit(:disconnection_event, params)
end
signal_dtmf_input_event_event(params = {}) click to toggle source

@option params [String] :input_character

The DTMF character that the user pressed. The allowed characters are A
- D, 0 - 9, # and *.

@option params [String] :event_id

A unique identifier that your application assigns to the event. You
can use this to identify events in logs.

@option params [Integer] :client_timestamp_millis

A timestamp set by the client of the date and time that the event was
sent to Amazon Lex V2.
# File lib/aws-sdk-lexruntimev2/event_streams.rb, line 111
def signal_dtmf_input_event_event(params = {})
  @event_emitter.emit(:dtmf_input_event, params)
end
signal_end_stream() click to toggle source
# File lib/aws-sdk-lexruntimev2/event_streams.rb, line 155
def signal_end_stream
  @event_emitter.emit(:end_stream, {})
end
signal_playback_completion_event_event(params = {}) click to toggle source

@option params [String] :event_id

A unique identifier that your application assigns to the event. You
can use this to identify events in logs.

@option params [Integer] :client_timestamp_millis

A timestamp set by the client of the date and time that the event was
sent to Amazon Lex V2.
# File lib/aws-sdk-lexruntimev2/event_streams.rb, line 139
def signal_playback_completion_event_event(params = {})
  @event_emitter.emit(:playback_completion_event, params)
end
signal_text_input_event_event(params = {}) click to toggle source

@option params [String] :text

The text from the user. Amazon Lex V2 processes this as a complete
statement.

@option params [String] :event_id

A unique identifier that your application assigns to the event. You
can use this to identify events in logs.

@option params [Integer] :client_timestamp_millis

A timestamp set by the client of the date and time that the event was
sent to Amazon Lex V2.
# File lib/aws-sdk-lexruntimev2/event_streams.rb, line 127
def signal_text_input_event_event(params = {})
  @event_emitter.emit(:text_input_event, params)
end