DeepBI

视频示例

https://github.com/DeepInsight-AI/DeepBI/assets/151519374/d1effbe1-5c11-4c77-86ef-e01b1ea7f2f6

用户手册

DeepBI 用户手册

✨ 功能特性

1 会话式数据分析：用户可以通过对话获取任意数据结果和分析成果。
2 会话式查询生成：通过对话自动生成持久化查询和可视化图表。
3 仪表板：将持久化的可视化组件组装成仪表板。
4 自动化数据分析报告（待开发）：根据用户指令自动生成完整的数据分析报告。
5 支持多种数据源，包括 MySQL、PostgreSQL、Doris、StarRocks、CSV/Excel 等。
6 多平台支持，兼容 Windows-WSL、Windows、Linux、Mac。
7 国际化支持，提供中文、英文版本。

🚀 支持的数据库

DeepBI 支持的数据库连接包括：

• MySQL
• PostgreSQL
• CSV/Excel 导入
• Doris
• StarRocks
• MongoDB

📦 Windows exe 安装

• 请从 标签列表下载 window_install_exe_EN.zip。当前测试支持 Win10 和 Win11。
• 解压压缩包后，双击 .exe 文件即可运行 DeepBI。
• 本地安装说明 Installl exe

📦 Docker 构建

• 本地环境需安装 Docker 和 Docker Compose。
  

• Docker 安装指南

• 使用 git 克隆项目文件：git clone https://github.com/DeepInsight-AI/DeepBI.git
  或直接下载 zip 文件并解压。
  

• 进入项目目录：cd DeepBI

• 直接运行./Install.sh即可。

• 默认端口：8338 8339

• Web 访问地址：http://ip:8338

DeepBI Docker 命令

• 进入 DeepBI 项目目录：

    docker-compose start # 启动 DeepBI 服务
    docker-compose stop # 停止 DeepBI 服务
    docker-compose ps # 查看 DeepBI 服务状态

• 如果出现... PermissionError ... ' 或 ' Permission denied'，请在执行命令前加上 'sudo'：

    sudo docker-compose start # 启动 DeepBI 服务
    sudo docker-compose stop # 停止 DeepBI 服务
    sudo docker-compose ps # 查看 DeepBI 服务状态

Ubuntu 构建

在 Ubuntu 系统上直接安装，需要安装 Redis、PostgreSQL 以及 Python 3.8.17 环境。

• Redis 可以通过 127.0.0.1 的免密码命令行直接访问。

• 需要 Python 3.8.x 版本。

• 推荐使用 pyenv coda 等虚拟环境工具。

• PostgreSQL 需安装 postgresql-16 版本。

• 使用以下命令下载 DeepBI 代码：

git clone https://github.com/DeepInsight-AI/DeepBI.git

如果下载失败，请更换协议，运行以下代码：

git clone http://github.com/DeepInsight-AI/DeepBI.git

• 直接运行 . ubuntu_install.sh 即可（注意此处应运行 .ubuntu_install.sh 而不是 sh xxx，因为需要在 Python 虚拟环境中执行）。
• 默认端口为 8338 和 8339。
• Web 访问地址：http://ip:8338

联系我们

📑 其他

• 我们已在 Mac OS 12.7/13.X /14.1.1、Ubuntu 20.04/22.04 以及 Windows11 WSL 22.04 上进行了测试。
• Windows 10 需要 22H2 或更高版本才能安装 WSL。
• 服务器运行的最低内存要求为 1 核 2GB 内存，建议使用 2 核 4GB 内存。
• 如有任何问题，请联系 dev@deepbi.com。
• 问题反馈

DeepBI 快速上手指南

DeepBI 是一个 AI 原生的数据分析平台，利用大语言模型能力帮助用户通过对话探索、查询、可视化数据并生成分析报告。

1. 环境准备

系统要求

• 操作系统：
  • Windows 10 (22H2+) / Windows 11 (支持 WSL)
  • macOS 12.7 / 13.x / 14.1.1
  • Ubuntu 20.04 / 22.04
• 硬件配置：
  • 最低：1 核 CPU / 2GB 内存
  • 推荐：2 核 CPU / 4GB 内存

前置依赖

根据安装方式不同，需准备以下环境：

• Docker 方式（推荐）：需安装 docker 和 docker-compose。
• Ubuntu 原生方式：
  • Python 3.8.x (推荐使用 pyenv 或 conda 虚拟环境)
  • PostgreSQL 16
  • Redis (可通过 127.0.0.1 免密访问)
• Windows EXE 方式：无需额外依赖，直接运行安装包。

---

2. 安装步骤

请选择适合您环境的安装方式：

方式一：Docker 部署（通用推荐）

1. 克隆项目代码：

   git clone https://github.com/DeepInsight-AI/DeepBI.git
   

   若下载失败，可尝试替换协议：

   git clone http://github.com/DeepInsight-AI/DeepBI.git
   

2. 进入项目目录并执行安装脚本：

   cd DeepBI
   ./Install.sh
   

   若遇到 Permission denied 错误，请在命令前加 sudo。

3. 启动服务：

   docker-compose start
   

4. 访问地址：http://<你的 IP>:8338

方式二：Ubuntu 原生部署

1. 克隆项目代码：

   git clone https://github.com/DeepInsight-AI/DeepBI.git
   cd DeepBI
   

2. 执行安装脚本（注意必须使用 . 而非 sh 以激活虚拟环境）：

   . ubuntu_install.sh
   

3. 访问地址：http://<你的 IP>:8338

方式三：Windows EXE 安装

1. 前往 Releases 页面 下载 window_install_exe_EN.zip。
2. 解压压缩包。
3. 双击运行 .exe 文件即可启动。
4. 访问地址：http://localhost:8338

---

3. 基本使用

安装完成后，您可以通过浏览器访问 DeepBI 进行数据分析。

核心功能示例

1. 连接数据源： 在界面中添加数据源，支持 MySQL, PostgreSQL, Doris, StarRocks, MongoDB, CSV/Excel 等。

2. 对话式分析： 在查询框中直接使用自然语言提问，例如：

   "显示上个月销售额最高的前 10 个产品"

   DeepBI 将自动解析意图，生成 SQL 查询并返回结果。

3. 生成可视化与仪表盘： 继续通过对话要求生成图表：

   "将上述结果绘制成柱状图"

   系统会自动生成持久化的查询和可视化组件，您可以将其组装到 Dashboard 中进行分享。

服务管理命令 (Docker 模式)

如需停止或查看服务状态，可在项目目录下执行：

docker-compose stop   # 停止服务
docker-compose ps     # 查看服务状态