Class CfnBotPropsMixin.QnAKendraConfigurationProperty

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

Inheritance

object

CfnBotPropsMixin.QnAKendraConfigurationProperty

Implements

CfnBotPropsMixin.IQnAKendraConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Lex.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnBotPropsMixin.QnAKendraConfigurationProperty : CfnBotPropsMixin.IQnAKendraConfigurationProperty

Syntax (vb)

Public Class CfnBotPropsMixin.QnAKendraConfigurationProperty Implements CfnBotPropsMixin.IQnAKendraConfigurationProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Lex.Mixins;

             var qnAKendraConfigurationProperty = new QnAKendraConfigurationProperty {
                 ExactResponse = false,
                 KendraIndex = "kendraIndex",
                 QueryFilterString = "queryFilterString",
                 QueryFilterStringEnabled = false
             };

Synopsis

Constructors

QnAKendraConfigurationProperty()

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

Properties

ExactResponse	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.
KendraIndex	The ARN of the Amazon Kendra index to use.
QueryFilterString	Contains the Amazon Kendra filter string to use if enabled.
QueryFilterStringEnabled	Specifies whether to enable an Amazon Kendra filter string or not.

Constructors

QnAKendraConfigurationProperty()

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

public QnAKendraConfigurationProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Lex.Mixins;

             var qnAKendraConfigurationProperty = new QnAKendraConfigurationProperty {
                 ExactResponse = false,
                 KendraIndex = "kendraIndex",
                 QueryFilterString = "queryFilterString",
                 QueryFilterStringEnabled = false
             };

Properties

ExactResponse

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.

public object? ExactResponse { get; set; }

Property Value

object

Remarks

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 .

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

Type union: either bool or IResolvable

KendraIndex

The ARN of the Amazon Kendra index to use.

public string? KendraIndex { get; set; }

Property Value

string

Remarks

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

QueryFilterString

Contains the Amazon Kendra filter string to use if enabled.

public string? QueryFilterString { get; set; }

Property Value

string

Remarks

For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results .

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

QueryFilterStringEnabled

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

public object? QueryFilterStringEnabled { get; set; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

Implements

CfnBotPropsMixin.IQnAKendraConfigurationProperty