Wren AI - 开源生成式 BI 助手

nderstandings. The LLM doesn't guess what your metrics mean; the semantic layer tells it.

🤖 特性

	你将获得	为什么重要
与数据对话	用任意语言提问 → 精确的 SQL 和答案	缩短 SQL 学习曲线
生成式 BI 洞察	AI 生成的摘要、图表和报告	一键获取决策所需的上下文
语义层	MDL 模型编码了模式、指标和连接	确保 LLM 输出准确且受治理
通过 API 嵌入	在你的应用内生成查询和图表 (API 文档)	构建自定义助手、SaaS 功能和聊天机器人 (Streamlit 实时演示)

🤩 了解更多关于生成式 BI 的信息

🔌 数据源

云数仓	数据库	查询引擎
BigQuery	PostgreSQL	Trino
Snowflake	MySQL	Athena (Trino)
Redshift	Microsoft SQL Server	DuckDB
Databricks	ClickHouse
Oracle

没有找到你需要的数据源？投票支持 — 社区投票将推动我们的连接器路线图。

🧠 LLM 模型

Wren AI 可以与你已经在使用的任何 LLM 提供商合作：

云 API	平台服务	自托管
OpenAI	Azure OpenAI	Ollama
Anthropic	Google AI Studio (Gemini)
DeepSeek	Vertex AI (Gemini + Anthropic)
Groq	AWS Bedrock
	Databricks

[!TIP] 为了获得最佳效果，建议使用前沿模型（GPT-4o、Claude Sonnet、Gemini Pro）。Wren AI 也适用于较小和本地模型——准确性会随着模型能力而变化。请参阅 配置示例 以获取设置指南。

🚀 入门指南

有三种方式可以开始使用 Wren AI，选择适合你的：

选项	最适合	链接
自托管（Docker）	完全控制，处理本地数据	安装指南
Wren AI 云服务	无需设置即可试用	getwren.ai

比较 OSS 与云服务计划。完整文档请访问 docs.getwren.ai。

🏗️ 架构

用户的问题从 Next.js UI 流向 Apollo GraphQL，再到 AI 服务（RAG + LLM），最后到达 Wren 引擎（语义查询执行），最终进入你的数据库。语义层（MDL）位于核心位置，确保 LLM 生成的 SQL 准确反映了你的真实业务定义。

👉 深入了解设计

🧑‍💻 针对开发者

WrenAI 是一个全栈 AI 系统，在每一层都面临着有趣的挑战——语义建模、RAG 检索、LLM 驱动的 SQL 生成，以及跨异构数据源的查询执行。以下是该系统底层的实际架构：

层次	功能描述
wren-ui	Next.js + Apollo GraphQL — 用于语义建模的 UI 和连接各组件的 BFF 层
wren-ai-service	Python/FastAPI 流水线 — 用于意图分类、从 Qdrant 中检索向量、LLM 提示工程以及 SQL 修正循环
wren-engine	Rust + Apache DataFusion — 查询执行核心，在 SQL 到达数据库之前解析 MDL 语义（指标、联接、访问控制）

wren-engine 是一个独立的开源项目，也是整个架构中最接近底层实现的部分。在这里，MDL 定义会被转换成适用于 15 种以上数据源的实际查询计划。如果你熟悉 Rust、DataFusion 或数据库连接器，这个项目非常值得一看——代码库易于理解，并且在查询计划、语义解析以及 MCP（模型上下文协议）代理集成等方面仍存在许多未解决的问题。

在两个仓库中，以下领域通常能带来最大影响：

• 数据源连接器 — wren-engine 支持 15 种以上的数据源；新增连接器总是很有帮助。
• MCP 集成 — wren-engine 提供了一个 MCP 服务器；基于代理的工作流目前仍处于早期阶段并不断发展。
• SQL 生成质量 — 在 wren-ai-service 中涉及提示工程、修正循环启发式方法以及评估框架。
• 语义层工具 — 在 wren-ui 中涉及 MDL 模式推断、验证以及开发者体验优化。

🛠️ 贡献

1. 阅读 贡献指南，了解设置和 PR 提交规范。
2. 如有 bug、功能请求或讨论，可先创建一个 issue。
3. 如果 Wren AI 对你有所帮助，给个项目点个 star 将会大有裨益——这有助于让更多人发现该项目。

⭐️ 社区

• 加入我们超过 1,700 名开发者的 Discord 社区，获取实时支持并抢先了解路线图。
• 访问 GitHub Issues 查看 bug 和功能请求。
• 浏览我们的 公开路线图，了解接下来的规划。
• 订阅我们的博客 · 关注我们在 LinkedIn 上的动态

我们遵循 行为准则，以确保社区对所有人保持友好和包容。

🎉 我们的贡献者

⬆️ 返回顶部

WrenAI 快速上手指南

WrenAI 是一款开源的 GenBI（生成式商业智能）代理，允许用户使用自然语言查询数据库。它通过语义层（Semantic Layer）确保 LLM 生成的 SQL 准确可靠，并自动生成图表和分析洞察。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Linux, macOS 或 Windows (WSL2 推荐)
• 核心依赖：
  • Docker 及 Docker Compose（用于本地自托管部署）
  • 或者直接使用 Wren AI Cloud 无需本地环境配置
• LLM API Key：准备一个支持的 LLM 提供商 API Key（如 OpenAI, Anthropic, Azure OpenAI, Google Gemini 等）。推荐使用 GPT-4o 或 Claude Sonnet 以获得最佳效果。
• 数据源访问权限：确保您可以访问目标数据库（如 PostgreSQL, MySQL, BigQuery, Snowflake 等）的连接凭证。

安装步骤

WrenAI 提供两种主要使用方式：云端版（免配置）和 自托管版（Docker）。以下是自托管版的安装流程：

1. 克隆仓库 打开终端，克隆 WrenAI 的 GitHub 仓库：

   git clone https://github.com/Canner/WrenAI.git
   cd WrenAI
   

2. 配置环境变量 复制示例配置文件并根据您的实际情况修改：

   cp .env.example .env
   

   编辑 .env 文件，填入您的 LLM API Key 和其他必要配置。例如，如果使用 OpenAI：

   LLM_PROVIDER=openai
   OPENAI_API_KEY=your_openai_api_key_here
   # 其他配置保持默认或根据需求调整
   

3. 启动服务 使用 Docker Compose 启动所有服务：

   docker compose up -d
   

   注意：首次启动可能需要几分钟时间来拉取镜像和初始化服务。

4. 验证安装 服务启动后，在浏览器中访问 http://localhost:3000 即可看到 WrenAI 的用户界面。

提示：如果您希望尝试无需本地部署的版本，可以直接注册 Wren AI Cloud。

基本使用

启动服务并访问 UI 后，按照以下步骤连接数据并开始查询：

1. 连接数据源

   • 在首页点击 "Connect Data Source"。
   • 选择您的数据库类型（支持 PostgreSQL, MySQL, BigQuery, Snowflake, Redshift, Databricks, ClickHouse, Oracle, MSSQL, DuckDB, Trino/Athena 等）。
   • 输入数据库连接信息（Host, Port, User, Password, Database Name 等）并测试连接。

2. 定义语义模型 (MDL)

   • 连接成功后，WrenAI 会自动加载表结构。
   • 进入 "Semantic Model" 页面，您可以定义业务指标、表之间的关联关系（Joins）以及字段的业务含义。这一步至关重要，它能确保 AI 理解“收入”、“活跃用户”等业务术语的具体定义。
   • 保存并部署模型。

3. 自然语言提问

   • 回到 "Ask Wren" 聊天界面。
   • 使用自然语言输入问题，例如：

     "Show me the total revenue by month for the last year." （显示去年的每月总收入。）

   • WrenAI 将生成对应的 SQL 语句、执行查询，并自动呈现数据表格和可视化图表。

4. 查看与导出

   • 您可以查看生成的 SQL 代码以进行验证。
   • 对结果满意后，可以将图表添加到仪表盘或直接导出洞察报告。

通过以上步骤，您即可利用 WrenAI 实现基于自然语言的数据库交互和商业智能分析。更多高级配置和 API 集成方法，请参考 官方文档。