aws-cdk-lib.aws_lex.CfnBot.KendraConfigurationProperty

interface KendraConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Lex.CfnBot.KendraConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslex#CfnBot_KendraConfigurationProperty
Javasoftware.amazon.awscdk.services.lex.CfnBot.KendraConfigurationProperty
Pythonaws_cdk.aws_lex.CfnBot.KendraConfigurationProperty
TypeScript aws-cdk-lib » aws_lex » CfnBot » KendraConfigurationProperty

Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lex as lex } from 'aws-cdk-lib';
const kendraConfigurationProperty: lex.CfnBot.KendraConfigurationProperty = {
  kendraIndex: 'kendraIndex',

  // the properties below are optional
  queryFilterString: 'queryFilterString',
  queryFilterStringEnabled: false,
};

Properties

NameTypeDescription
kendraIndexstringThe Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
queryFilterString?stringA query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.
queryFilterStringEnabled?boolean | IResolvableDetermines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

kendraIndex

Type: string

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.


queryFilterString?

Type: string (optional)

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.

The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries .


queryFilterStringEnabled?

Type: boolean | IResolvable (optional)

Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.