Package software.amazon.awscdk.services.lex

Interface CfnBot.BedrockKnowledgeStoreConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.BedrockKnowledgeStoreConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBot

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

Contains details about the configuration of a Amazon Bedrock knowledge base.

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.*;
 BedrockKnowledgeStoreConfigurationProperty bedrockKnowledgeStoreConfigurationProperty = BedrockKnowledgeStoreConfigurationProperty.builder()
         .bedrockKnowledgeBaseArn("bedrockKnowledgeBaseArn")
         .bkbExactResponseFields(BKBExactResponseFieldsProperty.builder()
                 .answerField("answerField")
                 .build())
         .exactResponse(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBot.BedrockKnowledgeStoreConfigurationProperty.Builder	builder()
default String	getBedrockKnowledgeBaseArn()	The base ARN of the knowledge base used.
default Object	getBkbExactResponseFields()	Contains the names of the fields used for an exact response to the user.
default Object	getExactResponse()	Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBedrockKnowledgeBaseArn

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

The base ARN of the knowledge base used.

See Also:

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

getBkbExactResponseFields

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

Contains the names of the fields used for an exact response to the user.

See Also:

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

getExactResponse

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

Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.

See Also:

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

builder

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

Returns:

a CfnBot.BedrockKnowledgeStoreConfigurationProperty.Builder of CfnBot.BedrockKnowledgeStoreConfigurationProperty