OpenAI Assistants API 的开源替代方案

🎮 演示 · 🌐 官网 · 📚 文档 · 💬 Slack · 🖥 React 组件

Superflows 让为软件产品添加 AI 助手变得轻而易举。这使用户能够以自然语言提问，助手则会调用软件的 API 来回答这些问题。

例如，CRM 用户可以这样问：

我们是否与出版公司达成了任何交易？如果有，涉及哪些人员？

或者：

Eve 今天生病了。请将她的电话转接给团队中的其他成员——优先安排那些之前与潜在客户有过接触的人。

用户也可以向他们的分析助手提问：

我们上个月投放的 Google Ads 广告活动是否带来了正向的投资回报率？它产生了多少次转化？

Superflows 将通过调用 API 来回答这些问题或完成任务，并编写代码来分析和绘制数据图表。

请在此处查看 Superflows 在 CRM 中的演示 这里。

您可以在 这里 免费试用云版本，也可以选择自托管。更多详情请参阅 文档页面。

https://github.com/Superflows-AI/superflows/assets/33871096/b1b355d2-a851-4b11-aabb-3fd3ff375f5d

功能特性

• 调用 API 端点以完成任务并回答用户问题
• 编写代码来分析数据并生成图表 📊
• 使用 RAG（检索增强生成）技术回答基于静态知识的问题 📚
• 开发者仪表板，用于配置和测试您的 AI 助手 🎛️
• 带状态的流式 API 🏞️
• UI 组件（React 组件 在这里）🖥️
• 支持上传 API 规范以快速完成设置 💨
• 在执行可能造成损害的操作前请求用户确认 ✅
• 在仪表板中跟踪使用情况 📊
• 多模型支持（微调过的 GPT-3.5、GPT-4、Mixtral、Llama2 等）🌍
• 收集用户对 AI 回答的反馈以便进行微调 👍
• 支持自托管，包括完全开源的模型。如有兴趣，请联系 这里 🏠

设置流程

在 Superflows Cloud 中设置 AI 助手非常简单：

1. 上传您的 API 规范
2. 在 Playground 中进行测试
3. 仅需一行代码即可集成到您的产品中

仪表板

Superflows 提供开发者仪表板，您可以在其中配置、评估和调试 AI 助手，然后再将其投入生产环境。

您可以在 'Playground' 中与助手互动。'开发者模式' 可让您查看助手内部的思考和规划过程。'模拟 API 响应' 则允许您在不连接实际 API 的情况下检查助手的行为。

'Actions' 页面让您可以通过一个简单的仪表板控制助手可以调用哪些 API 端点来回答用户的查询。

这些端点可以轻松通过 OpenAPI 规范上传，也可以手动输入。

UI 组件

Superflows 自带开箱即用的 React UI 组件。这些组件让您可以仅用一行代码就将 Superflows 集成到您的产品中（集成指南）。

API

API 规范可在 文档 中找到。

支持 / 与创始人交流

• 预约演示 👋
• Slack 社区 💭
• 我们的联系电话 📞 +44 (755) 7101-159 / +44 (780) 580-6766
• 我们的邮箱 ✉️ henry@superflows.ai / matthew@superflows.ai

自托管

我们目前尚未编写 Superflows 的自托管指南。如果您有兴趣进行自托管，请通过 Slack 或 电子邮件 联系我们。

路线图

可在此处查看。

本地搭建

• 本地设置

要在此项目中进行本地开发，您需要运行一个本地的 Supabase 实例。

以下是关于使用 Supabase CLI 的完整指南

（注意：如果您之前在其他项目中使用过 Supabase，可能需要先执行 supabase stop，再运行 supabase start）

如果使用 npm

npm i
npm install supabase --save-dev
npx supabase start

第二条命令会为您提供一个 anon_api_key 和一个 service_role 密钥。

您需要将这些密钥填入 .env 文件中。请参考 .env.example 文件，了解所需的格式和变量。

填写完 .env.example 后，请将其重命名为 .env。

以开发模式运行：

make run

（或者，如果您没有 make，可以使用 npm run dev）

• Docker 设置

克隆项目后，请找到 docker/development 目录下的 init.sh 文件。

先决条件

• 确保您的系统已安装 Git。如果未安装，脚本会提示您。
• 根据您操作系统的相关安装指南，安装 Docker 和 Docker Compose。

使用方法

如果您在 Windows 上运行，建议使用 Git Bash 或 WSL；您可能需要管理员权限。

使脚本可执行 首次使用脚本前，请确保其具有可执行权限，然后运行：

chmod +x init.sh
./init.sh

此脚本旨在简化 Superflows 开发环境的搭建与管理流程，特别是与 Supabase 集成的部分，并帮助您完成项目的基础环境配置。它会确保 Supabase 仓库已被克隆或更新，同时检查并处理 .env 文件，必要时合并现有的 .env.example 文件。

默认情况下，脚本会运行 Docker Compose 来启动容器并构建镜像（如需）。

检查内容并设置自定义环境变量

脚本应已创建 supabase 文件夹以及 .env 文件。

• 请检查并根据您的环境调整 .env 中的变量——该文件通常已包含合理的默认值（但您仍需确认）：

  • 【可选】设置您的 OpenAI API 密钥 [OPENAI_API_KEY]（如需自托管我们微调后的 LLM，请联系 Henry：henry@superflows.ai）
  • 【可选】配置 SMTP 凭证以启用邮件功能。

• 运行 Compose 文件（取决于您安装的 Compose 版本）：

docker compose up -d build 

或

docker-compose up -d build

Superflows 快速上手指南

Superflows 是一个开源的 AI 助手框架，可作为 OpenAI Assistants API 的替代方案。它允许用户通过自然语言提问，AI 会自动调用软件 API 来回答问题、执行任务、分析数据并生成图表。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Linux, macOS 或 Windows (Windows 用户建议使用 Git Bash 或 WSL)。
• Node.js & npm: 用于运行前端和后端逻辑。
• Docker & Docker Compose: 用于容器化部署（推荐方式）。
• Git: 用于克隆代码仓库。
• Supabase CLI: 本地开发依赖（若使用 npm 方式安装会自动处理）。
• API Key: 需要准备 OpenAI API Key (OPENAI_API_KEY)，或者联系官方获取自托管的开源模型支持。

安装步骤

您可以选择使用 Docker（推荐，一键启动）或 npm 方式进行本地设置。

方式一：Docker 安装（推荐）

1. 克隆项目

   git clone <repository-url>
   cd superflows
   

2. 运行初始化脚本 进入 docker/development 目录，赋予脚本执行权限并运行：

   chmod +x init.sh
   ./init.sh
   

   该脚本会自动检查 Git 和 Docker 环境，克隆/更新 Supabase 仓库，并生成基础的 .env 配置文件。

3. 配置环境变量 脚本运行后，检查生成的 .env 文件：

   • 填入您的 OPENAI_API_KEY。
   • （可选）配置 SMTP 信息以启用邮件功能。

4. 启动服务 根据您安装的 Docker Compose 版本运行以下命令之一：

   docker compose up -d build
   # 或者
   docker-compose up -d build
   

方式二：npm 本地开发安装

1. 安装依赖

   npm i
   npm install supabase --save-dev
   

2. 启动本地 Supabase

   npx supabase start
   

   启动成功后，终端会输出 anon_api_key 和 service_role key。

3. 配置环境变量

   • 复制示例文件：cp .env.example .env
   • 编辑 .env 文件，填入上一步获取的 Supabase keys 以及您的 OPENAI_API_KEY。

4. 启动开发服务器

   make run
   # 如果没有安装 make，请使用：
   npm run dev
   

基本使用

安装完成后，您可以通过以下三个步骤快速构建并集成 AI 助手：

1. 上传 API 规范

登录 Superflows 开发者仪表盘（本地部署请访问本地地址，云端版访问 dashboard.superflows.ai）：

• 进入 Actions 页面。
• 上传您的 OpenAPI Specification (Swagger JSON/YAML) 文件，或手动添加 API 端点。
• 系统将自动识别可用的 API 操作，供 AI 调用。

2. 在 Playground 中测试

• 进入 Playground 界面。

• 开启 Developer mode 可查看 AI 的思考过程和计划步骤。

• 开启 Mock API responses 可在不连接真实后端的情况下测试 AI 逻辑。

• 测试示例：

  "上个月我们运行的 Google Ads 活动 ROI 是否为正？产生了多少转化？"

  AI 将自动规划：调用广告 API 获取数据 -> 编写代码分析数据 -> 生成结论或图表。

3. 集成到产品中

Superflows 提供了开箱即用的 React UI 组件，只需一行代码即可嵌入您的产品：

// 引入组件（具体路径参考官方文档 integration-guide/react）
import { SuperflowsChat } from '@superflows/chat-ui';

// 在您的 React 组件中使用
<SuperflowsChat apiUrl="YOUR_SUPERFLOWS_API_URL" />

现在，您的用户可以直接在应用中通过自然语言与数据进行交互了。