Amazon Lex Model Building Service Update: Amazon Lex supports managing input and output contexts as well as default values for slots.

Author: AWS

.changes/next-release/feature-AmazonLexModelBuildingService-6034543.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon Lex Model Building Service",
+    "contributor": "",
+    "description": "Amazon Lex supports managing input and output contexts as well as default values for slots."
+}

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

@@ -979,6 +979,16 @@
         "CustomPayload"
       ]
     },
+    "ContextTimeToLiveInSeconds":{
+      "type":"integer",
+      "max":86400,
+      "min":5
+    },
+    "ContextTurnsToLive":{
+      "type":"integer",
+      "max":20,
+      "min":1
+    },
     "ConversationLogsRequest":{
       "type":"structure",
       "required":[
@@ -1183,6 +1193,14 @@
         "kendraConfiguration":{
           "shape":"KendraConfiguration",
           "documentation":"<p>Configuration information, if any, for connecting an Amazon Kendra index with the <code>AMAZON.KendraSearchIntent</code> intent.</p>"
+        },
+        "inputContexts":{
+          "shape":"InputContextList",
+          "documentation":"<p>An array of <code>InputContext</code> objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.</p>"
+        },
+        "outputContexts":{
+          "shape":"OutputContextList",
+          "documentation":"<p>An array of <code>OutputContext</code> objects that lists the contexts that the intent activates when the intent is fulfilled.</p>"
         }
       }
     },
@@ -2216,6 +2234,14 @@
         "kendraConfiguration":{
           "shape":"KendraConfiguration",
           "documentation":"<p>Configuration information, if any, to connect to an Amazon Kendra index with the <code>AMAZON.KendraSearchIntent</code> intent.</p>"
+        },
+        "inputContexts":{
+          "shape":"InputContextList",
+          "documentation":"<p>An array of <code>InputContext</code> objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.</p>"
+        },
+        "outputContexts":{
+          "shape":"OutputContextList",
+          "documentation":"<p>An array of <code>OutputContext</code> objects that lists the contexts that the intent activates when the intent is fulfilled.</p>"
         }
       }
     },
@@ -2492,6 +2518,29 @@
         "FAILED"
       ]
     },
+    "InputContext":{
+      "type":"structure",
+      "required":["name"],
+      "members":{
+        "name":{
+          "shape":"InputContextName",
+          "documentation":"<p>The name of the context.</p>"
+        }
+      },
+      "documentation":"<p>The name of a context that must be active for an intent to be selected by Amazon Lex.</p>"
+    },
+    "InputContextList":{
+      "type":"list",
+      "member":{"shape":"InputContext"},
+      "max":5,
+      "min":0
+    },
+    "InputContextName":{
+      "type":"string",
+      "max":100,
+      "min":1,
+      "pattern":"^([A-Za-z]_?)+$"
+    },
     "Intent":{
       "type":"structure",
       "required":[
@@ -2810,6 +2859,41 @@
         "DEFAULT_OBFUSCATION"
       ]
     },
+    "OutputContext":{
+      "type":"structure",
+      "required":[
+        "name",
+        "timeToLiveInSeconds",
+        "turnsToLive"
+      ],
+      "members":{
+        "name":{
+          "shape":"OutputContextName",
+          "documentation":"<p>The name of the context.</p>"
+        },
+        "timeToLiveInSeconds":{
+          "shape":"ContextTimeToLiveInSeconds",
+          "documentation":"<p>The number of seconds that the context should be active after it is first sent in a <code>PostContent</code> or <code>PostText</code> response. You can set the value between 5 and 86,400 seconds (24 hours).</p>"
+        },
+        "turnsToLive":{
+          "shape":"ContextTurnsToLive",
+          "documentation":"<p>The number of conversation turns that the context should be active. A conversation turn is one <code>PostContent</code> or <code>PostText</code> request and the corresponding response from Amazon Lex.</p>"
+        }
+      },
+      "documentation":"<p>The specification of an output context that is set when an intent is fulfilled.</p>"
+    },
+    "OutputContextList":{
+      "type":"list",
+      "member":{"shape":"OutputContext"},
+      "max":10,
+      "min":0
+    },
+    "OutputContextName":{
+      "type":"string",
+      "max":100,
+      "min":1,
+      "pattern":"^([A-Za-z]_?)+$"
+    },
     "PreconditionFailedException":{
       "type":"structure",
       "members":{
@@ -2965,11 +3049,11 @@
         },
         "enableModelImprovements":{
           "shape":"Boolean",
-          "documentation":"<p>Set to <code>true</code> to enable access to natural language understanding improvements. </p> <p>When you set the <code>enableModelImprovements</code> parameter to <code>true</code> you can use the <code>nluIntentConfidenceThreshold</code> parameter to configure confidence scores. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html\">Confidence Scores</a>.</p> <p>You can only set the <code>enableModelImprovements</code> parameter in certain Regions. If you set the parameter to <code>true</code>, your bot has access to accuracy improvements.</p> <p>The Regions where you can set the <code>enableModelImprovements</code> parameter to <code>true</code> are:</p> <ul> <li> <p>US East (N. Virginia) (us-east-1)</p> </li> <li> <p>US West (Oregon) (us-west-2)</p> </li> <li> <p>Asia Pacific (Sydney) (ap-southeast-2)</p> </li> <li> <p>EU (Ireland) (eu-west-1)</p> </li> </ul> <p>In other Regions, the <code>enableModelImprovements</code> parameter is set to <code>true</code> by default. In these Regions setting the parameter to <code>false</code> throws a <code>ValidationException</code> exception.</p> <ul> <li> <p>Asia Pacific (Singapore) (ap-southeast-1)</p> </li> <li> <p>Asia Pacific (Tokyo) (ap-northeast-1)</p> </li> <li> <p>EU (Frankfurt) (eu-central-1)</p> </li> <li> <p>EU (London) (eu-west-2)</p> </li> </ul>"
+          "documentation":"<p>Set to <code>true</code> to enable access to natural language understanding improvements. </p> <p>When you set the <code>enableModelImprovements</code> parameter to <code>true</code> you can use the <code>nluIntentConfidenceThreshold</code> parameter to configure confidence scores. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html\">Confidence Scores</a>.</p> <p>You can only set the <code>enableModelImprovements</code> parameter in certain Regions. If you set the parameter to <code>true</code>, your bot has access to accuracy improvements.</p> <p>The Regions where you can set the <code>enableModelImprovements</code> parameter to <code>true</code> are:</p> <ul> <li> <p>US East (N. Virginia) (us-east-1)</p> </li> <li> <p>US West (Oregon) (us-west-2)</p> </li> <li> <p>Asia Pacific (Sydney) (ap-southeast-2)</p> </li> <li> <p>EU (Ireland) (eu-west-1)</p> </li> </ul> <p>In other Regions, the <code>enableModelImprovements</code> parameter is set to <code>true</code> by default. In these Regions setting the parameter to <code>false</code> throws a <code>ValidationException</code> exception.</p>"
         },
         "nluIntentConfidenceThreshold":{
           "shape":"ConfidenceThreshold",
-          "documentation":"<p>Determines the threshold where Amazon Lex will insert the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents in a <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html\">PostContent</a> or <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html\">PostText</a> response. <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> are only inserted if they are configured for the bot.</p> <p>You must set the <code>enableModelImprovements</code> parameter to <code>true</code> to use confidence scores.</p> <ul> <li> <p>US East (N. Virginia) (us-east-1)</p> </li> <li> <p>US West (Oregon) (us-west-2)</p> </li> <li> <p>Asia Pacific (Sydney) (ap-southeast-2)</p> </li> <li> <p>EU (Ireland) (eu-west-1)</p> </li> </ul> <p>In other Regions, the <code>enableModelImprovements</code> parameter is set to <code>true</code> by default.</p> <p>For example, suppose a bot is configured with the confidence threshold of 0.80 and the <code>AMAZON.FallbackIntent</code>. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the <code>PostText</code> operation would be:</p> <ul> <li> <p>AMAZON.FallbackIntent</p> </li> <li> <p>IntentA</p> </li> <li> <p>IntentB</p> </li> <li> <p>IntentC</p> </li> </ul>"
+          "documentation":"<p>Determines the threshold where Amazon Lex will insert the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents in a <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html\">PostContent</a> or <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html\">PostText</a> response. <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> are only inserted if they are configured for the bot.</p> <p>You must set the <code>enableModelImprovements</code> parameter to <code>true</code> to use confidence scores in the following regions.</p> <ul> <li> <p>US East (N. Virginia) (us-east-1)</p> </li> <li> <p>US West (Oregon) (us-west-2)</p> </li> <li> <p>Asia Pacific (Sydney) (ap-southeast-2)</p> </li> <li> <p>EU (Ireland) (eu-west-1)</p> </li> </ul> <p>In other Regions, the <code>enableModelImprovements</code> parameter is set to <code>true</code> by default.</p> <p>For example, suppose a bot is configured with the confidence threshold of 0.80 and the <code>AMAZON.FallbackIntent</code>. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the <code>PostText</code> operation would be:</p> <ul> <li> <p>AMAZON.FallbackIntent</p> </li> <li> <p>IntentA</p> </li> <li> <p>IntentB</p> </li> <li> <p>IntentC</p> </li> </ul>"
         },
         "clarificationPrompt":{
           "shape":"Prompt",
@@ -3163,6 +3247,14 @@
         "kendraConfiguration":{
           "shape":"KendraConfiguration",
           "documentation":"<p>Configuration information required to use the <code>AMAZON.KendraSearchIntent</code> intent to connect to an Amazon Kendra index. For more information, see <a href=\"http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html\"> AMAZON.KendraSearchIntent</a>.</p>"
+        },
+        "inputContexts":{
+          "shape":"InputContextList",
+          "documentation":"<p>An array of <code>InputContext</code> objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.</p>"
+        },
+        "outputContexts":{
+          "shape":"OutputContextList",
+          "documentation":"<p>An array of <code>OutputContext</code> objects that lists the contexts that the intent activates when the intent is fulfilled.</p>"
         }
       }
     },
@@ -3236,6 +3328,14 @@
         "kendraConfiguration":{
           "shape":"KendraConfiguration",
           "documentation":"<p>Configuration information, if any, required to connect to an Amazon Kendra index and use the <code>AMAZON.KendraSearchIntent</code> intent.</p>"
+        },
+        "inputContexts":{
+          "shape":"InputContextList",
+          "documentation":"<p>An array of <code>InputContext</code> objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.</p>"
+        },
+        "outputContexts":{
+          "shape":"OutputContextList",
+          "documentation":"<p>An array of <code>OutputContext</code> objects that lists the contexts that the intent activates when the intent is fulfilled.</p>"
         }
       }
     },
@@ -3444,6 +3544,10 @@
         "obfuscationSetting":{
           "shape":"ObfuscationSetting",
           "documentation":"<p>Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is \"full_name\", obfuscated values are replaced with \"{full_name}\". For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html\"> Slot Obfuscation </a>. </p>"
+        },
+        "defaultValueSpec":{
+          "shape":"SlotDefaultValueSpec",
+          "documentation":"<p>A list of default values for the slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.</p>"
         }
       },
       "documentation":"<p>Identifies the version of a specific slot.</p>"
@@ -3455,6 +3559,39 @@
         "Optional"
       ]
     },
+    "SlotDefaultValue":{
+      "type":"structure",
+      "required":["defaultValue"],
+      "members":{
+        "defaultValue":{
+          "shape":"SlotDefaultValueString",
+          "documentation":"<p>The default value for the slot. You can specify one of the following:</p> <ul> <li> <p> <code>#context-name.slot-name</code> - The slot value \"slot-name\" in the context \"context-name.\"</p> </li> <li> <p> <code>{attribute}</code> - The slot value of the session attribute \"attribute.\"</p> </li> <li> <p> <code>'value'</code> - The discrete value \"value.\"</p> </li> </ul>"
+        }
+      },
+      "documentation":"<p>A default value for a slot.</p>"
+    },
+    "SlotDefaultValueList":{
+      "type":"list",
+      "member":{"shape":"SlotDefaultValue"},
+      "max":10,
+      "min":0
+    },
+    "SlotDefaultValueSpec":{
+      "type":"structure",
+      "required":["defaultValueList"],
+      "members":{
+        "defaultValueList":{
+          "shape":"SlotDefaultValueList",
+          "documentation":"<p>The default values for a slot. You can specify more than one default. For example, you can specify a default value to use from a matching context variable, a session attribute, or a fixed value.</p> <p>The default value chosen is selected based on the order that you specify them in the list. For example, if you specify a context variable and a fixed value in that order, Amazon Lex uses the context variable if it is available, else it uses the fixed value.</p>"
+        }
+      },
+      "documentation":"<p>Contains the default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot.</p>"
+    },
+    "SlotDefaultValueString":{
+      "type":"string",
+      "max":202,
+      "min":1
+    },
     "SlotList":{
       "type":"list",
       "member":{"shape":"Slot"},