Skip to content
v2.274.0

Experimental

@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

KnowledgeBaseType Class Added in v2.274.0-alpha.0 ​

The type of a knowledge base, which determines how its data is stored and queried.

Use one of the static factory methods to configure a type. To configure a CfnKnowledgeBase as a type, apply mixins.KnowledgeBaseTypeConfiguration.

Example ​

ts
declare const collection: opensearchserverless.ICollectionRef;
declare const role: iam.Role;

new aws_bedrock_cfn.CfnKnowledgeBase(this, 'KnowledgeBase', {
  name: 'product-documentation',
  roleArn: role.roleArn,
  knowledgeBaseConfiguration: { type: 'VECTOR' },
}).with(new bedrock.mixins.KnowledgeBaseTypeConfiguration(bedrock.KnowledgeBaseType.vector({
  embeddingsModel: bedrock.BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024,
  vectorStore: bedrock.VectorStore.openSearchServerless({
    collection,
    vectorIndexName: 'bedrock-knowledge-base-default-index',
    vectorField: 'bedrock-knowledge-base-default-vector',
    textField: 'AMAZON_BEDROCK_TEXT_CHUNK',
    metadataField: 'AMAZON_BEDROCK_METADATA',
  }),
})));

Methods ​

vector(props: VectorKnowledgeBaseTypeProps): KnowledgeBaseType // chainable@staticmethod def vector(props: VectorKnowledgeBaseTypeProps) -> KnowledgeBaseTypepublic static KnowledgeBaseType vector(VectorKnowledgeBaseTypeProps props)public static KnowledgeBaseType Vector(VectorKnowledgeBaseTypeProps props)func Vector(Props VectorKnowledgeBaseTypeProps) KnowledgeBaseTypestatic#
A knowledge base that stores vector embeddings of ingested documents in a vector store and retrieves them by similarity search.