class Aws::LexRuntimeV2::Types::StartConversationRequestEventStream

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

@note When making an API call, you may pass StartConversationRequestEventStream

data as a hash:

    {
      configuration_event: {
        request_attributes: {
          "NonEmptyString" => "String",
        },
        response_content_type: "NonEmptyString", # required
        session_state: {
          dialog_action: {
            type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot
            slot_to_elicit: "NonEmptyString",
          },
          intent: {
            name: "NonEmptyString", # required
            slots: {
              "NonEmptyString" => {
                value: {
                  original_value: "NonEmptyString",
                  interpreted_value: "NonEmptyString", # required
                  resolved_values: ["NonEmptyString"],
                },
                shape: "Scalar", # accepts Scalar, List
                values: [
                  {
                    # recursive Slot
                  },
                ],
              },
            },
            state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting
            confirmation_state: "Confirmed", # accepts Confirmed, Denied, None
          },
          active_contexts: [
            {
              name: "ActiveContextName", # required
              time_to_live: { # required
                time_to_live_in_seconds: 1, # required
                turns_to_live: 1, # required
              },
              context_attributes: { # required
                "ParameterName" => "Text",
              },
            },
          ],
          session_attributes: {
            "NonEmptyString" => "String",
          },
          originating_request_id: "NonEmptyString",
        },
        welcome_messages: [
          {
            content: "Text",
            content_type: "CustomPayload", # required, accepts CustomPayload, ImageResponseCard, PlainText, SSML
            image_response_card: {
              title: "AttachmentTitle", # required
              subtitle: "AttachmentTitle",
              image_url: "AttachmentUrl",
              buttons: [
                {
                  text: "ButtonText", # required
                  value: "ButtonValue", # required
                },
              ],
            },
          },
        ],
        disable_playback: false,
        event_id: "EventId",
        client_timestamp_millis: 1,
      },
      audio_input_event: {
        audio_chunk: "data",
        content_type: "NonEmptyString", # required
        event_id: "EventId",
        client_timestamp_millis: 1,
      },
      dtmf_input_event: {
        input_character: "DTMFRegex", # required
        event_id: "EventId",
        client_timestamp_millis: 1,
      },
      text_input_event: {
        text: "Text", # required
        event_id: "EventId",
        client_timestamp_millis: 1,
      },
      playback_completion_event: {
        event_id: "EventId",
        client_timestamp_millis: 1,
      },
      disconnection_event: {
        event_id: "EventId",
        client_timestamp_millis: 1,
      },
    }

EventStream is an Enumerator of Events.

#event_types #=> Array, returns all modeled event types in the stream

@see docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/StartConversationRequestEventStream AWS API Documentation

Public Instance Methods

event_types() click to toggle source
# File lib/aws-sdk-lexruntimev2/types.rb, line 2114
def event_types
  [
    :configuration_event,
    :audio_input_event,
    :dtmf_input_event,
    :text_input_event,
    :playback_completion_event,
    :disconnection_event
  ]
end