Skip to content

Commit 8e95256

Browse files
author
AWS
committed
Amazon Lex Model Building V2 Update: This release makes AMAZON.QnAIntent generally available in Amazon Lex. This generative AI feature leverages large language models available through Amazon Bedrock to automate frequently asked questions (FAQ) experience for end-users.
1 parent dcbde65 commit 8e95256

File tree

2 files changed

+167
-2
lines changed

2 files changed

+167
-2
lines changed
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 Model Building V2",
4+
"contributor": "",
5+
"description": "This release makes AMAZON.QnAIntent generally available in Amazon Lex. This generative AI feature leverages large language models available through Amazon Bedrock to automate frequently asked questions (FAQ) experience for end-users."
6+
}

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

Lines changed: 161 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2982,6 +2982,7 @@
29822982
"type":"string",
29832983
"enum":["UtteranceTimestamp"]
29842984
},
2985+
"AnswerField":{"type":"string"},
29852986
"AssociatedTranscript":{
29862987
"type":"structure",
29872988
"members":{
@@ -3294,9 +3295,26 @@
32943295
}
32953296
}
32963297
},
3298+
"BedrockKnowledgeBaseArn":{
3299+
"type":"string",
3300+
"max":200,
3301+
"min":1,
3302+
"pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,40}:[0-9]{12}:knowledge-base\\/[A-Za-z0-9]{10}$|^[A-Za-z0-9]{10}$"
3303+
},
3304+
"BedrockKnowledgeStoreConfiguration":{
3305+
"type":"structure",
3306+
"required":["bedrockKnowledgeBaseArn"],
3307+
"members":{
3308+
"bedrockKnowledgeBaseArn":{
3309+
"shape":"BedrockKnowledgeBaseArn",
3310+
"documentation":"<p>The ARN of the knowledge base used.</p>"
3311+
}
3312+
},
3313+
"documentation":"<p>Contains details about the configuration of a Amazon Bedrock knowledge base.</p>"
3314+
},
32973315
"BedrockModelArn":{
32983316
"type":"string",
3299-
"pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\\/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}$"
3317+
"pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\\/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$"
33003318
},
33013319
"BedrockModelSpecification":{
33023320
"type":"structure",
@@ -4186,7 +4204,10 @@
41864204
"shape":"DescriptiveBotBuilderSpecification",
41874205
"documentation":"<p>An object containing specifications for the descriptive bot building feature.</p>"
41884206
},
4189-
"sampleUtteranceGeneration":{"shape":"SampleUtteranceGenerationSpecification"}
4207+
"sampleUtteranceGeneration":{
4208+
"shape":"SampleUtteranceGenerationSpecification",
4209+
"documentation":"<p>Contains specifications for the sample utterance generation feature.</p>"
4210+
}
41904211
},
41914212
"documentation":"<p>Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.</p>"
41924213
},
@@ -5177,6 +5198,10 @@
51775198
"initialResponseSetting":{
51785199
"shape":"InitialResponseSetting",
51795200
"documentation":"<p>Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.</p>"
5201+
},
5202+
"qnAIntentConfiguration":{
5203+
"shape":"QnAIntentConfiguration",
5204+
"documentation":"<p>Specifies the configuration of the built-in <code>Amazon.QnAIntent</code>. The <code>AMAZON.QnAIntent</code> intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the <code>kendraConfiguration</code> field.</p>"
51805205
}
51815206
}
51825207
},
@@ -5250,6 +5275,10 @@
52505275
"initialResponseSetting":{
52515276
"shape":"InitialResponseSetting",
52525277
"documentation":"<p>Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.</p>"
5278+
},
5279+
"qnAIntentConfiguration":{
5280+
"shape":"QnAIntentConfiguration",
5281+
"documentation":"<p>Details about the the configuration of the built-in <code>Amazon.QnAIntent</code>.</p>"
52535282
}
52545283
}
52555284
},
@@ -5788,6 +5817,24 @@
57885817
},
57895818
"documentation":"<p>By default, data stored by Amazon Lex is encrypted. The <code>DataPrivacy</code> structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot. </p>"
57905819
},
5820+
"DataSourceConfiguration":{
5821+
"type":"structure",
5822+
"members":{
5823+
"opensearchConfiguration":{
5824+
"shape":"OpensearchConfiguration",
5825+
"documentation":"<p>Contains details about the configuration of the Amazon OpenSearch Service database used for the <code>AMAZON.QnAIntent</code>. To create a domain, follow the steps at <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html\">Creating and managing Amazon OpenSearch Service domains</a>.</p>"
5826+
},
5827+
"kendraConfiguration":{
5828+
"shape":"QnAKendraConfiguration",
5829+
"documentation":"<p>Contains details about the configuration of the Amazon Kendra index used for the <code>AMAZON.QnAIntent</code>. To create a Amazon Kendra index, follow the steps at <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/create-index.html\">Creating an index</a>.</p>"
5830+
},
5831+
"bedrockKnowledgeStoreConfiguration":{
5832+
"shape":"BedrockKnowledgeStoreConfiguration",
5833+
"documentation":"<p>Contains details about the configuration of the Amazon Bedrock knowledge base used for the <code>AMAZON.QnAIntent</code>. To set up a knowledge base, follow the steps at <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html\">Building a knowledge base</a>.</p>"
5834+
}
5835+
},
5836+
"documentation":"<p>Contains details about the configuration of the knowledge store used for the <code>AMAZON.QnAIntent</code>. You must have already created the knowledge store and indexed the documents within it.</p>"
5837+
},
57915838
"DateRangeFilter":{
57925839
"type":"structure",
57935840
"required":[
@@ -7167,6 +7214,10 @@
71677214
"initialResponseSetting":{
71687215
"shape":"InitialResponseSetting",
71697216
"documentation":"<p>Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.</p>"
7217+
},
7218+
"qnAIntentConfiguration":{
7219+
"shape":"QnAIntentConfiguration",
7220+
"documentation":"<p>Details about the configuration of the built-in <code>Amazon.QnAIntent</code>.</p>"
71707221
}
71717222
}
71727223
},
@@ -7722,6 +7773,10 @@
77227773
},
77237774
"documentation":"<p>The current state of the conversation with the user.</p>"
77247775
},
7776+
"DomainEndpoint":{
7777+
"type":"string",
7778+
"pattern":"^(http|https):\\/\\/+[^\\s]+[\\w]"
7779+
},
77257780
"DraftBotVersion":{
77267781
"type":"string",
77277782
"max":5,
@@ -7779,6 +7834,24 @@
77797834
]
77807835
},
77817836
"ErrorMessage":{"type":"string"},
7837+
"ExactResponseFields":{
7838+
"type":"structure",
7839+
"required":[
7840+
"questionField",
7841+
"answerField"
7842+
],
7843+
"members":{
7844+
"questionField":{
7845+
"shape":"QuestionField",
7846+
"documentation":"<p>The name of the field that contains the query made to the OpenSearch Service database.</p>"
7847+
},
7848+
"answerField":{
7849+
"shape":"AnswerField",
7850+
"documentation":"<p>The name of the field that contains the answer to the query made to the OpenSearch Service database.</p>"
7851+
}
7852+
},
7853+
"documentation":"<p>Contains the names of the fields used for an exact response to the user.</p>"
7854+
},
77827855
"ExceptionMessage":{"type":"string"},
77837856
"ExecutionErrorDetails":{
77847857
"type":"structure",
@@ -8463,6 +8536,7 @@
84638536
"min":5,
84648537
"pattern":"^([0-9a-zA-Z_])+$"
84658538
},
8539+
"IncludeField":{"type":"string"},
84668540
"InitialResponseSetting":{
84678541
"type":"structure",
84688542
"members":{
@@ -10705,6 +10779,18 @@
1070510779
"min":1,
1070610780
"pattern":"^[0-9]+$"
1070710781
},
10782+
"OSIncludeFields":{
10783+
"type":"list",
10784+
"member":{"shape":"IncludeField"},
10785+
"max":5,
10786+
"min":1
10787+
},
10788+
"OSIndexName":{
10789+
"type":"string",
10790+
"max":255,
10791+
"min":1,
10792+
"pattern":"^(?![_-])[a-z0-9][a-z0-9_\\-]{0,254}$"
10793+
},
1070810794
"ObfuscationSetting":{
1070910795
"type":"structure",
1071010796
"required":["obfuscationSettingType"],
@@ -10734,6 +10820,36 @@
1073410820
"max":2,
1073510821
"min":1
1073610822
},
10823+
"OpensearchConfiguration":{
10824+
"type":"structure",
10825+
"required":[
10826+
"domainEndpoint",
10827+
"indexName"
10828+
],
10829+
"members":{
10830+
"domainEndpoint":{
10831+
"shape":"DomainEndpoint",
10832+
"documentation":"<p>The endpoint of the Amazon OpenSearch Service domain.</p>"
10833+
},
10834+
"indexName":{
10835+
"shape":"OSIndexName",
10836+
"documentation":"<p>The name of the Amazon OpenSearch Service index.</p>"
10837+
},
10838+
"exactResponse":{
10839+
"shape":"Boolean",
10840+
"documentation":"<p>Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.</p>"
10841+
},
10842+
"exactResponseFields":{
10843+
"shape":"ExactResponseFields",
10844+
"documentation":"<p>Contains the names of the fields used for an exact response to the user.</p>"
10845+
},
10846+
"includeFields":{
10847+
"shape":"OSIncludeFields",
10848+
"documentation":"<p>Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.</p>"
10849+
}
10850+
},
10851+
"documentation":"<p>Contains details about the configuration of the Amazon OpenSearch Service database used for the <code>AMAZON.QnAIntent</code>.</p>"
10852+
},
1073710853
"Operation":{
1073810854
"type":"string",
1073910855
"max":50,
@@ -11058,11 +11174,46 @@
1105811174
},
1105911175
"documentation":"<p>Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.</p>"
1106011176
},
11177+
"QnAIntentConfiguration":{
11178+
"type":"structure",
11179+
"members":{
11180+
"dataSourceConfiguration":{
11181+
"shape":"DataSourceConfiguration",
11182+
"documentation":"<p>Contains details about the configuration of the data source used for the <code>AMAZON.QnAIntent</code>.</p>"
11183+
},
11184+
"bedrockModelConfiguration":{"shape":"BedrockModelSpecification"}
11185+
},
11186+
"documentation":"<p>Details about the the configuration of the built-in <code>Amazon.QnAIntent</code>.</p>"
11187+
},
11188+
"QnAKendraConfiguration":{
11189+
"type":"structure",
11190+
"required":["kendraIndex"],
11191+
"members":{
11192+
"kendraIndex":{
11193+
"shape":"KendraIndexArn",
11194+
"documentation":"<p>The ARN of the Amazon Kendra index to use.</p>"
11195+
},
11196+
"queryFilterStringEnabled":{
11197+
"shape":"Boolean",
11198+
"documentation":"<p>Specifies whether to enable an Amazon Kendra filter string or not.</p>"
11199+
},
11200+
"queryFilterString":{
11201+
"shape":"QueryFilterString",
11202+
"documentation":"<p>Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering\">Using document attributes to filter search results</a>.</p>"
11203+
},
11204+
"exactResponse":{
11205+
"shape":"Boolean",
11206+
"documentation":"<p>Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html\">Adding frequently asked questions (FAQs) to an index</a>.</p>"
11207+
}
11208+
},
11209+
"documentation":"<p>Contains details about the configuration of the Amazon Kendra index used for the <code>AMAZON.QnAIntent</code>.</p>"
11210+
},
1106111211
"QueryFilterString":{
1106211212
"type":"string",
1106311213
"max":5000,
1106411214
"min":1
1106511215
},
11216+
"QuestionField":{"type":"string"},
1106611217
"RecommendedAction":{"type":"string"},
1106711218
"RecommendedActions":{
1106811219
"type":"list",
@@ -13869,6 +14020,10 @@
1386914020
"initialResponseSetting":{
1387014021
"shape":"InitialResponseSetting",
1387114022
"documentation":"<p>Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.</p>"
14023+
},
14024+
"qnAIntentConfiguration":{
14025+
"shape":"QnAIntentConfiguration",
14026+
"documentation":"<p>Specifies the configuration of the built-in <code>Amazon.QnAIntent</code>. The <code>AMAZON.QnAIntent</code> intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the <code>kendraConfiguration</code> field.</p>"
1387214027
}
1387314028
}
1387414029
},
@@ -13950,6 +14105,10 @@
1395014105
"initialResponseSetting":{
1395114106
"shape":"InitialResponseSetting",
1395214107
"documentation":"<p>Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.</p>"
14108+
},
14109+
"qnAIntentConfiguration":{
14110+
"shape":"QnAIntentConfiguration",
14111+
"documentation":"<p>Details about the configuration of the built-in <code>Amazon.QnAIntent</code>.</p>"
1395314112
}
1395414113
}
1395514114
},

0 commit comments

Comments
 (0)