class Aws::LexRuntimeV2::Types::ConfigurationEvent
The initial event sent from the application to Amazon Lex V2 to configure the conversation, including session and request attributes and the response content type.
@note When making an API call, you may pass ConfigurationEvent
data as a hash: { 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, }
@!attribute [rw] 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:`. @return [Hash<String,String>]
@!attribute [rw] 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 @return [String]
@!attribute [rw] session_state
The state of the user's session with Amazon Lex V2. @return [Types::SessionState]
@!attribute [rw] welcome_messages
A list of messages to send to the user. @return [Array<Types::Message>]
@!attribute [rw] 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. @return [Boolean]
@!attribute [rw] event_id
A unique identifier that your application assigns to the event. You can use this to identify events in logs. @return [String]
@!attribute [rw] client_timestamp_millis
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2. @return [Integer]
@see docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/ConfigurationEvent AWS API Documentation
Constants
- SENSITIVE