Experimental
@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
KnowledgeBaseEmbeddingsModelProps Struct
Properties for KnowledgeBaseEmbeddingsModel.
| Stability | Experimental |
|---|---|
| Source | bedrock/mixins/knowledge-base.ts |
| Type last changed |
Example
ts
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.KnowledgeBaseEmbeddingsModel({
embeddingsModel: bedrock.BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024,
}));
python
# role: iam.Role
aws_bedrock_cfn.CfnKnowledgeBase(self, "KnowledgeBase",
name="product-documentation",
role_arn=role.role_arn,
knowledge_base_configuration=aws_bedrock_cfn.CfnKnowledgeBase.KnowledgeBaseConfigurationProperty(type="VECTOR")
).with(bedrock.mixins.KnowledgeBaseEmbeddingsModel(
embeddings_model=bedrock.BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024
))
java
Role role;
CfnKnowledgeBase.Builder.create(this, "KnowledgeBase")
.name("product-documentation")
.roleArn(role.roleArn)
.knowledgeBaseConfiguration(KnowledgeBaseConfigurationProperty.builder().type("VECTOR").build())
.build().with(KnowledgeBaseEmbeddingsModel.Builder.create()
.embeddingsModel(BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024)
.build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Alpha
Role role;
new CfnKnowledgeBase(this, "KnowledgeBase", new CfnKnowledgeBaseProps {
Name = "product-documentation",
RoleArn = role.RoleArn,
KnowledgeBaseConfiguration = new KnowledgeBaseConfigurationProperty { Type = "VECTOR" }
}).With(new Mixins.KnowledgeBaseEmbeddingsModel(new KnowledgeBaseEmbeddingsModelProps {
EmbeddingsModel = BedrockFoundationModel.TITAN_EMBED_TEXT_V2_1024
}));
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockalpha/v2
var role Role
awscdk.Aws_bedrock.NewCfnKnowledgeBase(this, jsii.String("KnowledgeBase"), &CfnKnowledgeBaseProps{
Name: jsii.String("product-documentation"),
RoleArn: role.roleArn,
KnowledgeBaseConfiguration: &KnowledgeBaseConfigurationProperty{
Type: jsii.String("VECTOR"),
},
}).With(mixins.NewKnowledgeBaseEmbeddingsModel(&KnowledgeBaseEmbeddingsModelProps{
EmbeddingsModel: bedrock.BedrockFoundationModel_TITAN_EMBED_TEXT_V2_1024(),
}))
Properties
embeddingsModelBedrockFoundationModelembeddings_modelBedrockFoundationModelembeddingsModelBedrockFoundationModelEmbeddingsModelBedrockFoundationModelEmbeddingsModelBedrockFoundationModel required #The model used to create vector embeddings for the knowledge base.
vectorTypeoptionalVectorTypevector_typeoptionalVectorTypevectorTypeoptionalVectorTypeVectorTypeoptionalVectorTypeVectorTypeoptionalVectorType = VectorType.FLOATING_POINT #The data type of the vector embeddings.