AWS Samples Bedrock Claude Chat 项目使用教程

AWS Samples Bedrock Claude Chat 项目使用教程

bedrock-claude-chat AWS-native chatbot using Bedrock + Claude 项目地址: https://gitcode.com/gh_mirrors/be/bedrock-claude-chat

1. 项目的目录结构及介绍

AWS Samples Bedrock Claude Chat 项目是一个基于 Amazon Bedrock 的多语言聊天机器人开源项目。以下是项目的目录结构及各部分的简要介绍：

• backend/: 包含项目的后端代码，使用 FastAPI 框架构建。
• cdk/: AWS Cloud Development Kit (CDK) 文件夹，包含用于部署项目的 CloudFormation 模板。
• docs/: 项目文档文件夹，可以包含额外的文档文件。
• examples/: 包含示例配置和代码片段。
• frontend/: 包含项目的前端代码，使用 React 和 Tailwind CSS 构建用户界面。
• scripts/: 包含项目部署和运维的脚本文件。
• .github/: 包含 GitHub 工作流程和代码所有者文件。
• bin.sh: 用于启动和部署项目的脚本文件。
• deploy.yml: 部署配置文件，用于定义部署流程。
• lefthook.yml: LeftHook 配置文件，用于定义 Git 钩子脚本。
• pyrightconfig.json: Python 类型检查配置文件。
• CODE_OF_CONDUCT.md: 项目的行为准则文件。
• CONTRIBUTING.md: 贡献指南，说明如何为项目做贡献。
• LICENSE: 项目使用的 MIT-0 许可证文件。
• README.md: 项目说明文件，介绍项目的基本信息和如何使用。

2. 项目的启动文件介绍

项目的启动文件是 bin.sh 脚本文件。此脚本用于自动化部署过程。以下是 bin.sh 文件的基本使用方法：

chmod +x bin.sh  # 赋予脚本执行权限
./bin.sh         # 执行脚本

执行脚本时，用户会被询问是否为新用户或继续使用 v2 版本。如果是新用户，需要输入 y。

3. 项目的配置文件介绍

项目的配置主要通过 AWS Cloud Development Kit (CDK) 来管理。CDK 使用 JSON 或 YAML 格式的 cdk.json 文件来定义部署上下文和参数。

在 cdk.json 文件中，可以定义以下配置：

• selfSignUpEnabled: 是否允许用户自助注册。
• enableLambdaSnapStart: 是否启用 Lambda SnapStart 来提高冷启动性能。
• allowedIpV4AddressRanges: 允许的 IPv4 地址范围，用于限制访问。
• allowedIpV6AddressRanges: 允许的 IPv6 地址范围，用于限制访问。
• allowedSignUpEmailDomains: 允许注册的电子邮件域名列表，用于限制用户注册。
• bedrockRegion: Bedrock 可用的区域。
• enableRagReplicas: 是否启用 Retrieval-Augmented Generation (RAG) 的副本。
• enableBedrockCrossRegionInference: 是否启用跨区域推理。

可以通过命令行参数 --cdk-json-override 来覆盖 cdk.json 文件中的配置。例如：

./bin.sh --cdk-json-override '{
  "context": {
    "selfSignUpEnabled": false,
    "enableLambdaSnapStart": true
  }
}'

以上是 AWS Samples Bedrock Claude Chat 项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对使用此项目有所帮助。

bedrock-claude-chat AWS-native chatbot using Bedrock + Claude 项目地址: https://gitcode.com/gh_mirrors/be/bedrock-claude-chat