aws-sdk-lexruntimev2 1.9.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0181a36bac72a7b6004757b08445c52fa33ba01ca62795e32794612403ff0637'
-  data.tar.gz: 466cf38b55176366a801b0e726ead59b9e04a203d56e3fc09a01e21a2bd808ed
+  metadata.gz: e4f67e0ec65e8f812e9ab2670ede53fbf59edd160f531780b2e169cd35aafd32
+  data.tar.gz: 22caedef45d9dd0793432111a3824086149058ead2ae1247808c7dd922fc1838
 SHA512:
-  metadata.gz: cac42cba5ca6677ccb4b8194e2d7beab5cd2827dae180f362e3edf722e336a67d56c9d99ac8013f39be2e246c12a92e3a1dbe2e568b5f24c3affba1c081d7e7f
-  data.tar.gz: e2fd30914391d91f4571fabf296f6abff7699181ac9fdaeae0e11a6774a41b86030eb933cc561fbddabce52a9b6d7f93a8ff3eac0089746dc5d03b0822562492
+  metadata.gz: 4c11bf12d300e57223445ea5741eb74756179c3f48afe4d51b94f83d336738833b30faa47be389c682c27f525d1ffcb86bd2b36ff7d86e582b4e89e41e272ce9
+  data.tar.gz: 810e0bd6a4c7a27edc08bc65f808bd4b3ea6b2dda715c2ceac6e9a15941b163ab41baedcefc8d987dc2fad3bddf3d611c42d15aa2ba542c2a3556b2374fef988

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Unreleased Changes
 ------------------
 
+1.13.0 (2022-01-13)
+------------------
+
+* Feature - This release adds support for sending hints to Amazon Lex V2 runtime APIs. Bot developers can provide runtime hints to help improve the recognition of slot values.
+
+1.12.0 (2021-12-21)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.11.0 (2021-11-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.10.0 (2021-11-19)
+------------------
+
+* Feature - Now supports styled slots in Lex V2 runtime. Customers can provide inputs like "a as in apple b for beta" which will be resolved to "ab" as slot value.
+
 1.9.0 (2021-11-04)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.9.0
+1.13.0

data/lib/aws-sdk-lexruntimev2/async_client.rb

@@ -23,6 +23,7 @@ require 'aws-sdk-core/plugins/stub_responses.rb'
 require 'aws-sdk-core/plugins/idempotency_token.rb'
 require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/http_checksum.rb'
+require 'aws-sdk-core/plugins/defaults_mode.rb'
 require 'aws-sdk-core/plugins/invocation_id.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
@@ -52,6 +53,7 @@ module Aws::LexRuntimeV2
     add_plugin(Aws::Plugins::IdempotencyToken)
     add_plugin(Aws::Plugins::JsonvalueConverter)
     add_plugin(Aws::Plugins::HttpChecksum)
+    add_plugin(Aws::Plugins::DefaultsMode)
     add_plugin(Aws::Plugins::InvocationId)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::RestJson)
@@ -98,7 +100,9 @@ module Aws::LexRuntimeV2
     #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
     #       are very aggressive. Construct and pass an instance of
     #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
-    #       enable retries and extended timeouts.
+    #       enable retries and extended timeouts. Instance profile credential
+    #       fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
+    #       to true.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -128,6 +132,10 @@ module Aws::LexRuntimeV2
     #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
     #     a clock skew correction and retry requests with skewed client clocks.
     #
+    #   @option options [String] :defaults_mode ("legacy")
+    #     See {Aws::DefaultsModeConfiguration} for a list of the
+    #     accepted modes and the configuration defaults that are included.
+    #
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
@@ -514,6 +522,7 @@ module Aws::LexRuntimeV2
     #   event.interpretations[0].intent.confirmation_state #=> String, one of "Confirmed", "Denied", "None"
     #   event.session_state.dialog_action.type #=> String, one of "Close", "ConfirmIntent", "Delegate", "ElicitIntent", "ElicitSlot", "None"
     #   event.session_state.dialog_action.slot_to_elicit #=> String
+    #   event.session_state.dialog_action.slot_elicitation_style #=> String, one of "Default", "SpellByLetter", "SpellByWord"
     #   event.session_state.intent.name #=> String
     #   event.session_state.intent.slots #=> Hash
     #   event.session_state.intent.slots["NonEmptyString"].value.original_value #=> String
@@ -534,6 +543,10 @@ module Aws::LexRuntimeV2
     #   event.session_state.session_attributes #=> Hash
     #   event.session_state.session_attributes["NonEmptyString"] #=> String
     #   event.session_state.originating_request_id #=> String
+    #   event.session_state.runtime_hints.slot_hints #=> Hash
+    #   event.session_state.runtime_hints.slot_hints["Name"] #=> Hash
+    #   event.session_state.runtime_hints.slot_hints["Name"]["Name"].runtime_hint_values #=> Array
+    #   event.session_state.runtime_hints.slot_hints["Name"]["Name"].runtime_hint_values[0].phrase #=> String
     #   event.request_attributes #=> Hash
     #   event.request_attributes["NonEmptyString"] #=> String
     #   event.session_id #=> String
@@ -626,7 +639,7 @@ module Aws::LexRuntimeV2
         http_response: Seahorse::Client::Http::AsyncResponse.new,
         config: config)
       context[:gem_name] = 'aws-sdk-lexruntimev2'
-      context[:gem_version] = '1.9.0'
+      context[:gem_version] = '1.13.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-lexruntimev2/client.rb

@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
 require 'aws-sdk-core/plugins/http_checksum.rb'
+require 'aws-sdk-core/plugins/defaults_mode.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 require 'aws-sdk-core/plugins/event_stream_configuration.rb'
@@ -74,6 +75,7 @@ module Aws::LexRuntimeV2
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
     add_plugin(Aws::Plugins::HttpChecksum)
+    add_plugin(Aws::Plugins::DefaultsMode)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::RestJson)
     add_plugin(Aws::Plugins::EventStreamConfiguration)
@@ -121,7 +123,9 @@ module Aws::LexRuntimeV2
     #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
     #       are very aggressive. Construct and pass an instance of
     #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
-    #       enable retries and extended timeouts.
+    #       enable retries and extended timeouts. Instance profile credential
+    #       fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
+    #       to true.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -175,6 +179,10 @@ module Aws::LexRuntimeV2
     #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
     #     a clock skew correction and retry requests with skewed client clocks.
     #
+    #   @option options [String] :defaults_mode ("legacy")
+    #     See {Aws::DefaultsModeConfiguration} for a list of the
+    #     accepted modes and the configuration defaults that are included.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -306,7 +314,7 @@ module Aws::LexRuntimeV2
     #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
-    #   @option options [Integer] :http_read_timeout (60) The default
+    #   @option options [Float] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
     #     safely be set per-request on the session.
     #
@@ -322,6 +330,9 @@ module Aws::LexRuntimeV2
     #     disables this behaviour.  This value can safely be set per
     #     request on the session.
     #
+    #   @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
+    #     in seconds.
+    #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
     #
@@ -479,6 +490,7 @@ module Aws::LexRuntimeV2
     #   resp.interpretations[0].intent.confirmation_state #=> String, one of "Confirmed", "Denied", "None"
     #   resp.session_state.dialog_action.type #=> String, one of "Close", "ConfirmIntent", "Delegate", "ElicitIntent", "ElicitSlot", "None"
     #   resp.session_state.dialog_action.slot_to_elicit #=> String
+    #   resp.session_state.dialog_action.slot_elicitation_style #=> String, one of "Default", "SpellByLetter", "SpellByWord"
     #   resp.session_state.intent.name #=> String
     #   resp.session_state.intent.slots #=> Hash
     #   resp.session_state.intent.slots["NonEmptyString"].value.original_value #=> String
@@ -499,6 +511,10 @@ module Aws::LexRuntimeV2
     #   resp.session_state.session_attributes #=> Hash
     #   resp.session_state.session_attributes["NonEmptyString"] #=> String
     #   resp.session_state.originating_request_id #=> String
+    #   resp.session_state.runtime_hints.slot_hints #=> Hash
+    #   resp.session_state.runtime_hints.slot_hints["Name"] #=> Hash
+    #   resp.session_state.runtime_hints.slot_hints["Name"]["Name"].runtime_hint_values #=> Array
+    #   resp.session_state.runtime_hints.slot_hints["Name"]["Name"].runtime_hint_values[0].phrase #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/GetSession AWS API Documentation
     #
@@ -588,6 +604,7 @@ module Aws::LexRuntimeV2
     #       dialog_action: {
     #         type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
     #         slot_to_elicit: "NonEmptyString",
+    #         slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
     #       },
     #       intent: {
     #         name: "NonEmptyString", # required
@@ -625,6 +642,19 @@ module Aws::LexRuntimeV2
     #         "NonEmptyString" => "String",
     #       },
     #       originating_request_id: "NonEmptyString",
+    #       runtime_hints: {
+    #         slot_hints: {
+    #           "Name" => {
+    #             "Name" => {
+    #               runtime_hint_values: [ # required
+    #                 {
+    #                   phrase: "RuntimeHintPhrase", # required
+    #                 },
+    #               ],
+    #             },
+    #           },
+    #         },
+    #       },
     #     },
     #     request_attributes: {
     #       "NonEmptyString" => "String",
@@ -727,6 +757,7 @@ module Aws::LexRuntimeV2
     #       dialog_action: {
     #         type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
     #         slot_to_elicit: "NonEmptyString",
+    #         slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
     #       },
     #       intent: {
     #         name: "NonEmptyString", # required
@@ -764,6 +795,19 @@ module Aws::LexRuntimeV2
     #         "NonEmptyString" => "String",
     #       },
     #       originating_request_id: "NonEmptyString",
+    #       runtime_hints: {
+    #         slot_hints: {
+    #           "Name" => {
+    #             "Name" => {
+    #               runtime_hint_values: [ # required
+    #                 {
+    #                   phrase: "RuntimeHintPhrase", # required
+    #                 },
+    #               ],
+    #             },
+    #           },
+    #         },
+    #       },
     #     },
     #     request_attributes: {
     #       "NonEmptyString" => "String",
@@ -783,6 +827,7 @@ module Aws::LexRuntimeV2
     #   resp.messages[0].image_response_card.buttons[0].value #=> String
     #   resp.session_state.dialog_action.type #=> String, one of "Close", "ConfirmIntent", "Delegate", "ElicitIntent", "ElicitSlot", "None"
     #   resp.session_state.dialog_action.slot_to_elicit #=> String
+    #   resp.session_state.dialog_action.slot_elicitation_style #=> String, one of "Default", "SpellByLetter", "SpellByWord"
     #   resp.session_state.intent.name #=> String
     #   resp.session_state.intent.slots #=> Hash
     #   resp.session_state.intent.slots["NonEmptyString"].value.original_value #=> String
@@ -803,6 +848,10 @@ module Aws::LexRuntimeV2
     #   resp.session_state.session_attributes #=> Hash
     #   resp.session_state.session_attributes["NonEmptyString"] #=> String
     #   resp.session_state.originating_request_id #=> String
+    #   resp.session_state.runtime_hints.slot_hints #=> Hash
+    #   resp.session_state.runtime_hints.slot_hints["Name"] #=> Hash
+    #   resp.session_state.runtime_hints.slot_hints["Name"]["Name"].runtime_hint_values #=> Array
+    #   resp.session_state.runtime_hints.slot_hints["Name"]["Name"].runtime_hint_values[0].phrase #=> String
     #   resp.interpretations #=> Array
     #   resp.interpretations[0].nlu_confidence.score #=> Float
     #   resp.interpretations[0].sentiment_response.sentiment #=> String, one of "MIXED", "NEGATIVE", "NEUTRAL", "POSITIVE"
@@ -1038,7 +1087,7 @@ module Aws::LexRuntimeV2
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-lexruntimev2'
-      context[:gem_version] = '1.9.0'
+      context[:gem_version] = '1.13.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-lexruntimev2/client_api.rb

@@ -66,6 +66,7 @@ module Aws::LexRuntimeV2
     Message = Shapes::StructureShape.new(name: 'Message')
     MessageContentType = Shapes::StringShape.new(name: 'MessageContentType')
     Messages = Shapes::ListShape.new(name: 'Messages')
+    Name = Shapes::StringShape.new(name: 'Name')
     NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
     ParameterName = Shapes::StringShape.new(name: 'ParameterName')
     PlaybackCompletionEvent = Shapes::StructureShape.new(name: 'PlaybackCompletionEvent')
@@ -78,6 +79,11 @@ module Aws::LexRuntimeV2
     RecognizeUtteranceRequest = Shapes::StructureShape.new(name: 'RecognizeUtteranceRequest')
     RecognizeUtteranceResponse = Shapes::StructureShape.new(name: 'RecognizeUtteranceResponse')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
+    RuntimeHintDetails = Shapes::StructureShape.new(name: 'RuntimeHintDetails')
+    RuntimeHintPhrase = Shapes::StringShape.new(name: 'RuntimeHintPhrase')
+    RuntimeHintValue = Shapes::StructureShape.new(name: 'RuntimeHintValue')
+    RuntimeHintValuesList = Shapes::ListShape.new(name: 'RuntimeHintValuesList')
+    RuntimeHints = Shapes::StructureShape.new(name: 'RuntimeHints')
     SensitiveNonEmptyString = Shapes::StringShape.new(name: 'SensitiveNonEmptyString')
     SentimentResponse = Shapes::StructureShape.new(name: 'SentimentResponse')
     SentimentScore = Shapes::StructureShape.new(name: 'SentimentScore')
@@ -86,6 +92,8 @@ module Aws::LexRuntimeV2
     SessionState = Shapes::StructureShape.new(name: 'SessionState')
     Shape = Shapes::StringShape.new(name: 'Shape')
     Slot = Shapes::StructureShape.new(name: 'Slot')
+    SlotHintsIntentMap = Shapes::MapShape.new(name: 'SlotHintsIntentMap')
+    SlotHintsSlotMap = Shapes::MapShape.new(name: 'SlotHintsSlotMap')
     Slots = Shapes::MapShape.new(name: 'Slots')
     StartConversationRequest = Shapes::StructureShape.new(name: 'StartConversationRequest')
     StartConversationRequestEventStream = Shapes::StructureShape.new(name: 'StartConversationRequestEventStream')
@@ -94,6 +102,7 @@ module Aws::LexRuntimeV2
     String = Shapes::StringShape.new(name: 'String')
     StringList = Shapes::ListShape.new(name: 'StringList')
     StringMap = Shapes::MapShape.new(name: 'StringMap')
+    StyleType = Shapes::StringShape.new(name: 'StyleType')
     Text = Shapes::StringShape.new(name: 'Text')
     TextInputEvent = Shapes::StructureShape.new(name: 'TextInputEvent')
     TextResponseEvent = Shapes::StructureShape.new(name: 'TextResponseEvent')
@@ -177,6 +186,7 @@ module Aws::LexRuntimeV2
 
     DialogAction.add_member(:type, Shapes::ShapeRef.new(shape: DialogActionType, required: true, location_name: "type"))
     DialogAction.add_member(:slot_to_elicit, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "slotToElicit"))
+    DialogAction.add_member(:slot_elicitation_style, Shapes::ShapeRef.new(shape: StyleType, location_name: "slotElicitationStyle"))
     DialogAction.struct_class = Types::DialogAction
 
     DisconnectionEvent.add_member(:event_id, Shapes::ShapeRef.new(shape: EventId, location_name: "eventId"))
@@ -309,6 +319,17 @@ module Aws::LexRuntimeV2
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
+    RuntimeHintDetails.add_member(:runtime_hint_values, Shapes::ShapeRef.new(shape: RuntimeHintValuesList, required: true, location_name: "runtimeHintValues"))
+    RuntimeHintDetails.struct_class = Types::RuntimeHintDetails
+
+    RuntimeHintValue.add_member(:phrase, Shapes::ShapeRef.new(shape: RuntimeHintPhrase, required: true, location_name: "phrase"))
+    RuntimeHintValue.struct_class = Types::RuntimeHintValue
+
+    RuntimeHintValuesList.member = Shapes::ShapeRef.new(shape: RuntimeHintValue)
+
+    RuntimeHints.add_member(:slot_hints, Shapes::ShapeRef.new(shape: SlotHintsIntentMap, location_name: "slotHints"))
+    RuntimeHints.struct_class = Types::RuntimeHints
+
     SentimentResponse.add_member(:sentiment, Shapes::ShapeRef.new(shape: SentimentType, location_name: "sentiment"))
     SentimentResponse.add_member(:sentiment_score, Shapes::ShapeRef.new(shape: SentimentScore, location_name: "sentimentScore"))
     SentimentResponse.struct_class = Types::SentimentResponse
@@ -324,6 +345,7 @@ module Aws::LexRuntimeV2
     SessionState.add_member(:active_contexts, Shapes::ShapeRef.new(shape: ActiveContextsList, location_name: "activeContexts"))
     SessionState.add_member(:session_attributes, Shapes::ShapeRef.new(shape: StringMap, location_name: "sessionAttributes"))
     SessionState.add_member(:originating_request_id, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "originatingRequestId"))
+    SessionState.add_member(:runtime_hints, Shapes::ShapeRef.new(shape: RuntimeHints, location_name: "runtimeHints"))
     SessionState.struct_class = Types::SessionState
 
     Slot.add_member(:value, Shapes::ShapeRef.new(shape: Value, location_name: "value"))
@@ -331,6 +353,12 @@ module Aws::LexRuntimeV2
     Slot.add_member(:values, Shapes::ShapeRef.new(shape: Values, location_name: "values"))
     Slot.struct_class = Types::Slot
 
+    SlotHintsIntentMap.key = Shapes::ShapeRef.new(shape: Name)
+    SlotHintsIntentMap.value = Shapes::ShapeRef.new(shape: SlotHintsSlotMap)
+
+    SlotHintsSlotMap.key = Shapes::ShapeRef.new(shape: Name)
+    SlotHintsSlotMap.value = Shapes::ShapeRef.new(shape: RuntimeHintDetails)
+
     Slots.key = Shapes::ShapeRef.new(shape: NonEmptyString)
     Slots.value = Shapes::ShapeRef.new(shape: Slot)
 

data/lib/aws-sdk-lexruntimev2/types.rb

@@ -258,6 +258,7 @@ module Aws::LexRuntimeV2
     #           dialog_action: {
     #             type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
     #             slot_to_elicit: "NonEmptyString",
+    #             slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
     #           },
     #           intent: {
     #             name: "NonEmptyString", # required
@@ -295,6 +296,19 @@ module Aws::LexRuntimeV2
     #             "NonEmptyString" => "String",
     #           },
     #           originating_request_id: "NonEmptyString",
+    #           runtime_hints: {
+    #             slot_hints: {
+    #               "Name" => {
+    #                 "Name" => {
+    #                   runtime_hint_values: [ # required
+    #                     {
+    #                       phrase: "RuntimeHintPhrase", # required
+    #                     },
+    #                   ],
+    #                 },
+    #               },
+    #             },
+    #           },
     #         },
     #         welcome_messages: [
     #           {
@@ -538,6 +552,7 @@ module Aws::LexRuntimeV2
     #       {
     #         type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
     #         slot_to_elicit: "NonEmptyString",
+    #         slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
     #       }
     #
     # @!attribute [rw] type
@@ -562,11 +577,29 @@ module Aws::LexRuntimeV2
     #   The name of the slot that should be elicited from the user.
     #   @return [String]
     #
+    # @!attribute [rw] slot_elicitation_style
+    #   Configures the slot to use spell-by-letter or spell-by-word style.
+    #   When you use a style on a slot, users can spell out their input to
+    #   make it clear to your bot.
+    #
+    #   * Spell by letter - "b" "o" "b"
+    #
+    #   * Spell by word - "b as in boy" "o as in oscar" "b as in boy"
+    #
+    #   For more information, see [ Using spelling to enter slot values
+    #   ][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/lexv2/latest/dg/using-spelling.html
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/DialogAction AWS API Documentation
     #
     class DialogAction < Struct.new(
       :type,
-      :slot_to_elicit)
+      :slot_to_elicit,
+      :slot_elicitation_style)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1047,6 +1080,7 @@ module Aws::LexRuntimeV2
     #           dialog_action: {
     #             type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
     #             slot_to_elicit: "NonEmptyString",
+    #             slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
     #           },
     #           intent: {
     #             name: "NonEmptyString", # required
@@ -1084,6 +1118,19 @@ module Aws::LexRuntimeV2
     #             "NonEmptyString" => "String",
     #           },
     #           originating_request_id: "NonEmptyString",
+    #           runtime_hints: {
+    #             slot_hints: {
+    #               "Name" => {
+    #                 "Name" => {
+    #                   runtime_hint_values: [ # required
+    #                     {
+    #                       phrase: "RuntimeHintPhrase", # required
+    #                     },
+    #                   ],
+    #                 },
+    #               },
+    #             },
+    #           },
     #         },
     #         request_attributes: {
     #           "NonEmptyString" => "String",
@@ -1212,6 +1259,7 @@ module Aws::LexRuntimeV2
     #           dialog_action: {
     #             type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
     #             slot_to_elicit: "NonEmptyString",
+    #             slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
     #           },
     #           intent: {
     #             name: "NonEmptyString", # required
@@ -1249,6 +1297,19 @@ module Aws::LexRuntimeV2
     #             "NonEmptyString" => "String",
     #           },
     #           originating_request_id: "NonEmptyString",
+    #           runtime_hints: {
+    #             slot_hints: {
+    #               "Name" => {
+    #                 "Name" => {
+    #                   runtime_hint_values: [ # required
+    #                     {
+    #                       phrase: "RuntimeHintPhrase", # required
+    #                     },
+    #                   ],
+    #                 },
+    #               },
+    #             },
+    #           },
     #         },
     #         request_attributes: {
     #           "NonEmptyString" => "String",
@@ -1591,6 +1652,112 @@ module Aws::LexRuntimeV2
       include Aws::Structure
     end
 
+    # Provides an array of phrases that should be given preference when
+    # resolving values for a slot.
+    #
+    # @note When making an API call, you may pass RuntimeHintDetails
+    #   data as a hash:
+    #
+    #       {
+    #         runtime_hint_values: [ # required
+    #           {
+    #             phrase: "RuntimeHintPhrase", # required
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] runtime_hint_values
+    #   One or more strings that Amazon Lex V2 should look for in the input
+    #   to the bot. Each phrase is given preference when deciding on slot
+    #   values.
+    #   @return [Array<Types::RuntimeHintValue>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/RuntimeHintDetails AWS API Documentation
+    #
+    class RuntimeHintDetails < Struct.new(
+      :runtime_hint_values)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides the phrase that Amazon Lex V2 should look for in the user's
+    # input to the bot.
+    #
+    # @note When making an API call, you may pass RuntimeHintValue
+    #   data as a hash:
+    #
+    #       {
+    #         phrase: "RuntimeHintPhrase", # required
+    #       }
+    #
+    # @!attribute [rw] phrase
+    #   The phrase that Amazon Lex V2 should look for in the user's input
+    #   to the bot.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/RuntimeHintValue AWS API Documentation
+    #
+    class RuntimeHintValue < Struct.new(
+      :phrase)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # You can provide Amazon Lex V2 with hints to the phrases that a
+    # customer is likely to use for a slot. When a slot with hints is
+    # resolved, the phrases in the runtime hints are preferred in the
+    # resolution. You can provide hints for a maximum of 100 intents. You
+    # can provide a maximum of 100 slots.
+    #
+    # Before you can use runtime hints with an existing bot, you must first
+    # rebuild the bot.
+    #
+    # For more information, see [Using hints to improve accuracy][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.xml
+    #
+    # @note When making an API call, you may pass RuntimeHints
+    #   data as a hash:
+    #
+    #       {
+    #         slot_hints: {
+    #           "Name" => {
+    #             "Name" => {
+    #               runtime_hint_values: [ # required
+    #                 {
+    #                   phrase: "RuntimeHintPhrase", # required
+    #                 },
+    #               ],
+    #             },
+    #           },
+    #         },
+    #       }
+    #
+    # @!attribute [rw] slot_hints
+    #   A list of the slots in the intent that should have runtime hints
+    #   added, and the phrases that should be added for each slot.
+    #
+    #   The first level of the `slotHints` map is the name of the intent.
+    #   The second level is the name of the slot within the intent. For more
+    #   information, see [Using hints to improve accuracy][1].
+    #
+    #   The intent name and slot name must exist.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.xml
+    #   @return [Hash<String,Hash<String,Types::RuntimeHintDetails>>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/RuntimeHints AWS API Documentation
+    #
+    class RuntimeHints < Struct.new(
+      :slot_hints)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Provides information about the sentiment expressed in a user's
     # response in a conversation. Sentiments are determined using Amazon
     # Comprehend. Sentiments are only returned if they are enabled for the
@@ -1664,6 +1831,7 @@ module Aws::LexRuntimeV2
     #         dialog_action: {
     #           type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
     #           slot_to_elicit: "NonEmptyString",
+    #           slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
     #         },
     #         intent: {
     #           name: "NonEmptyString", # required
@@ -1701,6 +1869,19 @@ module Aws::LexRuntimeV2
     #           "NonEmptyString" => "String",
     #         },
     #         originating_request_id: "NonEmptyString",
+    #         runtime_hints: {
+    #           slot_hints: {
+    #             "Name" => {
+    #               "Name" => {
+    #                 runtime_hint_values: [ # required
+    #                   {
+    #                     phrase: "RuntimeHintPhrase", # required
+    #                   },
+    #                 ],
+    #               },
+    #             },
+    #           },
+    #         },
     #       }
     #
     # @!attribute [rw] dialog_action
@@ -1726,8 +1907,15 @@ module Aws::LexRuntimeV2
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] originating_request_id
+    #   A unique identifier for a specific request.
     #   @return [String]
     #
+    # @!attribute [rw] runtime_hints
+    #   Hints for phrases that a customer is likely to use for a slot.
+    #   Amazon Lex V2 uses the hints to help determine the correct value of
+    #   a slot.
+    #   @return [Types::RuntimeHints]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/SessionState AWS API Documentation
     #
     class SessionState < Struct.new(
@@ -1735,7 +1923,8 @@ module Aws::LexRuntimeV2
       :intent,
       :active_contexts,
       :session_attributes,
-      :originating_request_id)
+      :originating_request_id,
+      :runtime_hints)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2024,6 +2213,7 @@ module Aws::LexRuntimeV2
     #             dialog_action: {
     #               type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
     #               slot_to_elicit: "NonEmptyString",
+    #               slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
     #             },
     #             intent: {
     #               name: "NonEmptyString", # required
@@ -2061,6 +2251,19 @@ module Aws::LexRuntimeV2
     #               "NonEmptyString" => "String",
     #             },
     #             originating_request_id: "NonEmptyString",
+    #             runtime_hints: {
+    #               slot_hints: {
+    #                 "Name" => {
+    #                   "Name" => {
+    #                     runtime_hint_values: [ # required
+    #                       {
+    #                         phrase: "RuntimeHintPhrase", # required
+    #                       },
+    #                     ],
+    #                   },
+    #                 },
+    #               },
+    #             },
     #           },
     #           welcome_messages: [
     #             {

data/lib/aws-sdk-lexruntimev2.rb

@@ -50,6 +50,6 @@ require_relative 'aws-sdk-lexruntimev2/event_streams'
 # @!group service
 module Aws::LexRuntimeV2
 
-  GEM_VERSION = '1.9.0'
+  GEM_VERSION = '1.13.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-lexruntimev2
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.122.0
+        version: 3.125.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.122.0
+        version: 3.125.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement