generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs / bedrock / VectorKnowledgeBaseProps

Interface: VectorKnowledgeBaseProps

Properties for a knowledge base

Extends

Properties

description?

readonly optional description: string

The description of the knowledge base.

Default

- No description provided.

Inherited from

CommonKnowledgeBaseProps.description

embeddingsModel

readonly embeddingsModel: BedrockFoundationModel

The embeddings model for the knowledge base

existingRole?

readonly optional existingRole: IRole

Existing IAM role with policy statements granting appropriate permissions to invoke the specific embeddings models. Any entity (e.g., an AWS service or application) that assumes this role will be able to invoke or use the specified embeddings model within the Bedrock service.

Inherited from

CommonKnowledgeBaseProps.existingRole

indexName?

readonly optional indexName: string

The name of the vector index. If vectorStore is not of type VectorCollection, do not include this property as it will throw error.

Default

- 'bedrock-knowledge-base-default-index'

instruction?

readonly optional instruction: string

A narrative description of the knowledge base.

A Bedrock Agent can use this instruction to determine if it should query this Knowledge Base.

Default

- No description provided.

Inherited from

CommonKnowledgeBaseProps.instruction

name?

readonly optional name: string

The name of the knowledge base.

Inherited from

CommonKnowledgeBaseProps.name

supplementalDataStorageLocations?

readonly optional supplementalDataStorageLocations: SupplementalDataStorageLocation[]

The supplemental data storage locations for the knowledge base

vectorField?

readonly optional vectorField: string

The name of the field in the vector index. If vectorStore is not of type VectorCollection, do not include this property as it will throw error.

Default

- 'bedrock-knowledge-base-default-vector'

vectorIndex?

readonly optional vectorIndex: VectorIndex

The vector index for the OpenSearch Serverless backed knowledge base. If vectorStore is not of type VectorCollection, do not include this property as it will throw error.

Default

vectorStore?

readonly optional vectorStore: ExistingAmazonAuroraVectorStore | AmazonAuroraVectorStore | MongoDBAtlasVectorStore | VectorCollection | OpenSearchManagedClusterVectorStore | PineconeVectorStore

The vector store for the knowledge base. Must be either of type VectorCollection, RedisEnterpriseVectorStore, PineconeVectorStore, AmazonAuroraVectorStore, or MongoDBAtlasVectorStore.

Default

- A new OpenSearch Serverless vector collection is created.

vectorType?

readonly optional vectorType: VectorType

The vector type to store vector embeddings.

Default

- VectorType.FLOATING_POINT
This site is open source. Improve this page.