Interface CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnKnowledgeBasePropsMixin
@Stability(Stable)
public static interface CfnKnowledgeBasePropsMixin.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.cfnpropertymixins.services.bedrock.*;
KnowledgeBaseConfigurationProperty knowledgeBaseConfigurationProperty = KnowledgeBaseConfigurationProperty.builder()
.kendraKnowledgeBaseConfiguration(KendraKnowledgeBaseConfigurationProperty.builder()
.kendraIndexArn("kendraIndexArn")
.build())
.sqlKnowledgeBaseConfiguration(SqlKnowledgeBaseConfigurationProperty.builder()
.redshiftConfiguration(RedshiftConfigurationProperty.builder()
.queryEngineConfiguration(RedshiftQueryEngineConfigurationProperty.builder()
.provisionedConfiguration(RedshiftProvisionedConfigurationProperty.builder()
.authConfiguration(RedshiftProvisionedAuthConfigurationProperty.builder()
.databaseUser("databaseUser")
.type("type")
.usernamePasswordSecretArn("usernamePasswordSecretArn")
.build())
.clusterIdentifier("clusterIdentifier")
.build())
.serverlessConfiguration(RedshiftServerlessConfigurationProperty.builder()
.authConfiguration(RedshiftServerlessAuthConfigurationProperty.builder()
.type("type")
.usernamePasswordSecretArn("usernamePasswordSecretArn")
.build())
.workgroupArn("workgroupArn")
.build())
.type("type")
.build())
.queryGenerationConfiguration(QueryGenerationConfigurationProperty.builder()
.executionTimeoutSeconds(123)
.generationContext(QueryGenerationContextProperty.builder()
.curatedQueries(List.of(CuratedQueryProperty.builder()
.naturalLanguage("naturalLanguage")
.sql("sql")
.build()))
.tables(List.of(QueryGenerationTableProperty.builder()
.columns(List.of(QueryGenerationColumnProperty.builder()
.description("description")
.inclusion("inclusion")
.name("name")
.build()))
.description("description")
.inclusion("inclusion")
.name("name")
.build()))
.build())
.build())
.storageConfigurations(List.of(RedshiftQueryEngineStorageConfigurationProperty.builder()
.awsDataCatalogConfiguration(RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty.builder()
.tableNames(List.of("tableNames"))
.build())
.redshiftConfiguration(RedshiftQueryEngineRedshiftStorageConfigurationProperty.builder()
.databaseName("databaseName")
.build())
.type("type")
.build()))
.build())
.type("type")
.build())
.type("type")
.vectorKnowledgeBaseConfiguration(VectorKnowledgeBaseConfigurationProperty.builder()
.embeddingModelArn("embeddingModelArn")
.embeddingModelConfiguration(EmbeddingModelConfigurationProperty.builder()
.bedrockEmbeddingModelConfiguration(BedrockEmbeddingModelConfigurationProperty.builder()
.audio(List.of(AudioConfigurationProperty.builder()
.segmentationConfiguration(AudioSegmentationConfigurationProperty.builder()
.fixedLengthDuration(123)
.build())
.build()))
.dimensions(123)
.embeddingDataType("embeddingDataType")
.video(List.of(VideoConfigurationProperty.builder()
.segmentationConfiguration(VideoSegmentationConfigurationProperty.builder()
.fixedLengthDuration(123)
.build())
.build()))
.build())
.build())
.supplementalDataStorageConfiguration(SupplementalDataStorageConfigurationProperty.builder()
.supplementalDataStorageLocations(List.of(SupplementalDataStorageLocationProperty.builder()
.s3Location(S3LocationProperty.builder()
.uri("uri")
.build())
.supplementalDataStorageLocationType("supplementalDataStorageLocationType")
.build()))
.build())
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classstatic final classAn implementation forCfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectSettings for an Amazon Kendra knowledge base.default ObjectSpecifies configurations for a knowledge base connected to an SQL database.default StringgetType()The type of data that the data source is converted into for the knowledge base.default ObjectContains details about the model that's used to convert the data source into vector embeddings.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getKendraKnowledgeBaseConfiguration
Settings for an Amazon Kendra knowledge base.Returns union: either
IResolvableorCfnKnowledgeBasePropsMixin.KendraKnowledgeBaseConfigurationProperty- See Also:
-
getSqlKnowledgeBaseConfiguration
Specifies configurations for a knowledge base connected to an SQL database.Returns union: either
IResolvableorCfnKnowledgeBasePropsMixin.SqlKnowledgeBaseConfigurationProperty- See Also:
-
getType
The type of data that the data source is converted into for the knowledge base.- See Also:
-
getVectorKnowledgeBaseConfiguration
Contains details about the model that's used to convert the data source into vector embeddings.Returns union: either
IResolvableorCfnKnowledgeBasePropsMixin.VectorKnowledgeBaseConfigurationProperty- See Also:
-
builder
@Stability(Stable) static CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty.Builder builder()
-