Package software.amazon.awscdk.services.lex

Interface CfnBot.DataSourceConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.DataSourceConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBot

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

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.

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.*;
 DataSourceConfigurationProperty dataSourceConfigurationProperty = DataSourceConfigurationProperty.builder()
         .bedrockKnowledgeStoreConfiguration(BedrockKnowledgeStoreConfigurationProperty.builder()
                 .bedrockKnowledgeBaseArn("bedrockKnowledgeBaseArn")
                 .bkbExactResponseFields(BKBExactResponseFieldsProperty.builder()
                         .answerField("answerField")
                         .build())
                 .exactResponse(false)
                 .build())
         .kendraConfiguration(QnAKendraConfigurationProperty.builder()
                 .exactResponse(false)
                 .kendraIndex("kendraIndex")
                 .queryFilterStringEnabled(false)
                 // the properties below are optional
                 .queryFilterString("queryFilterString")
                 .build())
         .opensearchConfiguration(OpensearchConfigurationProperty.builder()
                 .domainEndpoint("domainEndpoint")
                 .exactResponse(false)
                 .exactResponseFields(ExactResponseFieldsProperty.builder()
                         .answerField("answerField")
                         .questionField("questionField")
                         .build())
                 .includeFields(List.of("includeFields"))
                 .indexName("indexName")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBot.DataSourceConfigurationProperty.Builder	builder()
default Object	getBedrockKnowledgeStoreConfiguration()	Contains details about the configuration of the Amazon Bedrock knowledge base used for the AMAZON.QnAIntent .
default Object	getKendraConfiguration()	Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent .
default Object	getOpensearchConfiguration()	Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBedrockKnowledgeStoreConfiguration

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

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 .

Returns union: either IResolvable or CfnBot.BedrockKnowledgeStoreConfigurationProperty

See Also:

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

getKendraConfiguration

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

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 .

Returns union: either IResolvable or CfnBot.QnAKendraConfigurationProperty

See Also:

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

getOpensearchConfiguration

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

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 .

Returns union: either IResolvable or CfnBot.OpensearchConfigurationProperty

See Also:

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

builder

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

Returns:

a CfnBot.DataSourceConfigurationProperty.Builder of CfnBot.DataSourceConfigurationProperty