@cdklabs/generative-ai-cdk-constructs

---

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

Interface: GraphKnowledgeBaseAttributes

Properties for importing a knowledge base outside of this stack

Extends

• CommonKnowledgeBaseAttributes

Properties

description?

readonly optional description?: string

The description of the knowledge base.

Default

- No description provided.

Inherited from

CommonKnowledgeBaseAttributes.description

---

executionRoleArn

readonly executionRoleArn: string

The Service Execution Role associated with the knowledge base.

Example

"arn:aws:iam::123456789012:role/AmazonBedrockExecutionRoleForKnowledgeBaseawscdkbdgeBaseKB12345678"

Inherited from

CommonKnowledgeBaseAttributes.executionRoleArn

---

fieldMapping

readonly fieldMapping: VectorFieldMapping

The vector field mapping configuration.

Default

- { metadataField: "AMAZON_BEDROCK_METADATA", textField: "AMAZON_BEDROCK_TEXT" }

---

graphId

readonly graphId: string

The ID of the Neptune Analytics vector store

---

instruction?

readonly optional instruction?: string

Instructions for agents based on the design and type of information of the Knowledge Base. This will impact how Agents interact with the Knowledge Base.

Default

- No description provided.

Inherited from

CommonKnowledgeBaseAttributes.instruction

---

knowledgeBaseId

readonly knowledgeBaseId: string

The ID of the knowledge base.

Example

"KB12345678"

Inherited from

CommonKnowledgeBaseAttributes.knowledgeBaseId

---

knowledgeBaseState?

readonly optional knowledgeBaseState?: string

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

Default

- ENABLED

Inherited from

CommonKnowledgeBaseAttributes.knowledgeBaseState