Amazon Lex Runtime V2 Update: 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.

Author: AWS

.changes/next-release/feature-AmazonLexRuntimeV2-36e2106.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon Lex Runtime V2",
+    "contributor": "",
+    "description": "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."
+}

services/lexruntimev2/src/main/resources/codegen-resources/service-2.json

@@ -760,6 +760,12 @@
       "member":{"shape":"Message"},
       "max":10
     },
+    "Name":{
+      "type":"string",
+      "max":100,
+      "min":1,
+      "pattern":"^([0-9a-zA-Z][_-]?)+$"
+    },
     "NonEmptyString":{
       "type":"string",
       "min":1
@@ -1111,6 +1117,49 @@
       "error":{"httpStatusCode":404},
       "exception":true
     },
+    "RuntimeHintDetails":{
+      "type":"structure",
+      "required":["runtimeHintValues"],
+      "members":{
+        "runtimeHintValues":{
+          "shape":"RuntimeHintValuesList",
+          "documentation":"<p>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.</p>"
+        }
+      },
+      "documentation":"<p>Provides an array of phrases that should be given preference when resolving values for a slot.</p>"
+    },
+    "RuntimeHintPhrase":{
+      "type":"string",
+      "max":140,
+      "min":1
+    },
+    "RuntimeHintValue":{
+      "type":"structure",
+      "required":["phrase"],
+      "members":{
+        "phrase":{
+          "shape":"RuntimeHintPhrase",
+          "documentation":"<p>The phrase that Amazon Lex V2 should look for in the user's input to the bot.</p>"
+        }
+      },
+      "documentation":"<p>Provides the phrase that Amazon Lex V2 should look for in the user's input to the bot.</p>"
+    },
+    "RuntimeHintValuesList":{
+      "type":"list",
+      "member":{"shape":"RuntimeHintValue"},
+      "max":100,
+      "min":1
+    },
+    "RuntimeHints":{
+      "type":"structure",
+      "members":{
+        "slotHints":{
+          "shape":"SlotHintsIntentMap",
+          "documentation":"<p>A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.</p> <p>The first level of the <code>slotHints</code> map is the name of the intent. The second level is the name of the slot within the intent. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.xml\">Using hints to improve accuracy</a>.</p> <p>The intent name and slot name must exist.</p>"
+        }
+      },
+      "documentation":"<p>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.</p> <p>Before you can use runtime hints with an existing bot, you must first rebuild the bot.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.xml\">Using hints to improve accuracy</a>.</p>"
+    },
     "SensitiveNonEmptyString":{
       "type":"string",
       "sensitive":true
@@ -1184,7 +1233,11 @@
         },
         "originatingRequestId":{
           "shape":"NonEmptyString",
-          "documentation":"<p/>"
+          "documentation":"<p>A unique identifier for a specific request.</p>"
+        },
+        "runtimeHints":{
+          "shape":"RuntimeHints",
+          "documentation":"<p>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.</p>"
         }
       },
       "documentation":"<p>The state of the user's session with Amazon Lex V2.</p>"
@@ -1214,6 +1267,16 @@
       },
       "documentation":"<p>A value that Amazon Lex V2 uses to fulfill an intent. </p>"
     },
+    "SlotHintsIntentMap":{
+      "type":"map",
+      "key":{"shape":"Name"},
+      "value":{"shape":"SlotHintsSlotMap"}
+    },
+    "SlotHintsSlotMap":{
+      "type":"map",
+      "key":{"shape":"Name"},
+      "value":{"shape":"RuntimeHintDetails"}
+    },
     "Slots":{
       "type":"map",
       "key":{"shape":"NonEmptyString"},