Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -151,5 +151,14 @@ cython_debug/
openviking/bin/
test_scripts/
test_large_scale_collection/

# Test-generated directories
.tmp_*/
db_test_*/
test_recall_collection/
test_db_*/
test_project_root/
benchmark_stress_db/
examples/data/
third_party/agfs/bin/
openviking/_version.py
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ OpenViking requires the following model capabilities:

OpenViking supports various model services:
- **OpenAI Models**: Supports GPT-4V and other VLM models, and OpenAI Embedding models.
- **Volcengine (Doubao Models)**: Recommended for low cost and high performance, with free quotas for new users. For purchase and activation, please refer to: [Volcengine Purchase Guide](./docs/en/configuration/volcengine-purchase-guide.md).
- **Volcengine (Doubao Models)**: Recommended for low cost and high performance, with free quotas for new users. For purchase and activation, please refer to: [Volcengine Purchase Guide](./docs/en/guides/volcengine-purchase-guide.md).
- **Other Custom Model Services**: Supports model services compatible with the OpenAI API format.

### 3. Environment Configuration
Expand Down Expand Up @@ -280,7 +280,7 @@ After running the first example, let's dive into the design philosophy of OpenVi

We no longer view context as flat text slices but unify them into an abstract virtual filesystem. Whether it's memories, resources, or capabilities, they are mapped to virtual directories under the `viking://` protocol, each with a unique URI.

This paradigm gives Agents unprecedented context manipulation capabilities, enabling them to locate, browse, and manipulate information precisely and deterministically through standard commands like `ls` and `find`, just like a developer. This transforms context management from vague semantic matching into intuitive, traceable "file operations". Learn more: [Viking URI](./docs/en/concepts/03-viking-uri.md) | [Context Types](./docs/en/concepts/02-context-types.md)
This paradigm gives Agents unprecedented context manipulation capabilities, enabling them to locate, browse, and manipulate information precisely and deterministically through standard commands like `ls` and `find`, just like a developer. This transforms context management from vague semantic matching into intuitive, traceable "file operations". Learn more: [Viking URI](./docs/en/concepts/viking-uri.md) | [Context Types](./docs/en/concepts/context-types.md)

```
viking://
Expand Down Expand Up @@ -313,7 +313,7 @@ Stuffing massive amounts of context into a prompt all at once is not only expens
- **L1 (Overview)**: Contains core information and usage scenarios for Agent decision-making during the planning phase.
- **L2 (Details)**: The full original data, for deep reading by the Agent when absolutely necessary.

Learn more: [Context Layers](./docs/en/concepts/04-context-layers.md)
Learn more: [Context Layers](./docs/en/concepts/context-layers.md)

```
viking://resources/my_project/
Expand Down Expand Up @@ -342,13 +342,13 @@ Single vector retrieval struggles with complex query intents. OpenViking has des
4. **Recursive Drill-down**: If subdirectories exist, recursively repeat the secondary retrieval steps layer by layer.
5. **Result Aggregation**: Finally, obtain the most relevant context to return.

This "lock high-score directory first, then refine content exploration" strategy not only finds the semantically best-matching fragments but also understands the full context where the information resides, thereby improving the globality and accuracy of retrieval. Learn more: [Retrieval Mechanism](./docs/en/concepts/06-retrieval.md)
This "lock high-score directory first, then refine content exploration" strategy not only finds the semantically best-matching fragments but also understands the full context where the information resides, thereby improving the globality and accuracy of retrieval. Learn more: [Retrieval Mechanism](./docs/en/concepts/retrieval.md)

### 4. Visualized Retrieval Trajectory → Observable Context

OpenViking's organization uses a hierarchical virtual filesystem structure. All context is integrated in a unified format, and each entry corresponds to a unique URI (like a `viking://` path), breaking the traditional flat black-box management mode with a clear hierarchy that is easy to understand.

The retrieval process adopts a directory recursive strategy. The trajectory of directory browsing and file positioning for each retrieval is fully preserved, allowing users to clearly observe the root cause of problems and guide the optimization of retrieval logic. Learn more: [Retrieval Mechanism](./docs/en/concepts/06-retrieval.md)
The retrieval process adopts a directory recursive strategy. The trajectory of directory browsing and file positioning for each retrieval is fully preserved, allowing users to clearly observe the root cause of problems and guide the optimization of retrieval logic. Learn more: [Retrieval Mechanism](./docs/en/concepts/retrieval.md)

### 5. Automatic Session Management → Context Self-Iteration

Expand All @@ -357,7 +357,7 @@ OpenViking has a built-in memory self-iteration loop. At the end of each session
- **User Memory Update**: Update memories related to user preferences, making Agent responses better fit user needs.
- **Agent Experience Accumulation**: Extract core content such as operational tips and tool usage experience from task execution experience, aiding efficient decision-making in subsequent tasks.

This allows the Agent to get "smarter with use" through interactions with the world, achieving self-evolution. Learn more: [Session Management](./docs/en/concepts/08-session.md)
This allows the Agent to get "smarter with use" through interactions with the world, achieving self-evolution. Learn more: [Session Management](./docs/en/concepts/session.md)

---

Expand Down
12 changes: 6 additions & 6 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ OpenViking 需要以下模型能力:

OpenViking 支持多种模型服务:
- **OpenAI 模型**:支持 GPT-4V 等 VLM 模型和 OpenAI Embedding 模型
- **火山引擎(豆包模型)**:推荐使用,成本低、性能好,新用户有免费额度。如需购买和开通,请参考:[火山引擎购买指南](./docs/zh/configuration/volcengine-purchase-guide.md)
- **火山引擎(豆包模型)**:推荐使用,成本低、性能好,新用户有免费额度。如需购买和开通,请参考:[火山引擎购买指南](./docs/zh/guides/volcengine-purchase-guide.md)
- **其他自定义模型服务**:支持兼容 OpenAI API 格式的模型服务

### 3. 配置环境
Expand Down Expand Up @@ -279,7 +279,7 @@ Search results:

我们不再将上下文视为扁平的文本切片,而是将其统一抽象并组织于一个虚拟文件系统中。无论是记忆、资源还是能力,都会被映射到 `viking://` 协议下的虚拟目录,拥有唯一的 URI。

这种范式赋予了 Agent 前所未有的上下文操控能力,使其能像开发者一样,通过 `ls`、`find` 等标准指令来精确、确定性地定位、浏览和操作信息,让上下文的管理从模糊的语义匹配演变为直观、可追溯的"文件操作"。了解更多:[Viking URI](./docs/zh/concepts/03-viking-uri.md) | [上下文类型](./docs/zh/concepts/02-context-types.md)
这种范式赋予了 Agent 前所未有的上下文操控能力,使其能像开发者一样,通过 `ls`、`find` 等标准指令来精确、确定性地定位、浏览和操作信息,让上下文的管理从模糊的语义匹配演变为直观、可追溯的"文件操作"。了解更多:[Viking URI](./docs/zh/concepts/viking-uri.md) | [上下文类型](./docs/zh/concepts/context-types.md)

```
viking://
Expand Down Expand Up @@ -312,7 +312,7 @@ viking://
- **L1 (概述)**:包含核心信息和使用场景,供 Agent 在规划阶段进行决策
- **L2 (详情)**:完整的原始数据,供 Agent 在确有必要时深入读取

了解更多:[上下文分层](./docs/zh/concepts/04-context-layers.md)
了解更多:[上下文分层](./docs/zh/concepts/context-layers.md)

```
viking://resources/my_project/
Expand Down Expand Up @@ -341,13 +341,13 @@ viking://resources/my_project/
4. **递归下探**:若目录下仍存在子目录,则逐层递归重复上述二次检索步骤
5. **结果汇总**:最终拿到最相关上下文返回

这种"先锁定高分目录、再精细探索内容"的策略,不仅能找到语义最匹配的片段,更能理解信息所在的完整语境,从而提升检索的全局性与准确性。了解更多:[检索机制](./docs/zh/concepts/06-retrieval.md)
这种"先锁定高分目录、再精细探索内容"的策略,不仅能找到语义最匹配的片段,更能理解信息所在的完整语境,从而提升检索的全局性与准确性。了解更多:[检索机制](./docs/zh/concepts/retrieval.md)

### 4. 可视化检索轨迹 → 上下文可观测

OpenViking 的组织方式采用层次化虚拟文件系统结构,所有上下文均以统一格式整合且每个条目对应唯一 URI(如 `viking://` 路径),打破传统扁平黑箱式管理模式,层次分明易于理解。

检索过程采用目录递归策略,每次检索的目录浏览、文件定位轨迹均被完整留存,能够清晰观测问题根源并指导检索逻辑优化。了解更多:[检索机制](./docs/zh/concepts/06-retrieval.md)
检索过程采用目录递归策略,每次检索的目录浏览、文件定位轨迹均被完整留存,能够清晰观测问题根源并指导检索逻辑优化。了解更多:[检索机制](./docs/zh/concepts/retrieval.md)

### 5. 会话自动管理 → 上下文自迭代

Expand All @@ -356,7 +356,7 @@ OpenViking 内置了记忆自迭代闭环。在每次会话结束时,开发者
- **用户记忆更新**:更新用户偏好相关记忆,使 Agent 回应更贴合用户需求
- **Agent 经验积累**:从任务执行经验中提取操作技巧、工具使用经验等核心内容,助力后续任务高效决策

让 Agent 在与世界的交互中"越用越聪明",实现自我进化。了解更多:[会话管理](./docs/zh/concepts/08-session.md)
让 Agent 在与世界的交互中"越用越聪明",实现自我进化。了解更多:[会话管理](./docs/zh/concepts/session.md)

---

Expand Down
Loading
Loading