Botpress 是一个开源平台，用于构建和部署由 GPT/LLM 驱动的下一代聊天机器人与助手。其目标是为项目或业务提供快速构建助手的途径。
用途
Botpress 面向聊天机器人与助手的构建和部署，尤其强调由 OpenAI 驱动。它提供 Cloud 服务以及文档、集成和插件等资源，帮助用户为项目或业务快速创建助手。
主要能力
该仓库主要包含以下内容：
- Integrations：Botpress 维护的 Botpress Hub 上所有公开集成。
- Devtools：所有 Botpress Cloud 开发工具，包括 CLI、SDK、API 客户端。
- Bots：仅使用 SDK 和 CLI 以“代码即机器人”方式编写的一些示例机器人。
- Plugins：Botpress Studio 上的所有插件（即将推出）。
使用方式
集成开发
要在集成方面开发，首先安装 Botpress CLI。然后在任意目录中创建新集成，该命令会基于提供的模板之一生成集成。此步骤可在任意目录和任意 git 仓库中执行，无需 fork 此仓库。随后可以分别修改集成定义和实现，它们位于 integration.definition.ts 和 src/index.ts 文件中。
集成部署
要试用集成，可以使用 Botpress CLI 将其当前版本部署到工作区。这会将集成的当前版本部署到工作区，并使其对所有机器人可用。如果该版本已部署，则会更新；否则将创建新版本。默认情况下，所有集成仅对部署它们的工作区私有。当准备与社区分享版本时，可以运行相应命令将其公开，从而让所有 Botpress 用户都能在 Botpress Hub 上使用。一旦集成的某个版本公开，就不能再次更新。
机器人示例
/bots 文件夹包含仅使用客户端、SDK 和 CLI 以“代码即机器人”方式制作的机器人示例。这不是构建机器人的推荐方式，也绝不能替代 Botpress Studio。不过，对于希望以更程序化方式构建机器人的经验丰富的开发者来说，它可能有用。Botpress 团队也在内部使用它，因为 Studio 和 SDK 都使用相同的底层原语。
本地开发
开发环境要求安装以下工具：
- git：Git 是一个免费开源的分布式版本控制系统。
- node：Node.js® 是一个基于 Chrome V8 JavaScript 引擎的 JavaScript 运行时。
- pnpm：PNPM 是一个快速、节省磁盘空间的包管理器。
- Microsoft Visual C++ Redistributable for Visual Studio 2015-2022。
适用场景与限制
该仓库适合社区贡献者、集成开发者以及希望以程序化方式构建机器人的经验丰富的开发者。构建机器人时，更推荐使用 Botpress Studio；本仓库的“代码即机器人”方式并非其替代品。
本仓库中所有包均为开源软件，采用 MIT 许可证。通过在本仓库贡献，即表示同意在此许可证下发布代码。
对于 Botpress Cloud 的 bug 或功能，可以在此仓库创建 issue，但在 Discord 上沟通会得到更快回复。对于本地部署版 Botpress v12 的任何问题，需要查看 Botpress v12 仓库。
