aws-sdk-lexruntimev2 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e801189c4920d705ceac9c552854fbe9dc548dd1202b81537350df6597b5062
-  data.tar.gz: 1ab1d32ca002266bb6f2504d55d9641c70cad30bbdf45007b795b96d11d4a05e
+  metadata.gz: e4f67e0ec65e8f812e9ab2670ede53fbf59edd160f531780b2e169cd35aafd32
+  data.tar.gz: 22caedef45d9dd0793432111a3824086149058ead2ae1247808c7dd922fc1838
 SHA512:
-  metadata.gz: f830331fe352b0f5642bbfdcc8e191590d73639ad8962240b50ab75cf13af433836cc0cdee5f8aa25ffd2ccd5422b5e33babe77f4fb6c61c60f6a944cf32a1f6
-  data.tar.gz: ae9d803450d2696c65c8b13a089d342c5369421555b48ff0ee14488edade55fb80ef4091851471af3ca7ea98216b3ea2ec3e483b12d37857886265d2b5dc0c82
+  metadata.gz: 4c11bf12d300e57223445ea5741eb74756179c3f48afe4d51b94f83d336738833b30faa47be389c682c27f525d1ffcb86bd2b36ff7d86e582b4e89e41e272ce9
+  data.tar.gz: 810e0bd6a4c7a27edc08bc65f808bd4b3ea6b2dda715c2ceac6e9a15941b163ab41baedcefc8d987dc2fad3bddf3d611c42d15aa2ba542c2a3556b2374fef988

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 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)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.12.0
+1.13.0

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

@@ -543,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
@@ -635,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.12.0'
+      context[:gem_version] = '1.13.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -511,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
     #
@@ -638,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",
@@ -778,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",
@@ -818,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"
@@ -1053,7 +1087,7 @@ module Aws::LexRuntimeV2
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-lexruntimev2'
-      context[:gem_version] = '1.12.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')
@@ -311,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
@@ -326,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"))
@@ -333,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

@@ -296,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: [
     #           {
@@ -1105,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",
@@ -1271,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",
@@ -1613,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
@@ -1724,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
@@ -1749,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(
@@ -1758,7 +1923,8 @@ module Aws::LexRuntimeV2
       :intent,
       :active_contexts,
       :session_attributes,
-      :originating_request_id)
+      :originating_request_id,
+      :runtime_hints)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2085,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.12.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.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core