generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructsDocs


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

Interface: S3DataSourceProps

Interface to create a new S3 Data Source object.

Extends

Properties

bucket

readonly bucket: IBucket

The bucket that contains the data source.

Inherited from

S3DataSourceAssociationProps.bucket


chunkingStrategy?

readonly optional chunkingStrategy: ChunkingStrategy

The chunking stategy to use for splitting your documents or content. The chunks are then converted to embeddings and written to the vector index allowing for similarity search and retrieval of the content.

Default

ChunkingStrategy.DEFAULT

Inherited from

S3DataSourceAssociationProps.chunkingStrategy


customTransformation?

readonly optional customTransformation: CustomTransformation

The custom transformation strategy to use.

Default

- No custom transformation is used.

Inherited from

S3DataSourceAssociationProps.customTransformation


dataDeletionPolicy?

readonly optional dataDeletionPolicy: DataDeletionPolicy

The data deletion policy to apply to the data source.

Default

- Sets the data deletion policy to the default of the data source type.

Inherited from

S3DataSourceAssociationProps.dataDeletionPolicy


dataSourceName?

readonly optional dataSourceName: string

The name of the data source.

Default

- A new name will be generated.

Inherited from

S3DataSourceAssociationProps.dataSourceName


description?

readonly optional description: string

A description of the data source.

Default

- No description is provided.

Inherited from

S3DataSourceAssociationProps.description


inclusionPrefixes?

readonly optional inclusionPrefixes: string[]

The prefixes of the objects in the bucket that should be included in the data source.

Default

- All objects in the bucket.

Inherited from

S3DataSourceAssociationProps.inclusionPrefixes


kmsKey?

readonly optional kmsKey: IKey

The KMS key to use to encrypt the data source.

Default

- Service owned and managed key.

Inherited from

S3DataSourceAssociationProps.kmsKey


knowledgeBase

readonly knowledgeBase: IKnowledgeBase

The knowledge base to associate with the data source.


parsingStrategy?

readonly optional parsingStrategy: ParsingStategy

The parsing strategy to use.

Default

- No Parsing Stategy is used.

Inherited from

S3DataSourceAssociationProps.parsingStrategy