From cee335486aff60763ef213a41fc734be0725f08a Mon Sep 17 00:00:00 2001 From: Aiden Dai Date: Wed, 3 Apr 2024 19:55:16 +0800 Subject: [PATCH] Update README --- README.md | 12 +++++++++--- README_CN.md | 14 +++++++++----- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ce9ee07..4a8a176 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,9 @@ The following diagram illustrates the reference architecture. Note that it also ![Architecture](assets/arch.svg) -> Note: You can use Lambda Web Adapter + Function URL (see [example](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examples/fastapi-response-streaming) to replace ALB or AWS Fargate to replace Lambda to get better performance on streaming response. +You can also choose to use [AWS Fargate](https://aws.amazon.com/fargate/) behind the ALB instead of [AWS Lambda](https://aws.amazon.com/lambda/), the main difference is the latency of the first byte for streaming response (Fargate is lower). + +Alternatively, you can use Lambda Function URL to replace ALB, see [example](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examples/fastapi-response-streaming) ### Deployment @@ -81,9 +83,13 @@ Please follow the steps below to deploy the Bedrock Proxy APIs into your AWS acc **Step 2: Deploy the CloudFormation stack** 1. Sign in to AWS Management Console, switch to the region to deploy the CloudFormation Stack to. -2. Click the following button to launch the CloudFormation Stack in that region. +2. Click the following button to launch the CloudFormation Stack in that region. Choose one of the following: + - **ALB + Lambda** - [![Launch Stack](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=BedrockProxyAPI&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/bedrock-proxy-api/latest/BedrockProxy.template) + [![Launch Stack](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=BedrockProxyAPI&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/bedrock-access-gateway/latest/BedrockProxy.template) + - **ALB + Fargate** + + [![Launch Stack](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=BedrockProxyAPI&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/bedrock-access-gateway/latest/BedrockProxyFargate.template) 3. Click "Next". 4. On the "Specify stack details" page, provide the following information: - Stack name: Change the stack name if needed. diff --git a/README_CN.md b/README_CN.md index e1b06e7..ffb3038 100644 --- a/README_CN.md +++ b/README_CN.md @@ -58,9 +58,9 @@ OpenAI 的 API 或 SDK 无缝集成并试用 Amazon Bedrock 的模型,而无需 ![Architecture](assets/arch.svg) -> 注意: 你可以使用 Lambda Web Adapter + Function URL ( -> 参见[示例](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examples/fastapi-response-streaming))来代替 -> ALB,或者使用 AWS Fargate 来代替 Lambda,以获得更好的流响应性能。 +您也可以选择在 ALB 后面接 [AWS Fargate](https://aws.amazon.com/fargate/) 而不是 [AWS Lambda](https://aws.amazon.com/lambda/)，主要区别在于流响应的首字节延迟（Fargate更低）。 + +或者,您可以使用 Lambda Function URL 来代替 ALB,请参阅[示例](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examples/fastapi-response-streaming) ### 部署 @@ -86,9 +86,13 @@ OpenAI 的 API 或 SDK 无缝集成并试用 Amazon Bedrock 的模型,而无需 **第二步: 部署CloudFormation堆栈** 1. 登录AWS管理控制台,切换到要部署CloudFormation堆栈的区域。 -2. 单击以下按钮在该区域启动CloudFormation堆栈。 +2. 单击以下按钮在该区域启动CloudFormation堆栈，选择一种方式部署。 + - **ALB + Lambda** - [![Launch Stack](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=BedrockProxyAPI&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/bedrock-proxy-api/latest/BedrockProxy.template) + [![Launch Stack](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=BedrockProxyAPI&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/bedrock-access-gateway/latest/BedrockProxy.template) + - **ALB + Fargate** + + [![Launch Stack](assets/launch-stack.png)](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=BedrockProxyAPI&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/bedrock-access-gateway/latest/BedrockProxyFargate.template) 3. 单击"下一步"。 4. 在"指定堆栈详细信息"页面,提供以下信息: - 堆栈名称: 可以根据需要更改名称。