feat(client-lex-models-v2): This release adds new capabilities to the…

… AMAZON.QnAIntent: Custom prompting, Guardrails integration and ExactResponse support for Bedrock Knowledge Base.
aws · Jul 30, 2024 · 4d9c7a1 · 4d9c7a1
1 parent 3cf46f1
commit 4d9c7a1
Show file tree

Hide file tree

Showing 13 changed files with 534 additions and 197 deletions.
diff --git a/clients/client-lex-models-v2/src/commands/CreateBotLocaleCommand.ts b/clients/client-lex-models-v2/src/commands/CreateBotLocaleCommand.ts
@@ -54,6 +54,12 @@ export interface CreateBotLocaleCommandOutput extends CreateBotLocaleResponse, _
  *         enabled: true || false, // required
  *         bedrockModelSpecification: { // BedrockModelSpecification
  *           modelArn: "STRING_VALUE", // required
+ *           guardrail: { // BedrockGuardrailConfiguration
+ *             identifier: "STRING_VALUE", // required
+ *             version: "STRING_VALUE", // required
+ *           },
+ *           traceStatus: "ENABLED" || "DISABLED",
+ *           customPrompt: "STRING_VALUE",
  *         },
  *       },
  *     },
@@ -62,12 +68,24 @@ export interface CreateBotLocaleCommandOutput extends CreateBotLocaleResponse, _
  *         enabled: true || false, // required
  *         bedrockModelSpecification: {
  *           modelArn: "STRING_VALUE", // required
+ *           guardrail: {
+ *             identifier: "STRING_VALUE", // required
+ *             version: "STRING_VALUE", // required
+ *           },
+ *           traceStatus: "ENABLED" || "DISABLED",
+ *           customPrompt: "STRING_VALUE",
  *         },
  *       },
  *       sampleUtteranceGeneration: { // SampleUtteranceGenerationSpecification
  *         enabled: true || false, // required
  *         bedrockModelSpecification: {
  *           modelArn: "STRING_VALUE", // required
+ *           guardrail: {
+ *             identifier: "STRING_VALUE", // required
+ *             version: "STRING_VALUE", // required
+ *           },
+ *           traceStatus: "ENABLED" || "DISABLED",
+ *           customPrompt: "STRING_VALUE",
  *         },
  *       },
  *     },
@@ -94,6 +112,12 @@ export interface CreateBotLocaleCommandOutput extends CreateBotLocaleResponse, _
  * //         enabled: true || false, // required
  * //         bedrockModelSpecification: { // BedrockModelSpecification
  * //           modelArn: "STRING_VALUE", // required
+ * //           guardrail: { // BedrockGuardrailConfiguration
+ * //             identifier: "STRING_VALUE", // required
+ * //             version: "STRING_VALUE", // required
+ * //           },
+ * //           traceStatus: "ENABLED" || "DISABLED",
+ * //           customPrompt: "STRING_VALUE",
  * //         },
  * //       },
  * //     },
@@ -102,12 +126,24 @@ export interface CreateBotLocaleCommandOutput extends CreateBotLocaleResponse, _
  * //         enabled: true || false, // required
  * //         bedrockModelSpecification: {
  * //           modelArn: "STRING_VALUE", // required
+ * //           guardrail: {
+ * //             identifier: "STRING_VALUE", // required
+ * //             version: "STRING_VALUE", // required
+ * //           },
+ * //           traceStatus: "ENABLED" || "DISABLED",
+ * //           customPrompt: "STRING_VALUE",
  * //         },
  * //       },
  * //       sampleUtteranceGeneration: { // SampleUtteranceGenerationSpecification
  * //         enabled: true || false, // required
  * //         bedrockModelSpecification: {
  * //           modelArn: "STRING_VALUE", // required
+ * //           guardrail: {
+ * //             identifier: "STRING_VALUE", // required
+ * //             version: "STRING_VALUE", // required
+ * //           },
+ * //           traceStatus: "ENABLED" || "DISABLED",
+ * //           customPrompt: "STRING_VALUE",
  * //         },
  * //       },
  * //     },

diff --git a/clients/client-lex-models-v2/src/commands/CreateIntentCommand.ts b/clients/client-lex-models-v2/src/commands/CreateIntentCommand.ts
@@ -523,10 +523,20 @@ export interface CreateIntentCommandOutput extends CreateIntentResponse, __Metad
  *       },
  *       bedrockKnowledgeStoreConfiguration: { // BedrockKnowledgeStoreConfiguration
  *         bedrockKnowledgeBaseArn: "STRING_VALUE", // required
+ *         exactResponse: true || false,
+ *         exactResponseFields: { // BedrockKnowledgeStoreExactResponseFields
+ *           answerField: "STRING_VALUE",
+ *         },
  *       },
  *     },
  *     bedrockModelConfiguration: { // BedrockModelSpecification
  *       modelArn: "STRING_VALUE", // required
+ *       guardrail: { // BedrockGuardrailConfiguration
+ *         identifier: "STRING_VALUE", // required
+ *         version: "STRING_VALUE", // required
+ *       },
+ *       traceStatus: "ENABLED" || "DISABLED",
+ *       customPrompt: "STRING_VALUE",
  *     },
  *   },
  * };
@@ -985,10 +995,20 @@ export interface CreateIntentCommandOutput extends CreateIntentResponse, __Metad
  * //       },
  * //       bedrockKnowledgeStoreConfiguration: { // BedrockKnowledgeStoreConfiguration
  * //         bedrockKnowledgeBaseArn: "STRING_VALUE", // required
+ * //         exactResponse: true || false,
+ * //         exactResponseFields: { // BedrockKnowledgeStoreExactResponseFields
+ * //           answerField: "STRING_VALUE",
+ * //         },
  * //       },
  * //     },
  * //     bedrockModelConfiguration: { // BedrockModelSpecification
  * //       modelArn: "STRING_VALUE", // required
+ * //       guardrail: { // BedrockGuardrailConfiguration
+ * //         identifier: "STRING_VALUE", // required
+ * //         version: "STRING_VALUE", // required
+ * //       },
+ * //       traceStatus: "ENABLED" || "DISABLED",
+ * //       customPrompt: "STRING_VALUE",
  * //     },
  * //   },
  * // };

diff --git a/clients/client-lex-models-v2/src/commands/CreateResourcePolicyStatementCommand.ts b/clients/client-lex-models-v2/src/commands/CreateResourcePolicyStatementCommand.ts
@@ -38,6 +38,8 @@ export interface CreateResourcePolicyStatementCommandOutput
  *          policy. If a policy doesn't exist, a new policy is created.</p>
  *          <p>You can't create a resource policy statement that allows
  *          cross-account access.</p>
+ *          <p>You need to add the <code>CreateResourcePolicy</code> or <code>UpdateResourcePolicy</code>
+ *          action to the bot role in order to call the API.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-lex-models-v2/src/commands/DeleteResourcePolicyStatementCommand.ts b/clients/client-lex-models-v2/src/commands/DeleteResourcePolicyStatementCommand.ts
@@ -38,6 +38,8 @@ export interface DeleteResourcePolicyStatementCommandOutput
  *          statement ID that doesn't exist in the policy, or if the bot or bot
  *          alias doesn't have a policy attached, Amazon Lex returns an
  *          exception.</p>
+ *          <p>You need to add the <code>DeleteResourcePolicy</code> or <code>UpdateResourcePolicy</code>
+ *          action to the bot role in order to call the API.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-lex-models-v2/src/commands/DescribeBotLocaleCommand.ts b/clients/client-lex-models-v2/src/commands/DescribeBotLocaleCommand.ts
@@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
 import { LexModelsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexModelsV2Client";
-import { DescribeBotLocaleRequest, DescribeBotLocaleResponse } from "../models/models_0";
+import { DescribeBotLocaleRequest } from "../models/models_0";
+import { DescribeBotLocaleResponse } from "../models/models_1";
 import { de_DescribeBotLocaleCommand, se_DescribeBotLocaleCommand } from "../protocols/Aws_restJson1";
 
 /**
@@ -77,6 +78,12 @@ export interface DescribeBotLocaleCommandOutput extends DescribeBotLocaleRespons
  * //         enabled: true || false, // required
  * //         bedrockModelSpecification: { // BedrockModelSpecification
  * //           modelArn: "STRING_VALUE", // required
+ * //           guardrail: { // BedrockGuardrailConfiguration
+ * //             identifier: "STRING_VALUE", // required
+ * //             version: "STRING_VALUE", // required
+ * //           },
+ * //           traceStatus: "ENABLED" || "DISABLED",
+ * //           customPrompt: "STRING_VALUE",
  * //         },
  * //       },
  * //     },
@@ -85,12 +92,24 @@ export interface DescribeBotLocaleCommandOutput extends DescribeBotLocaleRespons
  * //         enabled: true || false, // required
  * //         bedrockModelSpecification: {
  * //           modelArn: "STRING_VALUE", // required
+ * //           guardrail: {
+ * //             identifier: "STRING_VALUE", // required
+ * //             version: "STRING_VALUE", // required
+ * //           },
+ * //           traceStatus: "ENABLED" || "DISABLED",
+ * //           customPrompt: "STRING_VALUE",
  * //         },
  * //       },
  * //       sampleUtteranceGeneration: { // SampleUtteranceGenerationSpecification
  * //         enabled: true || false, // required
  * //         bedrockModelSpecification: {
  * //           modelArn: "STRING_VALUE", // required
+ * //           guardrail: {
+ * //             identifier: "STRING_VALUE", // required
+ * //             version: "STRING_VALUE", // required
+ * //           },
+ * //           traceStatus: "ENABLED" || "DISABLED",
+ * //           customPrompt: "STRING_VALUE",
  * //         },
  * //       },
  * //     },

diff --git a/clients/client-lex-models-v2/src/commands/DescribeBotRecommendationCommand.ts b/clients/client-lex-models-v2/src/commands/DescribeBotRecommendationCommand.ts
@@ -6,8 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
 import { LexModelsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexModelsV2Client";
-import { DescribeBotRecommendationRequest } from "../models/models_0";
 import {
+  DescribeBotRecommendationRequest,
   DescribeBotRecommendationResponse,
   DescribeBotRecommendationResponseFilterSensitiveLog,
 } from "../models/models_1";

diff --git a/clients/client-lex-models-v2/src/commands/DescribeIntentCommand.ts b/clients/client-lex-models-v2/src/commands/DescribeIntentCommand.ts
@@ -503,10 +503,20 @@ export interface DescribeIntentCommandOutput extends DescribeIntentResponse, __M
  * //       },
  * //       bedrockKnowledgeStoreConfiguration: { // BedrockKnowledgeStoreConfiguration
  * //         bedrockKnowledgeBaseArn: "STRING_VALUE", // required
+ * //         exactResponse: true || false,
+ * //         exactResponseFields: { // BedrockKnowledgeStoreExactResponseFields
+ * //           answerField: "STRING_VALUE",
+ * //         },
  * //       },
  * //     },
  * //     bedrockModelConfiguration: { // BedrockModelSpecification
  * //       modelArn: "STRING_VALUE", // required
+ * //       guardrail: { // BedrockGuardrailConfiguration
+ * //         identifier: "STRING_VALUE", // required
+ * //         version: "STRING_VALUE", // required
+ * //       },
+ * //       traceStatus: "ENABLED" || "DISABLED",
+ * //       customPrompt: "STRING_VALUE",
  * //     },
  * //   },
  * // };

diff --git a/clients/client-lex-models-v2/src/commands/UpdateBotLocaleCommand.ts b/clients/client-lex-models-v2/src/commands/UpdateBotLocaleCommand.ts
@@ -51,6 +51,12 @@ export interface UpdateBotLocaleCommandOutput extends UpdateBotLocaleResponse, _
  *         enabled: true || false, // required
  *         bedrockModelSpecification: { // BedrockModelSpecification
  *           modelArn: "STRING_VALUE", // required
+ *           guardrail: { // BedrockGuardrailConfiguration
+ *             identifier: "STRING_VALUE", // required
+ *             version: "STRING_VALUE", // required
+ *           },
+ *           traceStatus: "ENABLED" || "DISABLED",
+ *           customPrompt: "STRING_VALUE",
  *         },
  *       },
  *     },
@@ -59,12 +65,24 @@ export interface UpdateBotLocaleCommandOutput extends UpdateBotLocaleResponse, _
  *         enabled: true || false, // required
  *         bedrockModelSpecification: {
  *           modelArn: "STRING_VALUE", // required
+ *           guardrail: {
+ *             identifier: "STRING_VALUE", // required
+ *             version: "STRING_VALUE", // required
+ *           },
+ *           traceStatus: "ENABLED" || "DISABLED",
+ *           customPrompt: "STRING_VALUE",
  *         },
  *       },
  *       sampleUtteranceGeneration: { // SampleUtteranceGenerationSpecification
  *         enabled: true || false, // required
  *         bedrockModelSpecification: {
  *           modelArn: "STRING_VALUE", // required
+ *           guardrail: {
+ *             identifier: "STRING_VALUE", // required
+ *             version: "STRING_VALUE", // required
+ *           },
+ *           traceStatus: "ENABLED" || "DISABLED",
+ *           customPrompt: "STRING_VALUE",
  *         },
  *       },
  *     },
@@ -98,6 +116,12 @@ export interface UpdateBotLocaleCommandOutput extends UpdateBotLocaleResponse, _
  * //         enabled: true || false, // required
  * //         bedrockModelSpecification: { // BedrockModelSpecification
  * //           modelArn: "STRING_VALUE", // required
+ * //           guardrail: { // BedrockGuardrailConfiguration
+ * //             identifier: "STRING_VALUE", // required
+ * //             version: "STRING_VALUE", // required
+ * //           },
+ * //           traceStatus: "ENABLED" || "DISABLED",
+ * //           customPrompt: "STRING_VALUE",
  * //         },
  * //       },
  * //     },
@@ -106,12 +130,24 @@ export interface UpdateBotLocaleCommandOutput extends UpdateBotLocaleResponse, _
  * //         enabled: true || false, // required
  * //         bedrockModelSpecification: {
  * //           modelArn: "STRING_VALUE", // required
+ * //           guardrail: {
+ * //             identifier: "STRING_VALUE", // required
+ * //             version: "STRING_VALUE", // required
+ * //           },
+ * //           traceStatus: "ENABLED" || "DISABLED",
+ * //           customPrompt: "STRING_VALUE",
  * //         },
  * //       },
  * //       sampleUtteranceGeneration: { // SampleUtteranceGenerationSpecification
  * //         enabled: true || false, // required
  * //         bedrockModelSpecification: {
  * //           modelArn: "STRING_VALUE", // required
+ * //           guardrail: {
+ * //             identifier: "STRING_VALUE", // required
+ * //             version: "STRING_VALUE", // required
+ * //           },
+ * //           traceStatus: "ENABLED" || "DISABLED",
+ * //           customPrompt: "STRING_VALUE",
  * //         },
  * //       },
  * //     },

diff --git a/clients/client-lex-models-v2/src/commands/UpdateIntentCommand.ts b/clients/client-lex-models-v2/src/commands/UpdateIntentCommand.ts
@@ -493,10 +493,20 @@ export interface UpdateIntentCommandOutput extends UpdateIntentResponse, __Metad
  *       },
  *       bedrockKnowledgeStoreConfiguration: { // BedrockKnowledgeStoreConfiguration
  *         bedrockKnowledgeBaseArn: "STRING_VALUE", // required
+ *         exactResponse: true || false,
+ *         exactResponseFields: { // BedrockKnowledgeStoreExactResponseFields
+ *           answerField: "STRING_VALUE",
+ *         },
  *       },
  *     },
  *     bedrockModelConfiguration: { // BedrockModelSpecification
  *       modelArn: "STRING_VALUE", // required
+ *       guardrail: { // BedrockGuardrailConfiguration
+ *         identifier: "STRING_VALUE", // required
+ *         version: "STRING_VALUE", // required
+ *       },
+ *       traceStatus: "ENABLED" || "DISABLED",
+ *       customPrompt: "STRING_VALUE",
  *     },
  *   },
  * };
@@ -962,10 +972,20 @@ export interface UpdateIntentCommandOutput extends UpdateIntentResponse, __Metad
  * //       },
  * //       bedrockKnowledgeStoreConfiguration: { // BedrockKnowledgeStoreConfiguration
  * //         bedrockKnowledgeBaseArn: "STRING_VALUE", // required
+ * //         exactResponse: true || false,
+ * //         exactResponseFields: { // BedrockKnowledgeStoreExactResponseFields
+ * //           answerField: "STRING_VALUE",
+ * //         },
  * //       },
  * //     },
  * //     bedrockModelConfiguration: { // BedrockModelSpecification
  * //       modelArn: "STRING_VALUE", // required
+ * //       guardrail: { // BedrockGuardrailConfiguration
+ * //         identifier: "STRING_VALUE", // required
+ * //         version: "STRING_VALUE", // required
+ * //       },
+ * //       traceStatus: "ENABLED" || "DISABLED",
+ * //       customPrompt: "STRING_VALUE",
  * //     },
  * //   },
  * // };