Skip to content

Latest commit

 

History

History
212 lines (120 loc) · 4.11 KB

SharePointDataSourceAssociationProps.md

File metadata and controls

212 lines (120 loc) · 4.11 KB
Raw

@cdklabs/generative-ai-cdk-constructs • Docs

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

Interface: SharePointDataSourceAssociationProps

Interface to add a new data source to an existing KB

Extends

Extended by

Properties

authSecret

readonly authSecret: ISecret

The AWS Secrets Manager secret that stores your authentication credentials for your Sharepoint instance URL. Secret must start with "AmazonBedrock-".

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

DataSourceAssociationProps.chunkingStrategy

customTransformation?

readonly optional customTransformation: CustomTransformation

The custom transformation strategy to use.

Default

- No custom transformation is used.

Inherited from

DataSourceAssociationProps.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

DataSourceAssociationProps.dataDeletionPolicy

dataSourceName?

readonly optional dataSourceName: string

The name of the data source.

Default

- A new name will be generated.

Inherited from

DataSourceAssociationProps.dataSourceName

description?

readonly optional description: string

A description of the data source.

Default

- No description is provided.

Inherited from

DataSourceAssociationProps.description

domain

readonly domain: string

The domain of your SharePoint instance or site URL/URLs.

Example

"yourdomain"

filters?

readonly optional filters: SharePointCrawlingFilters[]

The filters (regular expression patterns) for the crawling. If there's a conflict, the exclude pattern takes precedence.

Default

None - all your content is crawled.

kmsKey?

readonly optional kmsKey: IKey

The KMS key to use to encrypt the data source.

Default

- Service owned and managed key.

Inherited from

DataSourceAssociationProps.kmsKey

parsingStrategy?

readonly optional parsingStrategy: ParsingStategy

The parsing strategy to use.

Default

- No Parsing Stategy is used.

Inherited from

DataSourceAssociationProps.parsingStrategy

siteUrls

readonly siteUrls: string[]

The SharePoint site URL/URLs. Must start with “https”. All URLs must start with same protocol.

Example

["https://yourdomain.sharepoint.com/sites/mysite"]

tenantId

readonly tenantId: string

The identifier of your Microsoft 365 tenant.

Example

"d1c035a6-1dcf-457d-97e3"