Skip to content

Latest commit

 

History

History
236 lines (132 loc) · 5.19 KB

SharePointDataSourceProps.md

File metadata and controls

236 lines (132 loc) · 5.19 KB

@cdklabs/generative-ai-cdk-constructs


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

Interface: SharePointDataSourceProps

Interface to create a new standalone data source object

Extends

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

Inherited from

SharePointDataSourceAssociationProps.authSecret


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

SharePointDataSourceAssociationProps.chunkingStrategy


customTransformation?

readonly optional customTransformation: CustomTransformation

The custom transformation strategy to use.

Default

- No custom transformation is used.

Inherited from

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

SharePointDataSourceAssociationProps.dataDeletionPolicy


dataSourceName?

readonly optional dataSourceName: string

The name of the data source.

Default

- A new name will be generated.

Inherited from

SharePointDataSourceAssociationProps.dataSourceName


description?

readonly optional description: string

A description of the data source.

Default

- No description is provided.

Inherited from

SharePointDataSourceAssociationProps.description


domain

readonly domain: string

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

Example

"yourdomain"

Inherited from

SharePointDataSourceAssociationProps.domain


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.

Inherited from

SharePointDataSourceAssociationProps.filters


kmsKey?

readonly optional kmsKey: IKey

The KMS key to use to encrypt the data source.

Default

- Service owned and managed key.

Inherited from

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

SharePointDataSourceAssociationProps.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"]

Inherited from

SharePointDataSourceAssociationProps.siteUrls


tenantId

readonly tenantId: string

The identifier of your Microsoft 365 tenant.

Example

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

Inherited from

SharePointDataSourceAssociationProps.tenantId