Contains details about the configuration of a Amazon Bedrock knowledge base.
+ */ +export interface BedrockKnowledgeStoreConfiguration { + /** + * @public + *The ARN of the knowledge base used.
+ */ + bedrockKnowledgeBaseArn: string | undefined; +} + /** * @public *Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
@@ -6148,6 +6160,132 @@ export interface OutputContext { turnsToLive: number | undefined; } +/** + * @public + *Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent.
The ARN of the Amazon Kendra index to use.
+ */ + kendraIndex: string | undefined; + + /** + * @public + *Specifies whether to enable an Amazon Kendra filter string or not.
+ */ + queryFilterStringEnabled?: boolean; + + /** + * @public + *Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.
+ */ + queryFilterString?: string; + + /** + * @public + *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 Adding frequently asked questions (FAQs) to an index.
+ */ + exactResponse?: boolean; +} + +/** + * @public + *Contains the names of the fields used for an exact response to the user.
+ */ +export interface ExactResponseFields { + /** + * @public + *The name of the field that contains the query made to the OpenSearch Service database.
+ */ + questionField: string | undefined; + + /** + * @public + *The name of the field that contains the answer to the query made to the OpenSearch Service database.
+ */ + answerField: string | undefined; +} + +/** + * @public + *Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent.
The endpoint of the Amazon OpenSearch Service domain.
+ */ + domainEndpoint: string | undefined; + + /** + * @public + *The name of the Amazon OpenSearch Service index.
+ */ + indexName: string | undefined; + + /** + * @public + *Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
+ */ + exactResponse?: boolean; + + /** + * @public + *Contains the names of the fields used for an exact response to the user.
+ */ + exactResponseFields?: ExactResponseFields; + + /** + * @public + *Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
+ */ + includeFields?: string[]; +} + +/** + * @public + *Contains details about the configuration of the knowledge store used for the AMAZON.QnAIntent. You must have already created the knowledge store and indexed the documents within it.
Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent. To create a domain, follow the steps at Creating and managing Amazon OpenSearch Service domains.
Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent. To create a Amazon Kendra index, follow the steps at Creating an index.
Contains details about the configuration of the Amazon Bedrock knowledge base used for the AMAZON.QnAIntent. To set up a knowledge base, follow the steps at Building a knowledge base.
Details about the the configuration of the built-in Amazon.QnAIntent.
Contains details about the configuration of the data source used for the AMAZON.QnAIntent.
Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
+ */ + bedrockModelConfiguration?: BedrockModelSpecification; +} + /** * @public *A sample utterance that invokes an intent or respond to a slot @@ -8169,127 +8307,6 @@ export interface EncryptionSetting { associatedTranscriptsPassword?: string; } -/** - * @public - *
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.
- */ -export interface PathFormat { - /** - * @public - *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.
- */ - objectPrefixes?: string[]; -} - -/** - * @public - *The object that contains transcript filter details that are - * associated with a bot recommendation.
- */ -export interface LexTranscriptFilter { - /** - * @public - *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.
- */ - dateRangeFilter?: DateRangeFilter; -} - -/** - * @public - *The object representing the filter that Amazon Lex will use to select the - * appropriate transcript.
- */ -export interface TranscriptFilter { - /** - * @public - *The object representing the filter that Amazon Lex will use to select the - * appropriate transcript when the transcript format is the Amazon Lex - * format.
- */ - lexTranscriptFilter?: LexTranscriptFilter; -} - -/** - * @public - * @enum - */ -export const TranscriptFormat = { - Lex: "Lex", -} as const; - -/** - * @public - */ -export type TranscriptFormat = (typeof TranscriptFormat)[keyof typeof TranscriptFormat]; - -/** - * @public - *The object representing the Amazon S3 bucket containing the transcript, - * as well as the associated metadata.
- */ -export interface S3BucketTranscriptSource { - /** - * @public - *The name of the bucket containing the transcript and the associated - * metadata.
- */ - s3BucketName: string | undefined; - - /** - * @public - *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.
- */ - pathFormat?: PathFormat; - - /** - * @public - *The format of the transcript content. Currently, Genie only supports - * the Amazon Lex transcript format.
- */ - transcriptFormat: TranscriptFormat | undefined; - - /** - * @public - *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.
- */ - transcriptFilter?: TranscriptFilter; - - /** - * @public - *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.
- */ - kmsKeyArn?: string; -} - -/** - * @public - *Indicates the setting of the location where the transcript is - * stored.
- */ -export interface TranscriptSourceSetting { - /** - * @public - *Indicates the setting of the Amazon S3 bucket where the transcript is - * stored.
- */ - s3BucketTranscriptSource?: S3BucketTranscriptSource; -} - /** * @internal */ diff --git a/clients/client-lex-models-v2/src/models/models_1.ts b/clients/client-lex-models-v2/src/models/models_1.ts index 4d0147e5ff23..dd1de0cfe940 100644 --- a/clients/client-lex-models-v2/src/models/models_1.ts +++ b/clients/client-lex-models-v2/src/models/models_1.ts @@ -76,6 +76,7 @@ import { CustomVocabularyItem, CustomVocabularyStatus, DataPrivacy, + DateRangeFilter, DialogAction, DialogCodeHookSettings, ElicitationCodeHookInvocationSetting, @@ -97,6 +98,7 @@ import { OutputContext, ParentBotNetwork, PromptSpecification, + QnAIntentConfiguration, ResponseSpecification, SampleUtterance, SentimentAnalysisSettings, @@ -111,11 +113,131 @@ import { SubSlotSetting, TestResultMatchStatus, TestSetDiscrepancyReportResourceTarget, - TranscriptSourceSetting, VoiceSettings, WaitAndContinueSpecification, } from "./models_0"; +/** + * @public + *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.
+ */ +export interface PathFormat { + /** + * @public + *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.
+ */ + objectPrefixes?: string[]; +} + +/** + * @public + *The object that contains transcript filter details that are + * associated with a bot recommendation.
+ */ +export interface LexTranscriptFilter { + /** + * @public + *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.
+ */ + dateRangeFilter?: DateRangeFilter; +} + +/** + * @public + *The object representing the filter that Amazon Lex will use to select the + * appropriate transcript.
+ */ +export interface TranscriptFilter { + /** + * @public + *The object representing the filter that Amazon Lex will use to select the + * appropriate transcript when the transcript format is the Amazon Lex + * format.
+ */ + lexTranscriptFilter?: LexTranscriptFilter; +} + +/** + * @public + * @enum + */ +export const TranscriptFormat = { + Lex: "Lex", +} as const; + +/** + * @public + */ +export type TranscriptFormat = (typeof TranscriptFormat)[keyof typeof TranscriptFormat]; + +/** + * @public + *The object representing the Amazon S3 bucket containing the transcript, + * as well as the associated metadata.
+ */ +export interface S3BucketTranscriptSource { + /** + * @public + *The name of the bucket containing the transcript and the associated + * metadata.
+ */ + s3BucketName: string | undefined; + + /** + * @public + *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.
+ */ + pathFormat?: PathFormat; + + /** + * @public + *The format of the transcript content. Currently, Genie only supports + * the Amazon Lex transcript format.
+ */ + transcriptFormat: TranscriptFormat | undefined; + + /** + * @public + *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.
+ */ + transcriptFilter?: TranscriptFilter; + + /** + * @public + *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.
+ */ + kmsKeyArn?: string; +} + +/** + * @public + *Indicates the setting of the location where the transcript is + * stored.
+ */ +export interface TranscriptSourceSetting { + /** + * @public + *Indicates the setting of the Amazon S3 bucket where the transcript is + * stored.
+ */ + s3BucketTranscriptSource?: S3BucketTranscriptSource; +} + /** * @public */ @@ -9300,6 +9422,13 @@ export interface CreateIntentRequest { * the beginning of a conversation, before eliciting slot values. */ initialResponseSetting?: InitialResponseSetting; + + /** + * @public + *Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when
+ * Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.
Details about the the configuration of the built-in Amazon.QnAIntent.
Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
*/ initialResponseSetting?: InitialResponseSetting; + + /** + * @public + *Details about the configuration of the built-in Amazon.QnAIntent.
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
*/ initialResponseSetting?: InitialResponseSetting; + + /** + * @public + *Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when
+ * Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
*/ initialResponseSetting?: InitialResponseSetting; + + /** + * @public + *Details about the configuration of the built-in Amazon.QnAIntent.
The ARN of the knowledge base used.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the configuration of a Amazon Bedrock knowledge base.
" + } + }, "com.amazonaws.lexmodelsv2#BedrockModelArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model\\/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}$" + "smithy.api#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}$" } }, "com.amazonaws.lexmodelsv2#BedrockModelSpecification": { @@ -4169,7 +4197,10 @@ } }, "sampleUtteranceGeneration": { - "target": "com.amazonaws.lexmodelsv2#SampleUtteranceGenerationSpecification" + "target": "com.amazonaws.lexmodelsv2#SampleUtteranceGenerationSpecification", + "traits": { + "smithy.api#documentation": "Contains specifications for the sample utterance generation feature.
" + } } }, "traits": { @@ -5883,6 +5914,12 @@ "traits": { "smithy.api#documentation": "Configuration settings for the response that is sent to the user at\n the beginning of a conversation, before eliciting slot values.
" } + }, + "qnAIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QnAIntentConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when\n Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.
Configuration settings for the response that is sent to the user at\n the beginning of a conversation, before eliciting slot values.
" } + }, + "qnAIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QnAIntentConfiguration", + "traits": { + "smithy.api#documentation": "Details about the the configuration of the built-in Amazon.QnAIntent.
By default, data stored by Amazon Lex is encrypted. The\n DataPrivacy structure provides settings that determine\n how Amazon Lex handles special cases of securing the data for your bot.\n
Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent. To create a domain, follow the steps at Creating and managing Amazon OpenSearch Service domains.
Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent. To create a Amazon Kendra index, follow the steps at Creating an index.
Contains details about the configuration of the Amazon Bedrock knowledge base used for the AMAZON.QnAIntent. To set up a knowledge base, follow the steps at Building a knowledge base.
Contains details about the configuration of the knowledge store used for the AMAZON.QnAIntent. You must have already created the knowledge store and indexed the documents within it.
Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
" } + }, + "qnAIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QnAIntentConfiguration", + "traits": { + "smithy.api#documentation": "Details about the configuration of the built-in Amazon.QnAIntent.
The current state of the conversation with the user.
" } }, + "com.amazonaws.lexmodelsv2#DomainEndpoint": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(http|https):\\/\\/+[^\\s]+[\\w]$" + } + }, "com.amazonaws.lexmodelsv2#DraftBotVersion": { "type": "string", "traits": { @@ -11291,6 +11372,28 @@ "com.amazonaws.lexmodelsv2#ErrorMessage": { "type": "string" }, + "com.amazonaws.lexmodelsv2#ExactResponseFields": { + "type": "structure", + "members": { + "questionField": { + "target": "com.amazonaws.lexmodelsv2#QuestionField", + "traits": { + "smithy.api#documentation": "The name of the field that contains the query made to the OpenSearch Service database.
", + "smithy.api#required": {} + } + }, + "answerField": { + "target": "com.amazonaws.lexmodelsv2#AnswerField", + "traits": { + "smithy.api#documentation": "The name of the field that contains the answer to the query made to the OpenSearch Service database.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the names of the fields used for an exact response to the user.
" + } + }, "com.amazonaws.lexmodelsv2#ExceptionMessage": { "type": "string" }, @@ -12458,6 +12561,9 @@ "smithy.api#pattern": "^([0-9a-zA-Z_])+$" } }, + "com.amazonaws.lexmodelsv2#IncludeField": { + "type": "string" + }, "com.amazonaws.lexmodelsv2#InitialResponseSetting": { "type": "structure", "members": { @@ -17937,6 +18043,28 @@ "smithy.api#pattern": "^[0-9]+$" } }, + "com.amazonaws.lexmodelsv2#OSIncludeFields": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#IncludeField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.lexmodelsv2#OSIndexName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(?![_-])[a-z0-9][a-z0-9_\\-]{0,254}$" + } + }, "com.amazonaws.lexmodelsv2#ObfuscationSetting": { "type": "structure", "members": { @@ -17990,6 +18118,47 @@ } } }, + "com.amazonaws.lexmodelsv2#OpensearchConfiguration": { + "type": "structure", + "members": { + "domainEndpoint": { + "target": "com.amazonaws.lexmodelsv2#DomainEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint of the Amazon OpenSearch Service domain.
", + "smithy.api#required": {} + } + }, + "indexName": { + "target": "com.amazonaws.lexmodelsv2#OSIndexName", + "traits": { + "smithy.api#documentation": "The name of the Amazon OpenSearch Service index.
", + "smithy.api#required": {} + } + }, + "exactResponse": { + "target": "com.amazonaws.lexmodelsv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
" + } + }, + "exactResponseFields": { + "target": "com.amazonaws.lexmodelsv2#ExactResponseFields", + "traits": { + "smithy.api#documentation": "Contains the names of the fields used for an exact response to the user.
" + } + }, + "includeFields": { + "target": "com.amazonaws.lexmodelsv2#OSIncludeFields", + "traits": { + "smithy.api#documentation": "Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent.
Specifies a list of message groups that Amazon Lex sends to a user to\n elicit a response.
" } }, + "com.amazonaws.lexmodelsv2#QnAIntentConfiguration": { + "type": "structure", + "members": { + "dataSourceConfiguration": { + "target": "com.amazonaws.lexmodelsv2#DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the data source used for the AMAZON.QnAIntent.
Details about the the configuration of the built-in Amazon.QnAIntent.
The ARN of the Amazon Kendra index to use.
", + "smithy.api#required": {} + } + }, + "queryFilterStringEnabled": { + "target": "com.amazonaws.lexmodelsv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether to enable an Amazon Kendra filter string or not.
" + } + }, + "queryFilterString": { + "target": "com.amazonaws.lexmodelsv2#QueryFilterString", + "traits": { + "smithy.api#documentation": "Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.
" + } + }, + "exactResponse": { + "target": "com.amazonaws.lexmodelsv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "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 Adding frequently asked questions (FAQs) to an index.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent.
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
" } + }, + "qnAIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QnAIntentConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when\n Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
" } + }, + "qnAIntentConfiguration": { + "target": "com.amazonaws.lexmodelsv2#QnAIntentConfiguration", + "traits": { + "smithy.api#documentation": "Details about the configuration of the built-in Amazon.QnAIntent.