Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

对齐 docs 和代码里 storage config 的 workspace 属性 (#289)

yepper155866ce522f
diff --git a/docs/en/faq/faq.md b/docs/en/faq/faq.md
index 2f15f3f2e..2c81a7235 100644
--- a/docs/en/faq/faq.md
+++ b/docs/en/faq/faq.md
@@ -94,8 +94,9 @@ Create an `~/.openviking/ov.conf` configuration file in your project directory:
"model": "doubao-rerank-250615"
},
"storage": {
- "agfs": { "backend": "local", "path": "./data" },
- "vectordb": { "backend": "local", "path": "./data" }
+ "workspace": "./data",
+ "agfs": { "backend": "local" },
+ "vectordb": { "backend": "local" }
}
}
```
diff --git a/docs/en/guides/01-configuration.md b/docs/en/guides/01-configuration.md
index 578aa85a1..2275b70f0 100644
--- a/docs/en/guides/01-configuration.md
+++ b/docs/en/guides/01-configuration.md
@@ -27,10 +27,9 @@ Create `~/.openviking/ov.conf` in your project directory:
"model": "doubao-rerank-250615"
},
"storage": {
- "agfs": {
- "backend": "local",
- "path": "./data"
- }
+ "workspace": "./data",
+ "agfs": { "backend": "local" },
+ "vectordb": { "backend": "local" }
}
}
```
@@ -99,6 +98,7 @@ Embedding model configuration for vector search, supporting dense, sparse, and h
```json
{
"embedding": {
+ "max_concurrent": 10,
"dense": {
"provider": "volcengine",
"api_key": "your-api-key",
@@ -114,6 +114,7 @@ Embedding model configuration for vector search, supporting dense, sparse, and h
| Parameter | Type | Description |
|-----------|------|-------------|
+| `max_concurrent` | int | Maximum concurrent embedding requests (`embedding.max_concurrent`, default: `10`) |
| `provider` | str | `"volcengine"`, `"openai"`, `"vikingdb"`, or `"jina"` |
| `api_key` | str | API key |
| `model` | str | Model name |
@@ -252,7 +253,7 @@ Vision Language Model for semantic extraction (L0/L1 generation).
"vlm": {
"api_key": "your-api-key",
"model": "doubao-seed-1-8-251228",
- "base_url": "https://ark.cn-beijing.volces.com/api/v3"
+ "api_base": "https://ark.cn-beijing.volces.com/api/v3"
}
}
```
@@ -263,7 +264,9 @@ Vision Language Model for semantic extraction (L0/L1 generation).
|-----------|------|-------------|
| `api_key` | str | API key |
| `model` | str | Model name |
-| `base_url` | str | API endpoint (optional) |
+| `api_base` | str | API endpoint (optional) |
+| `thinking` | bool | Enable thinking mode for VolcEngine models (default: `false`) |
+| `max_concurrent` | int | Maximum concurrent semantic LLM calls (default: `100`) |
**Available Models**
@@ -308,14 +311,13 @@ Storage backend configuration.
```json
{
"storage": {
+ "workspace": "./data",
"agfs": {
"backend": "local",
- "path": "./data",
- "timeout": 30.0
+ "timeout": 10
},
"vectordb": {
- "backend": "local",
- "path": "./data"
+ "backend": "local"
}
}
}
@@ -400,6 +402,7 @@ For startup and deployment details see [Deployment](./03-deployment.md), for aut
```json
{
"embedding": {
+ "max_concurrent": 10,
"dense": {
"provider": "volcengine",
"api_key": "string",
@@ -412,7 +415,9 @@ For startup and deployment details see [Deployment](./03-deployment.md), for aut
"provider": "string",
"api_key": "string",
"model": "string",
- "base_url": "string"
+ "api_base": "string",
+ "thinking": false,
+ "max_concurrent": 100
},
"rerank": {
"provider": "volcengine",
@@ -420,15 +425,14 @@ For startup and deployment details see [Deployment](./03-deployment.md), for aut
"model": "string"
},
"storage": {
+ "workspace": "string",
"agfs": {
- "backend": "local|remote",
- "path": "string",
+ "backend": "local|s3|memory",
"url": "string",
- "timeout": 30.0
+ "timeout": 10
},
"vectordb": {
"backend": "local|remote",
- "path": "string",
"url": "string",
"project": "string"
}
diff --git a/docs/en/guides/03-deployment.md b/docs/en/guides/03-deployment.md
index 10ffe7083..c9c9c1d35 100644
--- a/docs/en/guides/03-deployment.md
+++ b/docs/en/guides/03-deployment.md
@@ -52,8 +52,9 @@ The `server` section in `ov.conf` controls server behavior:
"cors_origins": ["*"]
},
"storage": {
- "agfs": { "backend": "local", "path": "/data/openviking" },
- "vectordb": { "backend": "local", "path": "/data/openviking" }
+ "workspace": "./data",
+ "agfs": { "backend": "local" },
+ "vectordb": { "backend": "local" }
}
}
```
@@ -67,8 +68,9 @@ Server manages local AGFS and VectorDB. Configure the storage path in `ov.conf`:
```json
{
"storage": {
- "agfs": { "backend": "local", "path": "/data/openviking" },
- "vectordb": { "backend": "local", "path": "/data/openviking" }
+ "workspace": "./data",
+ "agfs": { "backend": "local" },
+ "vectordb": { "backend": "local" }
}
}
```
diff --git a/docs/zh/faq/faq.md b/docs/zh/faq/faq.md
index 05d240e25..822f7e124 100644
--- a/docs/zh/faq/faq.md
+++ b/docs/zh/faq/faq.md
@@ -94,8 +94,9 @@ pip install openviking
"model": "doubao-rerank-250615"
},
"storage": {
- "agfs": { "backend": "local", "path": "./data" },
- "vectordb": { "backend": "local", "path": "./data" }
+ "workspace": "./data",
+ "agfs": { "backend": "local" },
+ "vectordb": { "backend": "local" }
}
}
```
diff --git a/docs/zh/guides/01-configuration.md b/docs/zh/guides/01-configuration.md
index 2283df0dc..983b269ae 100644
--- a/docs/zh/guides/01-configuration.md
+++ b/docs/zh/guides/01-configuration.md
@@ -9,15 +9,14 @@ OpenViking 使用 JSON 配置文件(`ov.conf`)进行设置。配置文件支
```json
{
"storage": {
+ "workspace": "./data",
"vectordb": {
"name": "context",
- "backend": "local",
- "path": "./data"
+ "backend": "local"
},
"agfs": {
"port": 1833,
"log_level": "warn",
- "path": "./data",
"backend": "local"
}
},
@@ -104,6 +103,7 @@ OpenViking 使用 JSON 配置文件(`ov.conf`)进行设置。配置文件支
```json
{
"embedding": {
+ "max_concurrent": 10,
"dense": {
"provider": "volcengine",
"api_key": "your-api-key",
@@ -120,6 +120,7 @@ OpenViking 使用 JSON 配置文件(`ov.conf`)进行设置。配置文件支
| 参数 | 类型 | 说明 |
|------|------|------|
+| `max_concurrent` | int | 最大并发 Embedding 请求数(`embedding.max_concurrent`,默认:`10`) |
| `provider` | str | `"volcengine"`、`"openai"`、`"vikingdb"` 或 `"jina"` |
| `api_key` | str | API Key |
| `model` | str | 模型名称 |
@@ -259,7 +260,7 @@ OpenViking 使用 JSON 配置文件(`ov.conf`)进行设置。配置文件支
"provider": "volcengine",
"api_key": "your-api-key",
"model": "doubao-seed-1-8-251228",
- "base_url": "https://ark.cn-beijing.volces.com/api/v3"
+ "api_base": "https://ark.cn-beijing.volces.com/api/v3"
}
}
```
@@ -270,7 +271,9 @@ OpenViking 使用 JSON 配置文件(`ov.conf`)进行设置。配置文件支
|------|------|------|
| `api_key` | str | API Key |
| `model` | str | 模型名称 |
-| `base_url` | str | API 端点(可选) |
+| `api_base` | str | API 端点(可选) |
+| `thinking` | bool | 启用思考模式(仅对部分火山模型生效,默认:`false`) |
+| `max_concurrent` | int | 语义处理阶段 LLM 最大并发调用数(默认:`100`) |
**可用模型**
@@ -315,14 +318,13 @@ OpenViking 使用 JSON 配置文件(`ov.conf`)进行设置。配置文件支
```json
{
"storage": {
+ "workspace": "./data",
"agfs": {
"backend": "local",
- "path": "./data",
- "timeout": 30.0
+ "timeout": 10
},
"vectordb": {
- "backend": "local",
- "path": "./data"
+ "backend": "local"
}
}
}
@@ -407,6 +409,7 @@ HTTP 客户端(`SyncHTTPClient` / `AsyncHTTPClient`)和 CLI 工具连接远
```json
{
"embedding": {
+ "max_concurrent": 10,
"dense": {
"provider": "volcengine",
"api_key": "string",
@@ -419,7 +422,9 @@ HTTP 客户端(`SyncHTTPClient` / `AsyncHTTPClient`)和 CLI 工具连接远
"provider": "string",
"api_key": "string",
"model": "string",
- "base_url": "string"
+ "api_base": "string",
+ "thinking": false,
+ "max_concurrent": 100
},
"rerank": {
"provider": "volcengine",
@@ -427,15 +432,14 @@ HTTP 客户端(`SyncHTTPClient` / `AsyncHTTPClient`)和 CLI 工具连接远
"model": "string"
},
"storage": {
+ "workspace": "string",
"agfs": {
- "backend": "local|remote",
- "path": "string",
+ "backend": "local|s3|memory",
"url": "string",
- "timeout": 30.0
+ "timeout": 10
},
"vectordb": {
"backend": "local|remote",
- "path": "string",
"url": "string",
"project": "string"
}
diff --git a/docs/zh/guides/03-deployment.md b/docs/zh/guides/03-deployment.md
index ba6ba38ea..eca1d98e0 100644
--- a/docs/zh/guides/03-deployment.md
+++ b/docs/zh/guides/03-deployment.md
@@ -52,8 +52,9 @@ python -m openviking serve --config /path/to/ov.conf --host 127.0.0.1 --port 800
"cors_origins": ["*"]
},
"storage": {
- "agfs": { "backend": "local", "path": "/data/openviking" },
- "vectordb": { "backend": "local", "path": "/data/openviking" }
+ "workspace": "./data",
+ "agfs": { "backend": "local" },
+ "vectordb": { "backend": "local" }
}
}
```
@@ -67,8 +68,9 @@ python -m openviking serve --config /path/to/ov.conf --host 127.0.0.1 --port 800
```json
{
"storage": {
- "agfs": { "backend": "local", "path": "./data" },
- "vectordb": { "backend": "local", "path": "./data" }
+ "workspace": "./data",
+ "agfs": { "backend": "local" },
+ "vectordb": { "backend": "local" }
}
}
```