Coze Studio 是字节跳动开源的 AI 智能体开发平台,基于 Apache 2.0 许可,允许免费商用。它提供可视化工具,支持无代码或低代码方式快速构建、调试和部署 AI 智能体与应用。后端采用 Golang 开发,前端基于 React 和 TypeScript,遵循领域驱动设计(DDD)与微服务架构,确保高性能和扩展性。用户可通过拖拽节点创建复杂工作流,集成插件、知识库和数据库,快速实现业务逻辑。平台支持 API 和多语言 SDK,便于与本地系统集成。Coze Studio 降低 AI 开发门槛,鼓励社区贡献,适合开发者、企业构建定制化 AI 应用。
功能列表
- 可视化工作流编排:通过拖拽节点快速构建复杂工作流,支持业务逻辑设计和数据流处理。
- 插件管理:创建、配置和管理插件,支持封装第三方 API 或私有功能。
- 知识库管理:上传文档或数据,智能体基于知识库生成精准回答。
- 数据库支持:集成数据库资源,支持数据存储与查询,增强智能体功能。
- 模型服务管理:支持集成 OpenAI、火山引擎等模型服务,灵活选择大模型。
- API 与 SDK 集成:提供聊天和工作流相关 API,支持 Python、JavaScript、Java 等 SDK,方便二次开发。
- 智能体与应用构建:快速创建、发布和管理 AI 智能体或应用,支持多平台部署。
- 实时交互:通过 WebSocket 支持实时聊天、语音合成和转录。
- 开源社区支持:基于 Apache 2.0 许可,鼓励社区贡献代码与反馈。
使用帮助
安装与部署
Coze Studio 是开源项目,需从 GitHub 仓库克隆代码并本地部署。以下是详细步骤:
- 环境准备:
- 硬件要求:最低 2 核 CPU、4GB 内存。
- 软件依赖:
- Docker 和 Docker Compose:确保已安装并启动 Docker 服务。
- Golang:后端开发需 1.18 或以上版本,配置好环境变量。
- Node.js:前端开发建议使用 LTS 版本。
- pnpm:全局安装 pnpm(推荐版本 9.12.0):
npm i -g pnpm@9.12.0
- 克隆仓库:
运行以下命令获取源代码:git clone https://github.com/coze-dev/coze-studio.git cd coze-studio
- 配置模型服务:
- 复制模型配置文件模板(如火山引擎 doubao-seed-1.6):
cp backend/conf/model/template/model_template_ark_doubao-seed-1.6.yaml backend/conf/model/ark_doubao-seed-1.6.yaml
- 编辑
backend/conf/model/ark_doubao-seed-1.6.yaml
,配置以下字段:id
:自定义模型 ID,需为非零整数,全局唯一,部署后不可修改。meta.conn_config.api_key
:模型服务 API 密钥,例如火山引擎 Ark API Key(获取方式见https://www.volcengine.com/docs/82379/1541594
)。meta.conn_config.model
:模型服务 Endpoint ID,例如 doubao-seed-1.6 的 Endpoint ID(获取方式见https://www.volcengine.com/docs/82379/1099522
)。
- 复制模型配置文件模板(如火山引擎 doubao-seed-1.6):
- 安装依赖:
安装前端依赖:pnpm install
后端依赖通过 Golang 自动管理,运行
go build
时自动下载。 - 构建与运行:
- 构建项目:
pnpm build go build
- 部署服务:
cd docker cp .env.example .env docker compose --profile '*' up -d
首次部署需拉取镜像,可能耗时较长。成功启动后,日志显示
Container coze-server Started
,即可通过http://localhost:3000
访问。
- 构建项目:
- 配置环境变量:
创建.env
文件,添加 API 密钥和基础 URL:COZE_API_TOKEN=your_api_token COZE_API_BASE=https://api.coze.com
访问
https://www.coze.com/open/oauth/pats
获取COZE_API_TOKEN
。
使用核心功能
1. 创建 AI 智能体
- 进入工作空间:登录 Coze Studio,访问
https://www.coze.com/space/<workspace_id>/develop
,记录workspace_id
。 - 新建智能体:在界面点击“新建智能体”,选择模型(如 doubao-seed-1.6)。通过拖拽添加功能节点,如对话、知识库或插件。
- 配置知识库:上传文档(如 PDF 或 TXT)到知识库,智能体可基于文档回答问题。例如,上传产品手册后,智能体可解答相关咨询。
- 发布智能体:配置完成后,点击“发布”,选择目标平台(如 Discord)。输入
COZE_BOT_TOKEN
完成部署,获取方式见https://www.coze.com/docs
。
2. 工作流编排
- 打开编辑器:在 Coze Studio 选择“工作流”,进入可视化画布。
- 构建工作流:从节点库拖拽节点(如“输入”“API 调用”“输出”),通过连线定义逻辑。例如,连接“用户输入”到“查询数据库”再到“生成回答”。
- 调试与优化:点击“调试”,输入测试数据,查看节点执行状态,优化逻辑流程。
- 发布工作流:调试完成后,点击“发布”,可将工作流绑定到智能体或应用。
3. 插件开发与集成
- 创建插件:在“插件”模块,添加第三方 API(如天气查询)。输入 API URL 和参数,保存后即可在工作流中使用。
- 调用插件:在工作流中添加插件节点,配置参数。例如,天气插件可返回实时天气数据。
- 本地开发:使用 SDK 开发插件。Python 示例:
from cozepy import Coze, TokenAuth coze = Coze(auth=TokenAuth(os.getenv("COZE_API_TOKEN"))) bot = coze.bots.create(space_id="your_workspace_id", name="TestBot") print(f"Created bot: {bot.name}")
4. 实时交互
- WebSocket 支持:实现实时聊天或语音交互。Java 示例:
WebsocketChatClient client = coze.websocket().chat().create(new WebsocketChatCreateReq(botID, new CallbackHandler())); client.inputAudioBufferAppend("base64_audio_data");
- 响应处理:通过回调函数处理实时文本或音频输出。
5. 数据库与资源管理
- 数据库配置:在“资源”模块,添加数据库连接(如 MySQL)。配置后,工作流可直接查询数据。
- 资源管理:支持管理插件、知识库、变量等资源,统一在可视化界面操作。
问题排查
- 查看日志:运行以下命令检查容器状态和日志:
docker ps docker logs <container_id>
- 常见问题:若服务未启动,检查
.env
文件配置是否正确,或确认 Docker 网络连接正常。
社区贡献
- 参考
CONTRIBUTING.md
提交代码。安全问题通过https://security.bytedance.com/src
或邮箱sec@bytedance.com
报告,勿在 GitHub 公开。
应用场景
- 在线客服
构建智能客服,集成知识库回答常见问题,复杂问题转人工,提升效率。 - 数据自动化处理
使用工作流处理表单数据,调用 API 生成报告。例如,自动整理客户反馈并生成分析。 - 教育助手
创建智能体,基于教材知识库解答学生问题,支持个性化学习建议。 - 智能家居控制
开发智能体通过 API 控制 IoT 设备,如语音指令“打开空调”触发设备操作。
QA
- Coze Studio 开源版与商业版区别?
开源版支持核心开发功能,免费商用,但不包含语气定制等高级功能。商业版需订阅,详情见https://www.coze.com/docs/guides/subscription
。 - 如何获取 API 密钥?
访问https://www.coze.com/open/oauth/pats
,生成个人访问令牌,保存至.env
文件。 - 支持哪些模型?
支持 OpenAI、火山引擎等模型,需手动配置模型服务,详见https://github.com/coze-dev/coze-studio/wiki/3.-Model-configuration
。 - 是否适合无编程经验用户?
无代码用户可通过可视化界面创建智能体,编程用户可使用 SDK 定制功能。 - 如何加入社区?
使用飞书扫描官方二维码(见README.md
)加入 Coze Studio 技术交流群。