Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
statefb committed Aug 30, 2024
1 parent f4d7ee8 commit 70d9312
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/migration/V1_TO_V2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

The v2 update introduces a significant change by replacing pgvector on Aurora Serverless and ECS-based embedding with [Amazon Bedrock Knowledge Bases](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html). This change is not backward compatible. If you want to continue using pgvector, avoid upgrading to v2. If you plan to transition, start by updating to v1.3.0 and enabling the Knowledge Bases option in cdk.json. This will make your existing bots read-only, allowing a gradual shift to the new system. Future updates will focus exclusively on v2, with v1 being deprecated.
The v2 update introduces a significant change by replacing pgvector on Aurora Serverless and ECS-based embedding with [Amazon Bedrock Knowledge Bases](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html). This change is not backward compatible. If you want to continue using pgvector, avoid upgrading to v2. If you plan to transition, start by updating to v1.3.0 and enabling the Knowledge Bases option in cdk.json. This will make your existing bots read-only, allowing a gradual shift to the new system. Note that **upgrading to v2 will result in the deletion of all Aurora-related resources.** Future updates will focus exclusively on v2, with v1 being deprecated.

## Key Changes and Migration Steps

Expand All @@ -13,8 +13,9 @@ Replacement of pgvector and ECS Embedding: The previous system using pgvector on
### Migration Process

- Update to v1.3.0: Ensure you are using version 1.3.0 or later.
- Enable Knowledge Bases: Set `useBedrockKnowledgeBasesForRag` to `true` in [cdk.json](../../cdk/cdk.json).
- Read-Only Mode: Once enabled, your existing pgvector-based bots become read-only, preventing further edits but allowing continued use. Recommend to re-create another bot on Knowledge Bases.
- Enable Knowledge Bases: Set `useBedrockKnowledgeBasesForRag` to `true` in [cdk.json](../../cdk/cdk.json). **Be aware that enabling Knowledge Bases will incur charges for both Aurora and Knowledge Bases.**
- Read-Only Mode: Once enabled, your existing pgvector-based bots become read-only, preventing further edits but allowing continued use.
- Re-create Bots: Open the bot creation screen and re-create your bots with the same definitions as those using pgvector, but now utilizing Knowledge Bases. **Note that some feature is not available on KnowledgeBases e.g. web crawling and youtube transcript.**

![](../imgs/v1_to_v2_readonly_bot.png)

Expand Down

0 comments on commit 70d9312

Please sign in to comment.