@aws-sdk/client-lex-models-v2 3.523.0 → 3.525.0

package/dist-cjs/index.js

@@ -936,9 +936,6 @@ var ImportStatus = {
   Failed: "Failed",
   InProgress: "InProgress"
 };
-var TranscriptFormat = {
-  Lex: "Lex"
-};
 var CreateExportRequestFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
   ...obj,
   ...obj.filePassword && { filePassword: import_smithy_client.SENSITIVE_STRING }
@@ -1154,6 +1151,7 @@ var se_CreateIntentCommand = /* @__PURE__ */ __name(async (input, context) => {
       kendraConfiguration: (_) => (0, import_smithy_client._json)(_),
       outputContexts: (_) => (0, import_smithy_client._json)(_),
       parentIntentSignature: [],
+      qnAIntentConfiguration: (_) => (0, import_smithy_client._json)(_),
       sampleUtterances: (_) => (0, import_smithy_client._json)(_)
     })
   );
@@ -2542,6 +2540,7 @@ var se_UpdateIntentCommand = /* @__PURE__ */ __name(async (input, context) => {
       kendraConfiguration: (_) => (0, import_smithy_client._json)(_),
       outputContexts: (_) => (0, import_smithy_client._json)(_),
       parentIntentSignature: [],
+      qnAIntentConfiguration: (_) => (0, import_smithy_client._json)(_),
       sampleUtterances: (_) => (0, import_smithy_client._json)(_),
       slotPriorities: (_) => (0, import_smithy_client._json)(_)
     })
@@ -2860,6 +2859,7 @@ var de_CreateIntentCommand = /* @__PURE__ */ __name(async (output, context) => {
     localeId: import_smithy_client.expectString,
     outputContexts: import_smithy_client._json,
     parentIntentSignature: import_smithy_client.expectString,
+    qnAIntentConfiguration: import_smithy_client._json,
     sampleUtterances: import_smithy_client._json
   });
   Object.assign(contents, doc);
@@ -3447,6 +3447,7 @@ var de_DescribeIntentCommand = /* @__PURE__ */ __name(async (output, context) =>
     localeId: import_smithy_client.expectString,
     outputContexts: import_smithy_client._json,
     parentIntentSignature: import_smithy_client.expectString,
+    qnAIntentConfiguration: import_smithy_client._json,
     sampleUtterances: import_smithy_client._json,
     slotPriorities: import_smithy_client._json
   });
@@ -4465,6 +4466,7 @@ var de_UpdateIntentCommand = /* @__PURE__ */ __name(async (output, context) => {
     localeId: import_smithy_client.expectString,
     outputContexts: import_smithy_client._json,
     parentIntentSignature: import_smithy_client.expectString,
+    qnAIntentConfiguration: import_smithy_client._json,
     sampleUtterances: import_smithy_client._json,
     slotPriorities: import_smithy_client._json
   });
@@ -6455,6 +6457,9 @@ var DescribeBotLocaleCommand = _DescribeBotLocaleCommand;
 
 // src/models/models_1.ts
 
+var TranscriptFormat = {
+  Lex: "Lex"
+};
 var GenerationStatus = {
   Complete: "Complete",
   Failed: "Failed",
@@ -8676,9 +8681,9 @@ var import_util_endpoints = require("@aws-sdk/util-endpoints");
   SlotValueResolutionStrategy,
   CustomVocabularyStatus,
   ImportStatus,
-  TranscriptFormat,
   CreateExportRequestFilterSensitiveLog,
   EncryptionSettingFilterSensitiveLog,
+  TranscriptFormat,
   GenerationStatus,
   MergeStrategy,
   TestSetModality,

package/dist-es/models/models_0.js

@@ -439,9 +439,6 @@ export const ImportStatus = {
     Failed: "Failed",
     InProgress: "InProgress",
 };
-export const TranscriptFormat = {
-    Lex: "Lex",
-};
 export const CreateExportRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.filePassword && { filePassword: SENSITIVE_STRING }),

package/dist-es/models/models_1.js

@@ -1,5 +1,8 @@
 import { SENSITIVE_STRING } from "@smithy/smithy-client";
 import { EncryptionSettingFilterSensitiveLog, } from "./models_0";
+export const TranscriptFormat = {
+    Lex: "Lex",
+};
 export const GenerationStatus = {
     Complete: "Complete",
     Failed: "Failed",

package/dist-es/protocols/Aws_restJson1.js

@@ -187,6 +187,7 @@ export const se_CreateIntentCommand = async (input, context) => {
         kendraConfiguration: (_) => _json(_),
         outputContexts: (_) => _json(_),
         parentIntentSignature: [],
+        qnAIntentConfiguration: (_) => _json(_),
         sampleUtterances: (_) => _json(_),
     }));
     b.m("PUT").h(headers).b(body);
@@ -1475,6 +1476,7 @@ export const se_UpdateIntentCommand = async (input, context) => {
         kendraConfiguration: (_) => _json(_),
         outputContexts: (_) => _json(_),
         parentIntentSignature: [],
+        qnAIntentConfiguration: (_) => _json(_),
         sampleUtterances: (_) => _json(_),
         slotPriorities: (_) => _json(_),
     }));
@@ -1784,6 +1786,7 @@ export const de_CreateIntentCommand = async (output, context) => {
         localeId: __expectString,
         outputContexts: _json,
         parentIntentSignature: __expectString,
+        qnAIntentConfiguration: _json,
         sampleUtterances: _json,
     });
     Object.assign(contents, doc);
@@ -2371,6 +2374,7 @@ export const de_DescribeIntentCommand = async (output, context) => {
         localeId: __expectString,
         outputContexts: _json,
         parentIntentSignature: __expectString,
+        qnAIntentConfiguration: _json,
         sampleUtterances: _json,
         slotPriorities: _json,
     });
@@ -3389,6 +3393,7 @@ export const de_UpdateIntentCommand = async (output, context) => {
         localeId: __expectString,
         outputContexts: _json,
         parentIntentSignature: __expectString,
+        qnAIntentConfiguration: _json,
         sampleUtterances: _json,
         slotPriorities: _json,
     });

package/dist-types/commands/CreateIntentCommand.d.ts

@@ -499,6 +499,34 @@ declare const CreateIntentCommand_base: {
  *       },
  *     },
  *   },
+ *   qnAIntentConfiguration: { // QnAIntentConfiguration
+ *     dataSourceConfiguration: { // DataSourceConfiguration
+ *       opensearchConfiguration: { // OpensearchConfiguration
+ *         domainEndpoint: "STRING_VALUE", // required
+ *         indexName: "STRING_VALUE", // required
+ *         exactResponse: true || false,
+ *         exactResponseFields: { // ExactResponseFields
+ *           questionField: "STRING_VALUE", // required
+ *           answerField: "STRING_VALUE", // required
+ *         },
+ *         includeFields: [ // OSIncludeFields
+ *           "STRING_VALUE",
+ *         ],
+ *       },
+ *       kendraConfiguration: { // QnAKendraConfiguration
+ *         kendraIndex: "STRING_VALUE", // required
+ *         queryFilterStringEnabled: true || false,
+ *         queryFilterString: "STRING_VALUE",
+ *         exactResponse: true || false,
+ *       },
+ *       bedrockKnowledgeStoreConfiguration: { // BedrockKnowledgeStoreConfiguration
+ *         bedrockKnowledgeBaseArn: "STRING_VALUE", // required
+ *       },
+ *     },
+ *     bedrockModelConfiguration: { // BedrockModelSpecification
+ *       modelArn: "STRING_VALUE", // required
+ *     },
+ *   },
  * };
  * const command = new CreateIntentCommand(input);
  * const response = await client.send(command);
@@ -933,6 +961,34 @@ declare const CreateIntentCommand_base: {
  * //       },
  * //     },
  * //   },
+ * //   qnAIntentConfiguration: { // QnAIntentConfiguration
+ * //     dataSourceConfiguration: { // DataSourceConfiguration
+ * //       opensearchConfiguration: { // OpensearchConfiguration
+ * //         domainEndpoint: "STRING_VALUE", // required
+ * //         indexName: "STRING_VALUE", // required
+ * //         exactResponse: true || false,
+ * //         exactResponseFields: { // ExactResponseFields
+ * //           questionField: "STRING_VALUE", // required
+ * //           answerField: "STRING_VALUE", // required
+ * //         },
+ * //         includeFields: [ // OSIncludeFields
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       kendraConfiguration: { // QnAKendraConfiguration
+ * //         kendraIndex: "STRING_VALUE", // required
+ * //         queryFilterStringEnabled: true || false,
+ * //         queryFilterString: "STRING_VALUE",
+ * //         exactResponse: true || false,
+ * //       },
+ * //       bedrockKnowledgeStoreConfiguration: { // BedrockKnowledgeStoreConfiguration
+ * //         bedrockKnowledgeBaseArn: "STRING_VALUE", // required
+ * //       },
+ * //     },
+ * //     bedrockModelConfiguration: { // BedrockModelSpecification
+ * //       modelArn: "STRING_VALUE", // required
+ * //     },
+ * //   },
  * // };
  *
  * ```

package/dist-types/commands/DescribeIntentCommand.d.ts

@@ -479,6 +479,34 @@ declare const DescribeIntentCommand_base: {
  * //       },
  * //     },
  * //   },
+ * //   qnAIntentConfiguration: { // QnAIntentConfiguration
+ * //     dataSourceConfiguration: { // DataSourceConfiguration
+ * //       opensearchConfiguration: { // OpensearchConfiguration
+ * //         domainEndpoint: "STRING_VALUE", // required
+ * //         indexName: "STRING_VALUE", // required
+ * //         exactResponse: true || false,
+ * //         exactResponseFields: { // ExactResponseFields
+ * //           questionField: "STRING_VALUE", // required
+ * //           answerField: "STRING_VALUE", // required
+ * //         },
+ * //         includeFields: [ // OSIncludeFields
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       kendraConfiguration: { // QnAKendraConfiguration
+ * //         kendraIndex: "STRING_VALUE", // required
+ * //         queryFilterStringEnabled: true || false,
+ * //         queryFilterString: "STRING_VALUE",
+ * //         exactResponse: true || false,
+ * //       },
+ * //       bedrockKnowledgeStoreConfiguration: { // BedrockKnowledgeStoreConfiguration
+ * //         bedrockKnowledgeBaseArn: "STRING_VALUE", // required
+ * //       },
+ * //     },
+ * //     bedrockModelConfiguration: { // BedrockModelSpecification
+ * //       modelArn: "STRING_VALUE", // required
+ * //     },
+ * //   },
  * // };
  *
  * ```

package/dist-types/commands/UpdateIntentCommand.d.ts

@@ -469,6 +469,34 @@ declare const UpdateIntentCommand_base: {
  *       },
  *     },
  *   },
+ *   qnAIntentConfiguration: { // QnAIntentConfiguration
+ *     dataSourceConfiguration: { // DataSourceConfiguration
+ *       opensearchConfiguration: { // OpensearchConfiguration
+ *         domainEndpoint: "STRING_VALUE", // required
+ *         indexName: "STRING_VALUE", // required
+ *         exactResponse: true || false,
+ *         exactResponseFields: { // ExactResponseFields
+ *           questionField: "STRING_VALUE", // required
+ *           answerField: "STRING_VALUE", // required
+ *         },
+ *         includeFields: [ // OSIncludeFields
+ *           "STRING_VALUE",
+ *         ],
+ *       },
+ *       kendraConfiguration: { // QnAKendraConfiguration
+ *         kendraIndex: "STRING_VALUE", // required
+ *         queryFilterStringEnabled: true || false,
+ *         queryFilterString: "STRING_VALUE",
+ *         exactResponse: true || false,
+ *       },
+ *       bedrockKnowledgeStoreConfiguration: { // BedrockKnowledgeStoreConfiguration
+ *         bedrockKnowledgeBaseArn: "STRING_VALUE", // required
+ *       },
+ *     },
+ *     bedrockModelConfiguration: { // BedrockModelSpecification
+ *       modelArn: "STRING_VALUE", // required
+ *     },
+ *   },
  * };
  * const command = new UpdateIntentCommand(input);
  * const response = await client.send(command);
@@ -910,6 +938,34 @@ declare const UpdateIntentCommand_base: {
  * //       },
  * //     },
  * //   },
+ * //   qnAIntentConfiguration: { // QnAIntentConfiguration
+ * //     dataSourceConfiguration: { // DataSourceConfiguration
+ * //       opensearchConfiguration: { // OpensearchConfiguration
+ * //         domainEndpoint: "STRING_VALUE", // required
+ * //         indexName: "STRING_VALUE", // required
+ * //         exactResponse: true || false,
+ * //         exactResponseFields: { // ExactResponseFields
+ * //           questionField: "STRING_VALUE", // required
+ * //           answerField: "STRING_VALUE", // required
+ * //         },
+ * //         includeFields: [ // OSIncludeFields
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       kendraConfiguration: { // QnAKendraConfiguration
+ * //         kendraIndex: "STRING_VALUE", // required
+ * //         queryFilterStringEnabled: true || false,
+ * //         queryFilterString: "STRING_VALUE",
+ * //         exactResponse: true || false,
+ * //       },
+ * //       bedrockKnowledgeStoreConfiguration: { // BedrockKnowledgeStoreConfiguration
+ * //         bedrockKnowledgeBaseArn: "STRING_VALUE", // required
+ * //       },
+ * //     },
+ * //     bedrockModelConfiguration: { // BedrockModelSpecification
+ * //       modelArn: "STRING_VALUE", // required
+ * //     },
+ * //   },
  * // };
  *
  * ```

package/dist-types/models/models_0.d.ts

@@ -2666,6 +2666,17 @@ export interface BatchUpdateCustomVocabularyItemResponse {
      */
     resources?: CustomVocabularyItem[];
 }
+/**
+ * @public
+ * <p>Contains details about the configuration of a Amazon Bedrock knowledge base.</p>
+ */
+export interface BedrockKnowledgeStoreConfiguration {
+    /**
+     * @public
+     * <p>The ARN of the knowledge base used.</p>
+     */
+    bedrockKnowledgeBaseArn: string | undefined;
+}
 /**
  * @public
  * <p>Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.</p>
@@ -5497,6 +5508,116 @@ export interface OutputContext {
      */
     turnsToLive: number | undefined;
 }
+/**
+ * @public
+ * <p>Contains details about the configuration of the Amazon Kendra index used for the <code>AMAZON.QnAIntent</code>.</p>
+ */
+export interface QnAKendraConfiguration {
+    /**
+     * @public
+     * <p>The ARN of the Amazon Kendra index to use.</p>
+     */
+    kendraIndex: string | undefined;
+    /**
+     * @public
+     * <p>Specifies whether to enable an Amazon Kendra filter string or not.</p>
+     */
+    queryFilterStringEnabled?: boolean;
+    /**
+     * @public
+     * <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>
+     */
+    queryFilterString?: string;
+    /**
+     * @public
+     * <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>
+     */
+    exactResponse?: boolean;
+}
+/**
+ * @public
+ * <p>Contains the names of the fields used for an exact response to the user.</p>
+ */
+export interface ExactResponseFields {
+    /**
+     * @public
+     * <p>The name of the field that contains the query made to the OpenSearch Service database.</p>
+     */
+    questionField: string | undefined;
+    /**
+     * @public
+     * <p>The name of the field that contains the answer to the query made to the OpenSearch Service database.</p>
+     */
+    answerField: string | undefined;
+}
+/**
+ * @public
+ * <p>Contains details about the configuration of the Amazon OpenSearch Service database used for the <code>AMAZON.QnAIntent</code>.</p>
+ */
+export interface OpensearchConfiguration {
+    /**
+     * @public
+     * <p>The endpoint of the Amazon OpenSearch Service domain.</p>
+     */
+    domainEndpoint: string | undefined;
+    /**
+     * @public
+     * <p>The name of the Amazon OpenSearch Service index.</p>
+     */
+    indexName: string | undefined;
+    /**
+     * @public
+     * <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>
+     */
+    exactResponse?: boolean;
+    /**
+     * @public
+     * <p>Contains the names of the fields used for an exact response to the user.</p>
+     */
+    exactResponseFields?: ExactResponseFields;
+    /**
+     * @public
+     * <p>Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.</p>
+     */
+    includeFields?: string[];
+}
+/**
+ * @public
+ * <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>
+ */
+export interface DataSourceConfiguration {
+    /**
+     * @public
+     * <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>
+     */
+    opensearchConfiguration?: OpensearchConfiguration;
+    /**
+     * @public
+     * <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>
+     */
+    kendraConfiguration?: QnAKendraConfiguration;
+    /**
+     * @public
+     * <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>
+     */
+    bedrockKnowledgeStoreConfiguration?: BedrockKnowledgeStoreConfiguration;
+}
+/**
+ * @public
+ * <p>Details about the the configuration of the built-in <code>Amazon.QnAIntent</code>.</p>
+ */
+export interface QnAIntentConfiguration {
+    /**
+     * @public
+     * <p>Contains details about the configuration of the data source used for the <code>AMAZON.QnAIntent</code>.</p>
+     */
+    dataSourceConfiguration?: DataSourceConfiguration;
+    /**
+     * @public
+     * <p>Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.</p>
+     */
+    bedrockModelConfiguration?: BedrockModelSpecification;
+}
 /**
  * @public
  * <p>A sample utterance that invokes an intent or respond to a slot
@@ -7290,116 +7411,6 @@ export interface EncryptionSetting {
      */
     associatedTranscriptsPassword?: string;
 }
-/**
- * @public
- * <p>The object that contains a path format that will be applied when
- *             Amazon Lex reads the transcript file in the bucket you provide. Specify this
- *             object if you only want Lex to read a subset of files in your Amazon S3
- *             bucket.</p>
- */
-export interface PathFormat {
-    /**
-     * @public
-     * <p>A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3
-     *             bucket. Specify this list if you only want Lex to read the files under
-     *             this set of sub-folders.</p>
-     */
-    objectPrefixes?: string[];
-}
-/**
- * @public
- * <p>The object that contains transcript filter details that are
- *             associated with a bot recommendation.</p>
- */
-export interface LexTranscriptFilter {
-    /**
-     * @public
-     * <p>The object that contains a date range filter that will be applied to
-     *             the transcript. Specify this object if you want Amazon Lex to only read the
-     *             files that are within the date range.</p>
-     */
-    dateRangeFilter?: DateRangeFilter;
-}
-/**
- * @public
- * <p>The object representing the filter that Amazon Lex will use to select the
- *             appropriate transcript.</p>
- */
-export interface TranscriptFilter {
-    /**
-     * @public
-     * <p>The object representing the filter that Amazon Lex will use to select the
-     *             appropriate transcript when the transcript format is the Amazon Lex
-     *             format.</p>
-     */
-    lexTranscriptFilter?: LexTranscriptFilter;
-}
-/**
- * @public
- * @enum
- */
-export declare const TranscriptFormat: {
-    readonly Lex: "Lex";
-};
-/**
- * @public
- */
-export type TranscriptFormat = (typeof TranscriptFormat)[keyof typeof TranscriptFormat];
-/**
- * @public
- * <p>The object representing the Amazon S3 bucket containing the transcript,
- *             as well as the associated metadata.</p>
- */
-export interface S3BucketTranscriptSource {
-    /**
-     * @public
-     * <p>The name of the bucket containing the transcript and the associated
-     *             metadata.</p>
-     */
-    s3BucketName: string | undefined;
-    /**
-     * @public
-     * <p>The object that contains a path format that will be applied when
-     *             Amazon Lex reads the transcript file in the bucket you provide. Specify this
-     *             object if you only want Lex to read a subset of files in your Amazon S3
-     *             bucket.</p>
-     */
-    pathFormat?: PathFormat;
-    /**
-     * @public
-     * <p>The format of the transcript content. Currently, Genie only supports
-     *             the Amazon Lex transcript format.</p>
-     */
-    transcriptFormat: TranscriptFormat | undefined;
-    /**
-     * @public
-     * <p>The object that contains the filter which will be applied when Amazon Lex
-     *             reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to
-     *             read only a subset of the Amazon S3 bucket based on the filter you
-     *             provide.</p>
-     */
-    transcriptFilter?: TranscriptFilter;
-    /**
-     * @public
-     * <p>The ARN of the KMS key that customer use to encrypt their Amazon S3
-     *             bucket. Only use this field if your bucket is encrypted using a
-     *             customer managed KMS key.</p>
-     */
-    kmsKeyArn?: string;
-}
-/**
- * @public
- * <p>Indicates the setting of the location where the transcript is
- *             stored.</p>
- */
-export interface TranscriptSourceSetting {
-    /**
-     * @public
-     * <p>Indicates the setting of the Amazon S3 bucket where the transcript is
-     *             stored.</p>
-     */
-    s3BucketTranscriptSource?: S3BucketTranscriptSource;
-}
 /**
  * @internal
  */