CfnKnowledgeBaseProps Struct
Properties for defining a CfnKnowledgeBase.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wisdom as wisdom } from 'aws-cdk-lib';
const cfnKnowledgeBaseProps: wisdom.CfnKnowledgeBaseProps = {
knowledgeBaseType: 'knowledgeBaseType',
name: 'name',
// the properties below are optional
description: 'description',
renderingConfiguration: {
templateUri: 'templateUri',
},
serverSideEncryptionConfiguration: {
kmsKeyId: 'kmsKeyId',
},
sourceConfiguration: {
appIntegrations: {
appIntegrationArn: 'appIntegrationArn',
// the properties below are optional
objectFields: ['objectFields'],
},
managedSourceConfiguration: {
webCrawlerConfiguration: {
urlConfiguration: {
seedUrls: [{
url: 'url',
}],
},
// the properties below are optional
crawlerLimits: {
rateLimit: 123,
},
exclusionFilters: ['exclusionFilters'],
inclusionFilters: ['inclusionFilters'],
scope: 'scope',
},
},
},
tags: [{
key: 'key',
value: 'value',
}],
vectorIngestionConfiguration: {
chunkingConfiguration: {
chunkingStrategy: 'chunkingStrategy',
// the properties below are optional
fixedSizeChunkingConfiguration: {
maxTokens: 123,
overlapPercentage: 123,
},
hierarchicalChunkingConfiguration: {
levelConfigurations: [{
maxTokens: 123,
}],
overlapTokens: 123,
},
semanticChunkingConfiguration: {
breakpointPercentileThreshold: 123,
bufferSize: 123,
maxTokens: 123,
},
},
parsingConfiguration: {
parsingStrategy: 'parsingStrategy',
// the properties below are optional
bedrockFoundationModelConfiguration: {
modelArn: 'modelArn',
// the properties below are optional
parsingPrompt: {
parsingPromptText: 'parsingPromptText',
},
},
},
},
};
Properties
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description.
knowledgeBaseTypestringknowledge_base_typestrknowledgeBaseTypeStringKnowledgeBaseTypestringKnowledgeBaseType*stringrequired#The type of knowledge base.
Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
The name of the knowledge base.
renderingConfigurationoptionalIResolvable | CfnKnowledgeBase.RenderingConfigurationPropertyrendering_configurationoptionaltyping.Union[IResolvable, RenderingConfigurationProperty]renderingConfigurationoptionalIResolvableRenderingConfigurationoptionalIResolvableRenderingConfigurationoptionalinterface{}#Information about how to render the content.
serverSideEncryptionConfigurationoptionalIResolvable | CfnKnowledgeBase.ServerSideEncryptionConfigurationPropertyserver_side_encryption_configurationoptionaltyping.Union[IResolvable, ServerSideEncryptionConfigurationProperty]serverSideEncryptionConfigurationoptionalIResolvableServerSideEncryptionConfigurationoptionalIResolvableServerSideEncryptionConfigurationoptionalinterface{}#This customer managed key must have a policy that allows `kms:CreateGrant` and `kms:DescribeKey` permissions to the IAM identity using the key to invoke Wisdom.
notes
For more information about setting up a customer managed key for Wisdom, see Enable Connect Customer Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
sourceConfigurationoptionalIResolvable | CfnKnowledgeBase.SourceConfigurationPropertysource_configurationoptionaltyping.Union[IResolvable, SourceConfigurationProperty]sourceConfigurationoptionalIResolvableSourceConfigurationoptionalIResolvableSourceConfigurationoptionalinterface{}#The source of the knowledge base content.
Only set this argument for EXTERNAL or Managed knowledge bases.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#The tags used to organize, track, or control access for this resource.
vectorIngestionConfigurationoptionalIResolvable | CfnKnowledgeBase.VectorIngestionConfigurationPropertyvector_ingestion_configurationoptionaltyping.Union[IResolvable, VectorIngestionConfigurationProperty]vectorIngestionConfigurationoptionalIResolvableVectorIngestionConfigurationoptionalIResolvableVectorIngestionConfigurationoptionalinterface{}#Contains details about how to ingest the documents in a data source.