Package software.amazon.awscdk.cfnpropertymixins.services.lex

Interface CfnBotPropsMixin.QnAKendraConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBotPropsMixin.QnAKendraConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBotPropsMixin

@Stability(Stable)
public static interface CfnBotPropsMixin.QnAKendraConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.lex.*;
 QnAKendraConfigurationProperty qnAKendraConfigurationProperty = QnAKendraConfigurationProperty.builder()
         .exactResponse(false)
         .kendraIndex("kendraIndex")
         .queryFilterString("queryFilterString")
         .queryFilterStringEnabled(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBotPropsMixin.QnAKendraConfigurationProperty.Builder	builder()
default Object	getExactResponse()	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.
default String	getKendraIndex()	The ARN of the Amazon Kendra index to use.
default String	getQueryFilterString()	Contains the Amazon Kendra filter string to use if enabled.
default Object	getQueryFilterStringEnabled()	Specifies whether to enable an Amazon Kendra filter string or not.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExactResponse

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

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 .

Returns union: either Boolean or IResolvable

See Also:

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

getKendraIndex

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

The ARN of the Amazon Kendra index to use.

See Also:

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

getQueryFilterString

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

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 .

See Also:

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

getQueryFilterStringEnabled

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

Specifies whether to enable an Amazon Kendra filter string or not.

Returns union: either Boolean or IResolvable

See Also:

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

builder

@Stability(Stable)
static CfnBotPropsMixin.QnAKendraConfigurationProperty.Builder builder()

Returns:

a CfnBotPropsMixin.QnAKendraConfigurationProperty.Builder of CfnBotPropsMixin.QnAKendraConfigurationProperty