README.zh-CN.md

English | 简体中文

Onyx — 开源 AI 平台

Onyx 是面向 LLM 的应用层，提供功能丰富的界面，任何人都可以轻松自托管。 Onyx 通过 RAG、Web 搜索、代码执行、文件生成、深度研究等高级能力增强 LLM。

通过 50+ 内置的索引型 connector 或 MCP，将你的应用接入 Onyx。

Tip

一键部署：

curl -fsSL https://onyx.app/install_onyx.sh | bash

---

⭐ 功能特性

• 🔍 Agentic RAG： 基于混合索引 + AI Agent 的信息检索，提供一流的搜索与问答质量
  • Benchmark 即将发布！
• 🔬 Deep Research： 通过多步骤研究流程生成深度报告
  • 截至 2026 年 2 月，位列 leaderboard 榜首。
• 🤖 自定义 Agent： 构建拥有专属指令、知识与 Action 的 AI Agent。
• 🌍 Web 搜索： 浏览网页以获取最新信息。
  • 支持 Serper、Google PSE、Brave、SearXNG 等。
  • 内置 web 爬虫，并支持 Firecrawl / Exa。
• 📄 Artifacts： 生成文档、图表及其他可下载产物。
• ▶️ Actions 与 MCP： 让 Onyx Agent 与外部应用交互，支持灵活的 Auth 配置。
• 💻 代码执行： 在沙箱中执行代码，用于数据分析、绘图或修改文件。
• 🎙️ 语音模式： 通过 TTS / STT 与 Onyx 对话。
• 🎨 图像生成： 根据用户 prompt 生成图像。

Onyx 支持所有主流 LLM 提供商，包括自托管方案 (Ollama、LiteLLM、vLLM 等) 和闭源服务 (Anthropic、OpenAI、Gemini 等)。

更多内容详见我们的文档！

---

🚀 部署方式

Onyx 支持 Docker、Kubernetes、Helm / Terraform 部署，并为主流云厂商提供部署指南。 详细部署指南见这里。

Onyx 提供两种部署模式：Standard 与 Lite。

Onyx Lite

Lite 模式可以理解为一个轻量级的 Chat UI。资源占用更低 (内存低于 1GB)，技术栈也更简单。 适合想快速试用 Onyx 的用户，或只关心 Chat UI 与 Agent 功能的团队。

Standard Onyx

Onyx 的完整功能集，推荐正式使用的用户与较大规模团队选用。相比 Lite 模式额外包含：

• 用于 RAG 的向量 + 关键词索引。
• 后台容器，运行任务队列与 Worker，用于从 connector 同步知识。
• AI 模型推理服务，运行索引与推理过程中所需的深度学习模型。
• 面向大规模使用的性能优化，包括内存缓存 (Redis) 与对象存储 (MinIO)。

Tip

想免部署免费试用 Onyx？访问 Onyx Cloud。

---

🏢 面向企业的 Onyx

Onyx 适合各种规模的团队，从个人用户到全球最大的企业：

• 👥 协作：与组织中的其他成员共享对话与 Agent。
• 🔐 单点登录：通过 Google OAuth、OIDC 或 SAML 实现 SSO；通过 SCIM 进行用户组同步与用户配置。
• 🛡️ 基于角色的访问控制：对 Agent、Action 等敏感资源进行 RBAC 管理。
• 📊 分析：按团队、LLM 或 Agent 维度查看使用情况图表。
• 🕵️ 查询历史：审计使用情况，确保 AI 在组织内安全落地。
• 💻 自定义代码：运行自定义代码以脱敏 PII、拦截敏感查询或执行自定义分析。
• 🎨 白标：自定义名称、图标、横幅等，打造专属外观。

📚 许可证

Onyx 提供两个版本：

• Onyx Community Edition (CE) 基于 MIT 许可证免费开放，涵盖 Chat、RAG、Agent 与 Action 的全部核心功能。
• Onyx Enterprise Edition (EE) 提供面向大型组织的额外功能。

功能详情请见官网。

👪 社区

欢迎加入我们的开源社区 Discord！

💡 贡献

想要参与贡献？详情请见 Contribution Guide。