综合介绍
Onyx(原名Danswer)是一个开源的AI聊天平台,由onyx-dot-app团队开发,旨在帮助企业整合和管理文档、应用及员工数据。它提供丰富的聊天功能,支持连接任意大语言模型(LLM),并通过40多个连接器(如Google Drive、Slack、Confluence等)同步知识和访问权限。用户可创建定制AI代理,设置独特提示和知识集。Onyx支持灵活部署,可运行在笔记本电脑、本地服务器或云端,社区版免费使用MIT许可证,企业版则提供如单点登录(SSO)等高级功能,适合需要高效知识管理和AI支持的团队。
功能列表
- 智能AI聊天:通过自然语言与企业文档和数据互动。
- 跨平台搜索:检索团队在多个应用中的知识内容。
- 40+数据连接器:对接Google Drive、Slack、Salesforce等工具。
- 自定义AI代理:设置专属提示、知识和操作的AI助手。
- 多模态处理:支持文本、图像等多种数据类型。
- 任意LLM集成:连接外部或自托管大语言模型。
- 应用内访问:在Slack、Teams等工具中直接使用Onyx。
- 安全管理:提供SSO、角色权限和加密功能。
- 知识管理工具:支持文档集、查询历史和使用分析。
- 可扩展部署:通过Docker或Kubernetes实现高可用性。
使用帮助
安装流程
Onyx支持多种部署方式,以下以本地Docker部署为例,详细说明操作步骤:
前置条件
- 安装Docker(建议20.10+版本)和Docker Compose。
- 硬件要求:最低4GB内存、2核CPU,推荐8GB内存。
- 网络连接,用于下载镜像和依赖。
安装步骤
- 获取代码
打开终端,克隆Onyx仓库:
git clone https://github.com/onyx-dot-app/onyx.git
进入Docker目录:
cd onyx/deployment/docker_compose
- 配置环境
- 默认配置无需修改即可运行。
- 若需自定义(如更换LLM或端口),编辑
docker-compose.dev.yml
,或创建.env
文件添加密钥,例如:OPENAI_API_KEY=your-openai-key
- 启动服务
执行以下命令拉取镜像并运行:
docker compose -f docker-compose.dev.yml -p onyx-stack up -d --pull always --force-recreate
- 首次运行需5-15分钟,视网络和硬件而定。
- 检查容器状态:
docker ps
确保
api_server
、web_server
等容器正常运行。
- 访问平台
- 浏览器输入
http://localhost:3000
,进入Onyx界面。 - 初次使用需输入LLM API密钥(如OpenAI密钥),可在设置中完成。
- 故障排查
- 若无法访问,查看日志:
docker logs onyx-stack_api_server_1
- 若提示内存不足,调整Docker内存分配(Docker Desktop > Settings > Resources)。
其他部署选项
- Onyx Cloud:访问cloud.onyx.app/signup注册,免安装即可使用。
- Kubernetes:参考
deployment/helm
目录,适合大规模部署。
主要功能操作
1. 智能AI聊天
- 进入界面:登录后点击左侧“Chat”。
- 选择数据源:在左侧面板勾选目标文档或应用。
- 提问:输入问题,如“最近的项目计划在哪里?”。
- 调整设置:点击齿轮图标,选择LLM或调整参数。
- 保存记录:点击“Save”存储对话。
2. 跨平台搜索
- 访问搜索:点击顶部“Search”。
- 输入关键词:如“2024销售数据”。
- 过滤结果:按来源(如Google Drive)或时间筛选。
- 智能回答:启用“AI Answer”获取总结性回复。
3. 数据连接器设置
- 添加连接:进入“Admin” > “Connectors”。
- 选择应用:点击目标工具(如Slack),按提示授权。
- 同步数据:设置同步间隔(如每小时),保存配置。
- 验证:在“Search”中测试新数据是否可检索。
4. 自定义AI代理
- 创建代理:在“Admin” > “AI Assistants”点击“New”。
- 配置提示:输入指令,如“以HR专家回答问题”。
- 绑定数据:选择相关文档或连接器。
- 测试使用:在“Chat”中切换到新代理,输入问题验证。
5. 应用内访问
- Slack集成:在Slack中添加Onyx Bot,按提示授权。
- 使用方法:输入
@Onyx 查找昨天的会议记录
,获取回复。 - Teams支持:类似流程,需企业版权限。
操作流程示例
场景:查找团队最新文档并提问。
- 登录Onyx,进入“Search”。
- 输入“最新文档”,筛选来源为“Confluence”。
- 查看结果,选中目标文档。
- 切换到“Chat”,提问“文档里提到的新功能是什么?”。
- 获取AI回答,点击“Share”生成链接分享。
高级功能
- 安全设置:企业版支持SSO(如OAuth2),在“Admin” > “Security”配置。
- 使用分析:在“Analytics”查看查询频率和热门问题。
- 大规模部署:Kubernetes支持百万级文档处理,参考官方文档。
Onyx的开源性和灵活部署使其易于上手,详细的文档和日志支持也能快速解决问题。