aws-lex-conversation 3.1.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff0a95434c51f2167b1bb1fb891b650ffa120aaa91ac31dbf016fae8e590f7da
-  data.tar.gz: 20df3f469a293b19d0ec3d1bea8e0c549897141a30bad818d1c3f6f25dcf98e3
+  metadata.gz: 9735c51e883e99b06c28d4c979b52eb5f5bffe95dcb5bb1eebb138b16ef3aa21
+  data.tar.gz: 2cbfd1b527fb7058a7b496d9099edd78087eb69b928ebbc073c9d81bbdf35d80
 SHA512:
-  metadata.gz: f935b611747cbf6484f50058eeea3db776eb47fb901ac1be240e0362677c1ddca1fe99e638df6601bacd316975da6182e83edd0707e2f5ef1a65e157d3816da1
-  data.tar.gz: d8ca9865f6981a0b6e5d233681b95ce995cae0821f6ef29b9395d379bb88d5bfe0687ee1c62728ea7bbdd785e0c9f5434720921f8c4df45076d51ebecaf4795e
+  metadata.gz: 263f7eafd97d6c58cd93dcafd8652686e3a6a9909906d6c3bb65ac6e165cf4f94670e3f2f2dc38838758e19e85cfb0ed3806eff5b7521a6184bdbccf296aaeda
+  data.tar.gz: 1b9096daf68a211f23c678da9a36fe4e92aa4cacd5c362f79020698870dfcacc2ace8d152b2260dc9f5390e8e4195a07b34c15cf76e4df56e3619e6c50043feb

data/CHANGELOG.md

@@ -1,3 +1,47 @@
+# 4.1.0 - July 21, 2021
+
+* Don't set the `intent` property in the response for `ElicitIntent`
+  actions as the field is optional as per [AWS documentation](https://docs.aws.amazon.com/lexv2/latest/dg/lambda.html#lambda-response-format).
+* Add `InProgress` and `ReadyForFulfillment` enumerations to `FulfillmentState`.
+
+# 4.0.1 - July 16, 2021
+
+* Fix a bug with the `Aws::Lex::Conversation::Handler::Echo` class because it
+  didn't correctly return an array of messages required for Lex V2.
+* Drop a call to `Hash#deep_symbolize_keys` so we don't implicitly rely on
+  ActiveSupport.
+* Call `Hash#compact` when transforming a Lex response so we don't include any
+  `nil` values in the response.
+
+# 4.0.0 - July 14, 2021
+
+**breaking change** - Drop support for the Lex runtime version 1. If you are using Lex Version 1, please lock this gem to `~> 3.0.0`.
+**breaking change** - Implement support and types for [Lex Version 2](https://docs.aws.amazon.com/lexv2/latest/dg/what-is.html), which implements a new Lambda [input/output event format](https://docs.aws.amazon.com/lexv2/latest/dg/lambda.html#lambda-input-format).
+
+# 3.1.0 - June 1, 2021
+
+* Default both `request_attributes` and `session_attributes`
+  to an empty Hash when the values from the event are `null`.
+  It is much easier to reason and write logic when you can
+  assume that these values are always at least a hash.
+
+# 3.0.0 - May 20, 2021
+
+* **breaking change** - Don't pass the `recentIntentSummaryView` back
+  in the Lex response unless we have modified or added an existing
+  checkpoint. Lex will persist the previous intent summary/history
+  if we do not send a `recentIntentSummaryView` value back in the
+  response (see [1]).
+* Add a few helper methods to the `Aws::Lex::Conversation::Type::Slot`
+  instances:
+
+  - `active?`: returns true if the slot is defined (either optional or
+             required) for the current intent.
+  - `requestable?`: returns true if the slot is active for the current
+                  intent and it is not filled.
+
+[1]: https://docs.aws.amazon.com/lex/latest/dg/lambda-input-response-format.html#lambda-response-recentIntentSummaryView
+
 # 2.0.0 - August 19, 2020
 
 * **breaking change:** Rename `Aws::Lex::Conversation::Type::CurrentIntent` to `Aws::Lex::Conversation::Type::Intent`.

data/README.md

@@ -6,10 +6,30 @@ Have you played around with [AWS Lex](https://aws.amazon.com/lex/) and quickly r
 
 ## Installation
 
+### Lex V1
+
+Version 3.x is the last major version of this gem that will support Lex V1.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aws-lex-conversation', '~> 3.0'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+### Lex V2
+
+Version 4.x and higher support Lex V2.
+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'aws-lex-conversation'
+gem 'aws-lex-conversation', '>= 4.0'
 ```
 
 And then execute:
@@ -73,15 +93,17 @@ class SayHello < Aws::Lex::Conversation::Handler::Base
     #
     # conversation.close(
     #   fulfillment_state: 'Fulfilled',
-    #   message: { content: "Hello, #{name}!", contentType: 'PlainText' }
+    #   messages: [{ content: "Hello, #{name}!", contentType: 'PlainText' }]
     # )
     #
     conversation.close(
       fulfillment_state: Aws::Lex::Conversation::Type::FulfillmentState.new('Fulfilled'),
-      message: Aws::Lex::Conversation::Type::Message.new(
-        content: "Hello, #{name}!",
-        content_type: Aws::Lex::Conversation::Type::Message::ContentType.new('PlainText')
-      )
+      messages: [
+        Aws::Lex::Conversation::Type::Message.new(
+          content: "Hello, #{name}!",
+          content_type: Aws::Lex::Conversation::Type::Message::ContentType.new('PlainText')
+        )
+      ]
     )
   end
 end

data/lib/aws/lex/conversation.rb

@@ -55,52 +55,40 @@ module Aws
       end
 
       def session
-        lex.session_attributes
+        lex.session_state.session_attributes
       end
 
-      # rubocop:disable Metrics/AbcSize
       def checkpoint!(opts = {})
         label = opts.fetch(:label)
-        intent = opts.fetch(:intent_name) { intent_name }
         params = {
-          checkpoint_label: label,
-          confirmation_status: opts.fetch(:confirmation_status) { lex.current_intent.confirmation_status },
+          label: label,
           dialog_action_type: opts.fetch(:dialog_action_type),
           fulfillment_state: opts[:fulfillment_state],
-          intent_name: intent,
-          slots: opts.fetch(:slots) { lex.current_intent.raw_slots },
+          intent: lex.current_intent,
           slot_to_elicit: opts[:slot_to_elicit]
         }.compact
 
-        # flag that we need to send a new checkpoint back in the response
-        stash[:checkpoint_pending] = true
-
         if checkpoint?(label: label)
           # update the existing checkpoint
           checkpoint(label: label).assign_attributes!(params)
         else
           # push a new checkpoint to the recent_intent_summary_view
-          lex.recent_intent_summary_view.unshift(
-            Type::RecentIntentSummaryView.new(params)
+          checkpoints.unshift(
+            Type::Checkpoint.new(params)
           )
         end
       end
-      # rubocop:enable Metrics/AbcSize
 
       def checkpoint?(label:)
         !checkpoint(label: label).nil?
       end
 
       def checkpoint(label:)
-        lex.recent_intent_summary_view.find { |v| v.checkpoint_label == label }
+        checkpoints.find { |v| v.label == label }
       end
 
-      # NOTE: lex responses should only include a recent_intent_summary_view
-      # block if we want to change/add an existing checkpoint. If we don't
-      # send a recent_intent_summary_view back in the response, lex retains
-      # the previous intent history.
-      def pending_checkpoints
-        stash[:checkpoint_pending] && lex.recent_intent_summary_view
+      def checkpoints
+        lex.session_state.session_attributes.checkpoints
       end
 
       def stash

data/lib/aws/lex/conversation/base.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'base64'
 require 'json'
 require 'shrink/wrap'
 
@@ -18,29 +19,31 @@ require_relative 'slot/elicitation'
 require_relative 'slot/elicitor'
 require_relative 'type/base'
 require_relative 'type/enumeration'
-require_relative 'type/sentiment_label'
+require_relative 'type/input_mode'
+require_relative 'type/sentiment'
 require_relative 'type/sentiment_score'
 require_relative 'type/sentiment_response'
 require_relative 'type/invocation_source'
 require_relative 'type/dialog_action_type'
-require_relative 'type/confirmation_status'
+require_relative 'type/dialog_action'
+require_relative 'type/confirmation_state'
 require_relative 'type/fulfillment_state'
 require_relative 'type/intent_confidence'
 require_relative 'type/time_to_live'
-require_relative 'type/recent_intent_summary_view'
+require_relative 'type/slot_shape'
+require_relative 'type/slot_value'
 require_relative 'type/slot'
-require_relative 'type/slot_resolution'
-require_relative 'type/slot_detail'
 require_relative 'type/context'
 require_relative 'type/intent'
-require_relative 'type/output_dialog_mode'
+require_relative 'type/checkpoint'
+require_relative 'type/session_attributes'
+require_relative 'type/session_state'
+require_relative 'type/interpretation'
 require_relative 'type/bot'
-require_relative 'type/message/content_type'
-require_relative 'type/message'
-require_relative 'type/response_card/content_type'
 require_relative 'type/response_card/button'
-require_relative 'type/response_card/generic_attachment'
 require_relative 'type/response_card'
+require_relative 'type/message/content_type'
+require_relative 'type/message'
 require_relative 'type/response'
 require_relative 'type/event'
 require_relative 'handler/base'

data/lib/aws/lex/conversation/handler/delegate.rb

@@ -6,9 +6,7 @@ module Aws
       module Handler
         class Delegate < Base
           def response(conversation)
-            conversation.delegate(
-              slots: conversation.lex.current_intent.slots
-            )
+            conversation.delegate
           end
         end
       end

data/lib/aws/lex/conversation/handler/echo.rb

@@ -11,10 +11,12 @@ module Aws
             fulfillment_state = options.fetch(:fulfillment_state) { Type::FulfillmentState.new('Fulfilled') }
             conversation.close(
               fulfillment_state: fulfillment_state,
-              message: Type::Message.new(
-                content: content,
-                content_type: content_type
-              )
+              messages: [
+                Type::Message.new(
+                  content: content,
+                  content_type: content_type
+                )
+              ]
             )
           end
         end

data/lib/aws/lex/conversation/response/base.rb

@@ -6,15 +6,17 @@ module Aws
       module Response
         class Base
           attr_accessor(
-            :active_contexts,
-            :recent_intent_summary_view,
-            :session_attributes
+            :session_state,
+            :messages,
+            :request_attributes,
+            :fulfillment_state
           )
 
           def initialize(opts = {})
-            self.active_contexts = opts[:active_contexts]
-            self.recent_intent_summary_view = opts[:recent_intent_summary_view]
-            self.session_attributes = opts[:session_attributes]
+            self.session_state = opts[:session_state]
+            self.messages = opts[:messages]
+            self.request_attributes = opts[:request_attributes]
+            session_state.intent.state = opts.fetch(:fulfillment_state) { session_state.intent.state }
           end
 
           def dialog_action
@@ -23,10 +25,9 @@ module Aws
 
           def to_lex
             Type::Response.new(
-              active_contexts: active_contexts,
-              dialog_action: dialog_action,
-              recent_intent_summary_view: recent_intent_summary_view,
-              session_attributes: session_attributes
+              session_state: session_state,
+              messages: messages,
+              request_attributes: request_attributes
             ).to_lex
           end
         end

data/lib/aws/lex/conversation/response/close.rb

@@ -5,22 +5,16 @@ module Aws
     class Conversation
       module Response
         class Close < Base
-          attr_accessor :fulfillment_state, :message, :response_card
-
           def initialize(opts = {})
             super
-            self.fulfillment_state = opts.fetch(:fulfillment_state)
-            self.message = opts[:message]
-            self.response_card = opts[:response_card]
+            session_state.dialog_action = dialog_action
+            session_state.intent.state = opts.fetch(:fulfillment_state)
           end
 
           def dialog_action
-            {
-              type: 'Close',
-              fulfillmentState: fulfillment_state,
-              message: message,
-              responseCard: response_card
-            }.compact
+            Aws::Lex::Conversation::Type::DialogAction.shrink_wrap(
+              type: 'Close'
+            )
           end
         end
       end

data/lib/aws/lex/conversation/response/confirm_intent.rb

@@ -5,24 +5,15 @@ module Aws
     class Conversation
       module Response
         class ConfirmIntent < Base
-          attr_accessor :intent_name, :message, :response_card, :slots
-
           def initialize(opts = {})
             super
-            self.intent_name = opts.fetch(:intent_name)
-            self.slots = opts[:slots]
-            self.message = opts[:message]
-            self.response_card = opts[:response_card]
+            session_state.dialog_action = dialog_action
           end
 
           def dialog_action
-            {
-              type: 'ConfirmIntent',
-              intentName: intent_name,
-              slots: slots,
-              message: message,
-              responseCard: response_card
-            }.compact
+            Aws::Lex::Conversation::Type::DialogAction.shrink_wrap(
+              type: 'ConfirmIntent'
+            )
           end
         end
       end

data/lib/aws/lex/conversation/response/delegate.rb

@@ -5,22 +5,15 @@ module Aws
     class Conversation
       module Response
         class Delegate < Base
-          attr_accessor :slots, :kendra_query_request_payload, :kendra_query_filter_string
-
           def initialize(opts = {})
             super
-            self.slots = opts[:slots]
-            self.kendra_query_request_payload = opts[:kendra_query_request_payload]
-            self.kendra_query_filter_string = opts[:kendra_query_filter_string]
+            session_state.dialog_action = dialog_action
           end
 
           def dialog_action
-            {
-              type: 'Delegate',
-              slots: slots,
-              kendraQueryRequestPayload: kendra_query_request_payload,
-              kendraQueryFilterString: kendra_query_filter_string
-            }.compact
+            Aws::Lex::Conversation::Type::DialogAction.shrink_wrap(
+              type: 'Delegate'
+            )
           end
         end
       end

data/lib/aws/lex/conversation/response/elicit_intent.rb

@@ -9,16 +9,15 @@ module Aws
 
           def initialize(opts = {})
             super
-            self.message = opts[:message]
-            self.response_card = opts[:response_card]
+            session_state.dialog_action = dialog_action
+            # by default, we set intent as nil unless overridden
+            session_state.intent = opts[:intent]
           end
 
           def dialog_action
-            {
-              type: 'ElicitIntent',
-              message: message,
-              responseCard: response_card
-            }.compact
+            Aws::Lex::Conversation::Type::DialogAction.shrink_wrap(
+              type: 'ElicitIntent'
+            )
           end
         end
       end

data/lib/aws/lex/conversation/response/elicit_slot.rb

@@ -5,26 +5,19 @@ module Aws
     class Conversation
       module Response
         class ElicitSlot < Base
-          attr_accessor :intent_name, :message, :response_card, :slots, :slot_to_elicit
+          attr_accessor :slot_to_elicit
 
           def initialize(opts = {})
             super
-            self.intent_name = opts.fetch(:intent_name)
             self.slot_to_elicit = opts.fetch(:slot_to_elicit)
-            self.slots = opts.fetch(:slots)
-            self.message = opts[:message]
-            self.response_card = opts[:response_card]
+            session_state.dialog_action = dialog_action
           end
 
           def dialog_action
-            {
+            Aws::Lex::Conversation::Type::DialogAction.shrink_wrap(
               type: 'ElicitSlot',
-              intentName: intent_name,
-              slots: slots,
-              slotToElicit: slot_to_elicit,
-              message: message,
-              responseCard: response_card
-            }.compact
+              slotToElicit: slot_to_elicit
+            )
           end
         end
       end

data/lib/aws/lex/conversation/slot/elicitation.rb

@@ -27,10 +27,12 @@ module Aws
             increment_slot_elicitations!
             conversation.elicit_slot(
               slot_to_elicit: name,
-              message: {
-                contentType: content_type,
-                content: elicitation_content
-              }
+              messages: [
+                {
+                  contentType: content_type,
+                  content: elicitation_content
+                }
+              ]
             )
           end