Skip to content

Latest commit

 

History

History
199 lines (111 loc) · 4.51 KB

SalesforceDataSourceProps.md

File metadata and controls

199 lines (111 loc) · 4.51 KB
Raw

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

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

Interface: SalesforceDataSourceProps

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

Inherited from

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

SalesforceDataSourceAssociationProps.chunkingStrategy

customTransformation?

readonly optional customTransformation: CustomTransformation

The custom transformation strategy to use.

Default

- No custom transformation is used.

Inherited from

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

SalesforceDataSourceAssociationProps.dataDeletionPolicy

dataSourceName?

readonly optional dataSourceName: string

The name of the data source.

Default

- A new name will be generated.

Inherited from

SalesforceDataSourceAssociationProps.dataSourceName

description?

readonly optional description: string

A description of the data source.

Default

- No description is provided.

Inherited from

SalesforceDataSourceAssociationProps.description

endpoint

readonly endpoint: string

The Salesforce host URL or instance URL.

Example

"https://company.salesforce.com/"

Inherited from

SalesforceDataSourceAssociationProps.endpoint

filters?

readonly optional filters: SalesforceCrawlingFilters[]

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

SalesforceDataSourceAssociationProps.filters

kmsKey?

readonly optional kmsKey: IKey

The KMS key to use to encrypt the data source.

Default

- Service owned and managed key.

Inherited from

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

SalesforceDataSourceAssociationProps.parsingStrategy