Package software.amazon.awscdk.services.lex

Interface CfnBot.KendraConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.KendraConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBot

@Stability(Stable)
public static interface CfnBot.KendraConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.lex.*;
 KendraConfigurationProperty kendraConfigurationProperty = KendraConfigurationProperty.builder()
         .kendraIndex("kendraIndex")
         // the properties below are optional
         .queryFilterString("queryFilterString")
         .queryFilterStringEnabled(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBot.KendraConfigurationProperty.Builder	A builder for CfnBot.KendraConfigurationProperty
static final class	CfnBot.KendraConfigurationProperty.Jsii$Proxy	An implementation for CfnBot.KendraConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnBot.KendraConfigurationProperty.Builder	builder()
String	getKendraIndex()	The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search.
default String	getQueryFilterString()	A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.
default Object	getQueryFilterStringEnabled()	Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKendraIndex

@Stability(Stable)
@NotNull
String getKendraIndex()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html#cfn-lex-bot-kendraconfiguration-kendraindex

getQueryFilterString

@Stability(Stable)
@Nullable
default String getQueryFilterString()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html#cfn-lex-bot-kendraconfiguration-queryfilterstring

getQueryFilterStringEnabled

@Stability(Stable)
@Nullable
default Object getQueryFilterStringEnabled()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html#cfn-lex-bot-kendraconfiguration-queryfilterstringenabled

builder

@Stability(Stable)
static CfnBot.KendraConfigurationProperty.Builder builder()

Returns:

a CfnBot.KendraConfigurationProperty.Builder of CfnBot.KendraConfigurationProperty