README_CN.md
<a href="https://www.openviking.ai">官网</a> · <a href="https://openviking.ai/studio">在线体验</a> · <a href="https://github.com/volcengine/OpenViking">GitHub</a> · <a href="https://github.com/volcengine/OpenViking/issues">问题反馈</a> · <a href="https://docs.openviking.ai/">文档</a>
👋 加入我们的社区
📱 <a href="https://docs.openviking.ai/zh/about/01-about-us#飞书群">飞书群</a> · <a href="https://docs.openviking.ai/zh/about/01-about-us#微信群">微信群</a> · <a href="https://discord.com/invite/eHvx8E9XF3">Discord</a> · <a href="https://x.com/openvikingai">X</a>
<a href="https://trendshift.io/repositories/19668" target="_blank"></a>
</div>OpenViking 是面向 AI 智能体的开源上下文数据库。记忆、资源、技能统一存放在 viking:// 协议下的虚拟文件系统里,智能体用 ls、tree、find 浏览自己的上下文,不必去查一个黑盒向量库。内容写入时会处理成三层——L0 摘要、L1 概览、L2 详情——按需加载。每次检索都留下轨迹,可以查看,也可以调试。完整介绍见入门文档。
OpenViking Studio 实验场——在线 Demo,打开浏览器就能试,无需安装。
viking:// URI。智能体像开发者操作文件一样,确定地定位和操作上下文。→ Viking URI · 上下文类型各部分如何配合:见架构。设计思路:The Database Paradigm for Context Engineering(页内可切换中文)。
viking://
├── resources/ # 资源:项目文档、代码库、网页等
│ └── my_project/
│ ├── docs/
│ │ ├── api/
│ │ └── tutorials/
│ └── src/
└── user/
└── {user_id}/
├── memories/
│ └── preferences/
│ ├── writing_style
│ └── coding_habits
├── resources/
│ └── private_project/
├── skills/
│ ├── search_code
│ └── analyze_data
└── peers/
└── web-visitor-alice/
三个加载层级:
每个目录都带自己的 L0/L1 层,读完整文件之前就能判断相关性:
viking://resources/my_project/
├── .abstract # L0:约 100 tokens——快速判断相关性
├── .overview # L1:约 2k tokens——结构和要点
└── docs/
├── .abstract
├── .overview
└── api/
├── auth.md # L2:完整内容,按需加载
└── endpoints.md
OpenViking 0.3.22 的评测覆盖长对话用户记忆(LoCoMo)和多轮智能体任务(tau2-bench)。完整结果和实验设置(含知识库问答)见评测报告,复现脚本在 ./benchmark。
<picture> <source media="(prefers-color-scheme: dark)" srcset="docs/images/benchmark-dark.svg"> </picture>💡 想先看看实际效果? 试试 OpenViking Studio——官方托管的在线实例,带上下文实验场、语义检索和多智能体 Hub,无需安装。
需要 Python 3.10 或更高版本。
pip install openviking --upgrade
openviking-server init # 交互式向导:提供商、模型、ov.conf
openviking-server doctor # 校验配置
openviking-server # 启动
或者在后台运行:
nohup openviking-server > /data/log/openviking.log 2>&1 &
init 引导你完成提供商配置,并写入 ~/.openviking/ov.conf。它支持火山引擎、OpenAI、Codex OAuth、Kimi、GLM 和本地 Ollama——选 Ollama 时还能检测并安装运行时,按你的硬件拉取合适的模型。doctor 检查配置文件、Python 版本、提供商连通性和磁盘空间,不需要先启动服务器。
手写 ov.conf 的模板、各提供商示例、环境变量、Windows 配置和 CLI/客户端配置,见配置指南和快速入门文档。
服务器跑起来之后:
ov status
ov add-resource https://github.com/volcengine/OpenViking # --wait
ov ls viking://resources/
ov tree viking://resources/volcengine -L 2
# 没加 --wait 的话,语义处理需要等一段时间
ov find "what is openviking"
ov grep "openviking" --uri viking://resources/volcengine/OpenViking/docs/zh
重建已有索引:ov reindex <uri> --mode vectors_only 只刷新向量;--mode semantic_and_vectors 先重新生成语义产物(.abstract.md、.overview.md)再刷新向量;--mode prune_orphans 清理源文件已不存在的向量记录(加 --dry-run 可预览)。没有 semantic 或 full 这样的模式别名。
客户端配置可以用 ov config 交互式初始化;有多台服务器时,用 ov config switch 切换。
Rust CLI 通过 npm i -g @openviking/cli 安装,也可以从源码构建:cargo install --git https://github.com/volcengine/OpenViking ov_cli,见 CLI 安装。官方 Docker 镜像也已提供,见部署指南。
集成会把 OpenViking 的召回注入 Agent 上下文,并自动提交会话记忆:
各 Agent 的接入步骤:Agent 集成总览。
OpenViking Helper 是一个桌面控制台,目前处于 Beta 阶段,支持 macOS 和 Windows x64:
SKILL.md 技能,并同步到 OpenViking。下载:
VikingBot 是构建在 OpenViking 之上的 AI 智能体框架:
pip install "openviking[bot]"
openviking-server --with-bot
ov chat # 在另一个终端运行
官方 Docker 镜像内置 VikingBot,默认随服务器和控制台 UI 一起启动。详情见 VikingBot 指南。
生产环境建议把 OpenViking 作为独立 HTTP 服务运行——见服务器部署和部署指南。
开源版本不会被削弱。 本仓库的 OpenViking 以 AGPLv3 完整开源:不锁功能、不需要注册账号、不需要激活码,按上面的生产部署自行部署即可用于生产环境,并且会一直如此。
下面两个版本解决的是「谁来运维、部署在哪」,不是「能不能用」。
<table> <tr> <td width="50%" valign="top"> <h3>☁️ 商业化 SaaS 版</h3> <p>由<b>火山引擎</b>官方托管,开箱即用,不用自建也不用运维。</p> <ul> <li><b>个人版</b> — 面向个人开发者,最多 50 个文件免费试用,借助 VikingDB 获得远超本地硬件的扩展能力。</li> <li><b>企业版</b> — 面向团队的多用户上下文管理、协作与权限、企业级 SLA 与技术支持。</li> </ul> <p>开源版用户可以用迁移工具平滑迁入。</p> <p><a href="https://www.volcengine.com/product/openviking-service"><b>→ 火山引擎产品页</b></a> · <a href="https://docs.volcengine.com/docs/84313/2374478">使用文档</a></p> <p><sub>面向中国以外地区的全球托管服务将在 <a href="https://www.byteplus.com">BytePlus</a> 上线。</sub></p> </td> <td width="50%" valign="top"> <h3>🏢 私有化部署版</h3> <p>部署在<b>你自己的环境</b>里,数据不出域。</p> <ul> <li><b>在线部署</b> — 部署到你自己的云账号 / VPC,支持 BYOC,可连公网获取更新与授权。</li> <li><b>离线部署</b> — 完全内网、无外网连接的环境,适用于政企、金融、制造等强合规场景。</li> </ul> <p>在开源版基础上增加分布式部署能力与官方技术支持,通过激活码激活。</p> <p><a href="https://my.feishu.cn/share/base/form/shrcnMFqymCd9sq77sLk34Krxoc"><b>→ 提交私有化部署咨询</b></a></p> </td> </tr> </table>只想自己跑开源版?完全没问题,不需要联系任何人,直接看快速开始。
OpenViking 开源了 VikingMem 论文中描述的部分核心能力:
VikingMem: A Memory Base Management System for Stateful LLM-based Applications Jiajie Fu, Junwen Chen, Mengzhao Wang, Aoxiang He, Maojia Sheng, Xiangyu Ke, Yifan Zhu, and Yunjun Gao. arXiv:2605.29640, 2026。已被 VLDB 2026 接收。 📄 在 arXiv 阅读论文
OpenViking 欢迎与其他开源项目合作建设上下文数据生态。目前已确认的合作项目包括:
有兴趣加入我们的合作伙伴列表?请在社区提交 issue 来申请加入。
OpenViking 还在早期阶段,要做的事还很多。
本项目重视安全问题。 漏洞报告方式和受支持的版本,见 SECURITY.md
OpenViking 各组件采用不同的许可证: