Skip to content

Commit 78ef1c6

Browse files
author
AWS
committed
Amazon Lex Runtime Service Update: Amazon Lex now supports the ability to view and manage active contexts associated with a user session.
1 parent 8901298 commit 78ef1c6

File tree

2 files changed

+123
-4
lines changed

2 files changed

+123
-4
lines changed

‎.changes/next-release/feature-AmazonLexRuntimeService-4dcd6ec.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Lex Runtime Service",
4+
"contributor": "",
5+
"description": "Amazon Lex now supports the ability to view and manage active contexts associated with a user session."
6+
}

‎services/lexruntime/src/main/resources/codegen-resources/service-2.json

Lines changed: 117 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,77 @@
112112
},
113113
"shapes":{
114114
"Accept":{"type":"string"},
115+
"ActiveContext":{
116+
"type":"structure",
117+
"required":[
118+
"name",
119+
"timeToLive",
120+
"parameters"
121+
],
122+
"members":{
123+
"name":{
124+
"shape":"ActiveContextName",
125+
"documentation":"<p>The name of the context.</p>"
126+
},
127+
"timeToLive":{
128+
"shape":"ActiveContextTimeToLive",
129+
"documentation":"<p>The length of time or number of turns that a context remains active.</p>"
130+
},
131+
"parameters":{
132+
"shape":"ActiveContextParametersMap",
133+
"documentation":"<p>State variables for the current context. You can use these values as default values for slots in subsequent events.</p>"
134+
}
135+
},
136+
"documentation":"<p>A context is a variable that contains information about the current state of the conversation between a user and Amazon Lex. Context can be set automatically by Amazon Lex when an intent is fulfilled, or it can be set at runtime using the <code>PutContent</code>, <code>PutText</code>, or <code>PutSession</code> operation.</p>"
137+
},
138+
"ActiveContextName":{
139+
"type":"string",
140+
"max":100,
141+
"min":1,
142+
"pattern":"^([A-Za-z]_?)+$"
143+
},
144+
"ActiveContextParametersMap":{
145+
"type":"map",
146+
"key":{"shape":"ParameterName"},
147+
"value":{"shape":"Text"},
148+
"max":10,
149+
"min":0
150+
},
151+
"ActiveContextTimeToLive":{
152+
"type":"structure",
153+
"members":{
154+
"timeToLiveInSeconds":{
155+
"shape":"ActiveContextTimeToLiveInSeconds",
156+
"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>"
157+
},
158+
"turnsToLive":{
159+
"shape":"ActiveContextTurnsToLive",
160+
"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>"
161+
}
162+
},
163+
"documentation":"<p>The length of time or number of turns that a context remains active.</p>"
164+
},
165+
"ActiveContextTimeToLiveInSeconds":{
166+
"type":"integer",
167+
"max":86400,
168+
"min":5
169+
},
170+
"ActiveContextTurnsToLive":{
171+
"type":"integer",
172+
"max":20,
173+
"min":1
174+
},
175+
"ActiveContextsList":{
176+
"type":"list",
177+
"member":{"shape":"ActiveContext"},
178+
"max":20,
179+
"min":0,
180+
"sensitive":true
181+
},
182+
"ActiveContextsString":{
183+
"type":"string",
184+
"sensitive":true
185+
},
115186
"AttributesString":{
116187
"type":"string",
117188
"sensitive":true
@@ -397,6 +468,10 @@
397468
"dialogAction":{
398469
"shape":"DialogAction",
399470
"documentation":"<p>Describes the current state of the bot.</p>"
471+
},
472+
"activeContexts":{
473+
"shape":"ActiveContextsList",
474+
"documentation":"<p>A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the <code>PostContent</code>, <code>PostText</code>, or <code>PutSession</code> operation.</p> <p>You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.</p>"
400475
}
401476
}
402477
},
@@ -524,6 +599,11 @@
524599
"error":{"httpStatusCode":404},
525600
"exception":true
526601
},
602+
"ParameterName":{
603+
"type":"string",
604+
"max":100,
605+
"min":1
606+
},
527607
"PostContentRequest":{
528608
"type":"structure",
529609
"required":[
@@ -581,6 +661,13 @@
581661
"inputStream":{
582662
"shape":"BlobStream",
583663
"documentation":"<p> User input in PCM or Opus audio format or text format as described in the <code>Content-Type</code> HTTP header. </p> <p>You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.</p>"
664+
},
665+
"activeContexts":{
666+
"shape":"ActiveContextsString",
667+
"documentation":"<p>A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,</p> <p>If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.</p>",
668+
"jsonvalue":true,
669+
"location":"header",
670+
"locationName":"x-amz-lex-active-contexts"
584671
}
585672
},
586673
"payload":"inputStream"
@@ -602,7 +689,7 @@
602689
},
603690
"nluIntentConfidence":{
604691
"shape":"String",
605-
"documentation":"<p>Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the user's intent. The score is between 0.0 and 1.0.</p> <p>The score is a relative score, not an absolute score. The score may change based on improvements to the Amazon Lex NLU.</p>",
692+
"documentation":"<p>Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the user's intent. The score is between 0.0 and 1.0.</p> <p>The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex. </p>",
606693
"jsonvalue":true,
607694
"location":"header",
608695
"locationName":"x-amz-lex-nlu-intent-confidence"
@@ -670,7 +757,7 @@
670757
},
671758
"botVersion":{
672759
"shape":"BotVersion",
673-
"documentation":"<p>The version of the bot that responded to the conversation. You can use this information to help determine if one version of a bot is performing better than another version.</p> <p>If you have enabled the new natural language understanding (NLU) model, you can use this to determine if the improvement is due to changes to the bot or changes to the NLU.</p> <p>For more information about enabling the new NLU, see the <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_PutBot.html#lex-PutBot-request-enableModelImprovements\">enableModelImprovements</a> parameter of the <code>PutBot</code> operation.</p>",
760+
"documentation":"<p>The version of the bot that responded to the conversation. You can use this information to help determine if one version of a bot is performing better than another version.</p>",
674761
"location":"header",
675762
"locationName":"x-amz-lex-bot-version"
676763
},
@@ -679,6 +766,13 @@
679766
"documentation":"<p>The unique identifier for the session.</p>",
680767
"location":"header",
681768
"locationName":"x-amz-lex-session-id"
769+
},
770+
"activeContexts":{
771+
"shape":"ActiveContextsString",
772+
"documentation":"<p>A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the <code>PostContent</code>, <code>PostText</code>, or <code>PutSession</code> operation.</p> <p>You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.</p>",
773+
"jsonvalue":true,
774+
"location":"header",
775+
"locationName":"x-amz-lex-active-contexts"
682776
}
683777
},
684778
"payload":"audioStream"
@@ -721,6 +815,10 @@
721815
"inputText":{
722816
"shape":"Text",
723817
"documentation":"<p>The text that the user entered (Amazon Lex interprets this text).</p>"
818+
},
819+
"activeContexts":{
820+
"shape":"ActiveContextsList",
821+
"documentation":"<p>A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,</p> <p>If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.</p>"
724822
}
725823
}
726824
},
@@ -733,7 +831,7 @@
733831
},
734832
"nluIntentConfidence":{
735833
"shape":"IntentConfidence",
736-
"documentation":"<p>Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the user's intent. The score is between 0.0 and 1.0. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html\">Confidence Scores</a>.</p> <p>The score is a relative score, not an absolute score. The score may change based on improvements to the Amazon Lex natural language understanding (NLU) model.</p>"
834+
"documentation":"<p>Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the user's intent. The score is between 0.0 and 1.0. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html\">Confidence Scores</a>.</p> <p>The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex.</p>"
737835
},
738836
"alternativeIntents":{
739837
"shape":"IntentList",
@@ -777,7 +875,11 @@
777875
},
778876
"botVersion":{
779877
"shape":"BotVersion",
780-
"documentation":"<p>The version of the bot that responded to the conversation. You can use this information to help determine if one version of a bot is performing better than another version.</p> <p>If you have enabled the new natural language understanding (NLU) model, you can use this to determine if the improvement is due to changes to the bot or changes to the NLU.</p> <p>For more information about enabling the new NLU, see the <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_PutBot.html#lex-PutBot-request-enableModelImprovements\">enableModelImprovements</a> parameter of the <code>PutBot</code> operation.</p>"
878+
"documentation":"<p>The version of the bot that responded to the conversation. You can use this information to help determine if one version of a bot is performing better than another version.</p>"
879+
},
880+
"activeContexts":{
881+
"shape":"ActiveContextsList",
882+
"documentation":"<p>A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the <code>PostContent</code>, <code>PostText</code>, or <code>PutSession</code> operation.</p> <p>You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.</p>"
781883
}
782884
}
783885
},
@@ -842,6 +944,10 @@
842944
"documentation":"<p>The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.</p> <ul> <li> <p>If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex returns text in the response.</p> </li> <li> <p>If the value begins with <code>audio/</code>, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify <code>audio/mpeg</code> as the value, Amazon Lex returns speech in the MPEG format.</p> </li> <li> <p>If the value is <code>audio/pcm</code>, the speech is returned as <code>audio/pcm</code> in 16-bit, little endian format.</p> </li> <li> <p>The following are the accepted values:</p> <ul> <li> <p> <code>audio/mpeg</code> </p> </li> <li> <p> <code>audio/ogg</code> </p> </li> <li> <p> <code>audio/pcm</code> </p> </li> <li> <p> <code>audio/*</code> (defaults to mpeg)</p> </li> <li> <p> <code>text/plain; charset=utf-8</code> </p> </li> </ul> </li> </ul>",
843945
"location":"header",
844946
"locationName":"Accept"
947+
},
948+
"activeContexts":{
949+
"shape":"ActiveContextsList",
950+
"documentation":"<p>A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,</p> <p>If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.</p>"
845951
}
846952
}
847953
},
@@ -907,6 +1013,13 @@
9071013
"documentation":"<p>A unique identifier for the session.</p>",
9081014
"location":"header",
9091015
"locationName":"x-amz-lex-session-id"
1016+
},
1017+
"activeContexts":{
1018+
"shape":"ActiveContextsString",
1019+
"documentation":"<p>A list of active contexts for the session.</p>",
1020+
"jsonvalue":true,
1021+
"location":"header",
1022+
"locationName":"x-amz-lex-active-contexts"
9101023
}
9111024
},
9121025
"payload":"audioStream"

0 commit comments

Comments
 (0)