Package software.amazon.awscdk.services.bedrock

Interface CfnKnowledgeBase.KnowledgeBaseConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnKnowledgeBase.KnowledgeBaseConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnKnowledgeBase
@Stability(Stable) public static interface CfnKnowledgeBase.KnowledgeBaseConfigurationProperty extends software.amazon.jsii.JsiiSerializable
Configurations to apply to a knowledge base attached to the agent during query.

For more information, see Knowledge base retrieval configurations .

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.bedrock.*;
 KnowledgeBaseConfigurationProperty knowledgeBaseConfigurationProperty = KnowledgeBaseConfigurationProperty.builder()
         .type("type")
         // the properties below are optional
         .kendraKnowledgeBaseConfiguration(KendraKnowledgeBaseConfigurationProperty.builder()
                 .kendraIndexArn("kendraIndexArn")
                 .build())
         .sqlKnowledgeBaseConfiguration(SqlKnowledgeBaseConfigurationProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .redshiftConfiguration(RedshiftConfigurationProperty.builder()
                         .queryEngineConfiguration(RedshiftQueryEngineConfigurationProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .provisionedConfiguration(RedshiftProvisionedConfigurationProperty.builder()
                                         .authConfiguration(RedshiftProvisionedAuthConfigurationProperty.builder()
                                                 .type("type")
                                                 // the properties below are optional
                                                 .databaseUser("databaseUser")
                                                 .usernamePasswordSecretArn("usernamePasswordSecretArn")
                                                 .build())
                                         .clusterIdentifier("clusterIdentifier")
                                         .build())
                                 .serverlessConfiguration(RedshiftServerlessConfigurationProperty.builder()
                                         .authConfiguration(RedshiftServerlessAuthConfigurationProperty.builder()
                                                 .type("type")
                                                 // the properties below are optional
                                                 .usernamePasswordSecretArn("usernamePasswordSecretArn")
                                                 .build())
                                         .workgroupArn("workgroupArn")
                                         .build())
                                 .build())
                         .storageConfigurations(List.of(RedshiftQueryEngineStorageConfigurationProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .awsDataCatalogConfiguration(RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty.builder()
                                         .tableNames(List.of("tableNames"))
                                         .build())
                                 .redshiftConfiguration(RedshiftQueryEngineRedshiftStorageConfigurationProperty.builder()
                                         .databaseName("databaseName")
                                         .build())
                                 .build()))
                         // the properties below are optional
                         .queryGenerationConfiguration(QueryGenerationConfigurationProperty.builder()
                                 .executionTimeoutSeconds(123)
                                 .generationContext(QueryGenerationContextProperty.builder()
                                         .curatedQueries(List.of(CuratedQueryProperty.builder()
                                                 .naturalLanguage("naturalLanguage")
                                                 .sql("sql")
                                                 .build()))
                                         .tables(List.of(QueryGenerationTableProperty.builder()
                                                 .name("name")
                                                 // the properties below are optional
                                                 .columns(List.of(QueryGenerationColumnProperty.builder()
                                                         .description("description")
                                                         .inclusion("inclusion")
                                                         .name("name")
                                                         .build()))
                                                 .description("description")
                                                 .inclusion("inclusion")
                                                 .build()))
                                         .build())
                                 .build())
                         .build())
                 .build())
         .vectorKnowledgeBaseConfiguration(VectorKnowledgeBaseConfigurationProperty.builder()
                 .embeddingModelArn("embeddingModelArn")
                 // the properties below are optional
                 .embeddingModelConfiguration(EmbeddingModelConfigurationProperty.builder()
                         .bedrockEmbeddingModelConfiguration(BedrockEmbeddingModelConfigurationProperty.builder()
                                 .dimensions(123)
                                 .embeddingDataType("embeddingDataType")
                                 .build())
                         .build())
                 .supplementalDataStorageConfiguration(SupplementalDataStorageConfigurationProperty.builder()
                         .supplementalDataStorageLocations(List.of(SupplementalDataStorageLocationProperty.builder()
                                 .supplementalDataStorageLocationType("supplementalDataStorageLocationType")
                                 // the properties below are optional
                                 .s3Location(S3LocationProperty.builder()
                                         .uri("uri")
                                         .build())
                                 .build()))
                         .build())
                 .build())
         .build();

See Also: