@cdklabs/generative-ai-cdk-constructs
@cdklabs/generative-ai-cdk-constructs / bedrock / IVectorKnowledgeBase
Represents a Knowledge Base, either created with CDK or imported.
readonlyoptionaldescription:string
The description of the knowledge base.
readonlyenv:ResourceEnvironment
The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
readonlyoptionalinstruction:string
A narrative instruction of the knowledge base. A Bedrock Agent can use this instruction to determine if it should query this Knowledge Base.
readonlyknowledgeBaseArn:string
The ARN of the knowledge base.
"arn:aws:bedrock:us-east-1:123456789012:knowledge-base/KB12345678"
IKnowledgeBase.knowledgeBaseArn
readonlyknowledgeBaseId:string
The ID of the knowledge base.
"KB12345678"
IKnowledgeBase.knowledgeBaseId
readonlynode:Node
The tree node.
readonlyrole:IRole
The role associated with the knowledge base.
readonlystack:Stack
The stack in which this resource is defined.
readonlytype:KnowledgeBaseType
The type of knowledge base.
addConfluenceDataSource(
props):ConfluenceDataSource
Add a Confluence data source to the knowledge base.
ConfluenceDataSourceAssociationProps
addS3DataSource(
props):S3DataSource
Add an S3 data source to the knowledge base.
addSalesforceDataSource(
props):SalesforceDataSource
Add a Salesforce data source to the knowledge base.
SalesforceDataSourceAssociationProps
addSharePointDataSource(
props):SharePointDataSource
Add a SharePoint data source to the knowledge base.
SharePointDataSourceAssociationProps
addWebCrawlerDataSource(
props):WebCrawlerDataSource
Add a web crawler data source to the knowledge base.
WebCrawlerDataSourceAssociationProps
applyRemovalPolicy(
policy):void
Apply the given removal policy to this resource
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN).
RemovalPolicy
void
IKnowledgeBase.applyRemovalPolicy
grant(
grantee, …actions):Grant
Grant the given principal identity permissions to perform actions on this knowledge base.
IGrantable
…string[]
Grant
grantQuery(
grantee):Grant
Grant the given identity permissions to query the knowledge base.
IGrantable
Grant
grantRetrieve(
grantee):Grant
Grant the given identity permissions to retrieve content from the knowledge base.
IGrantable
Grant
grantRetrieveAndGenerate(
grantee):Grant
Grant the given identity permissions to retrieve content from the knowledge base.
IGrantable
Grant