Skip to content

Latest commit

 

History

History
197 lines (111 loc) · 4.03 KB

ConfluenceDataSourceAssociationProps.md

File metadata and controls

197 lines (111 loc) · 4.03 KB
Raw

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

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

Interface: ConfluenceDataSourceAssociationProps

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 Confluence instance URL. Secret must start with "AmazonBedrock-".

authType?

readonly optional authType: ConfluenceDataSourceAuthType

The supported authentication method to connect to the data source.

Default

ConfluenceDataSourceAuthType.OAUTH2_CLIENT_CREDENTIALS

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

confluenceUrl

readonly confluenceUrl: string

The Confluence host URL or instance URL.

Example

https://example.atlassian.net

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

filters?

readonly optional filters: ConfluenceCrawlingFilters[]

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