Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.
Python agent-contextagent-memoryagent-pluginsagentic-ragcontext-databasedsh-pluginknowledge-basememorymemory-managementself-evolvingvector-database
docs: fix code-documentation inconsistencies in docs (#1741)
Zayn Jarvis75ac3cfe40b7
diff --git a/README.md b/README.mdindex 908627d81..2e4a86eaa 100644--- a/README.md+++ b/README.md@@ -64,7 +64,7 @@ With OpenViking, developers can build an Agent's brain just like managing localBefore starting with OpenViking, please ensure your environment meets the following requirements:- **Python Version**: 3.10 or higher-- **Go Version**: 1.22 or higher (Required for building AGFS components)+- **Rust Toolchain**: Cargo (Required for building RAGFS and CLI components from source)- **C++ Compiler**: GCC 9+ or Clang 11+ (Required for building core extensions)- **Operating System**: Linux, macOS, Windows- **Network Connection**: A stable network connection is required (for downloading dependencies and accessing model services)@@ -335,7 +335,7 @@ If you prefer manual configuration, create `~/.openviking/ov.conf`, remove the c}```-> **Note**: For embedding models, supported providers are `volcengine` (Doubao), `openai`, `jina`, `voyage`, `minimax`, `vikingdb`, and `gemini` (requires `pip install "google-genai>=1.0.0"`). For VLM models, common providers include `volcengine`, `openai`, `openai-codex`, `kimi`, and `glm`.+> **Note**: For embedding models, supported providers are `volcengine` (Doubao), `openai`, `azure`, `jina`, `ollama`, `voyage`, `dashscope`, `minimax`, `cohere`, `vikingdb`, `gemini` (requires `pip install "google-genai>=1.0.0"`), `litellm`, and `local`. For VLM models, common providers include `volcengine`, `openai`, `openai-codex`, `kimi`, and `glm`.#### Server Configuration Examplesdiff --git a/README_CN.md b/README_CN.mdindex e37d93574..240357d05 100644--- a/README_CN.md+++ b/README_CN.md@@ -62,7 +62,7 @@在开始使用 OpenViking 之前,请确保您的环境满足以下要求:- **Python 版本**:3.10 或更高版本-- **Go 版本**:1.22 或更高(从源码构建 AGFS 组件需要)+- **Rust 工具链**:Cargo(从源码构建 RAGFS 和 CLI 组件需要)- **C++ 编译器**:GCC 9+ 或 Clang 11+(构建核心扩展需要,必须支持 C++17)- **操作系统**:Linux、macOS、Windows- **网络连接**:需要稳定的网络连接(用于下载依赖和访问模型服务)@@ -291,7 +291,7 @@ openviking-server doctor}```-> **注意**:对于 embedding 模型,目前支持 `volcengine`(豆包)、`openai`、`azure`、`jina` 等提供商。对于 VLM 模型,常见提供商包括 `volcengine`、`openai`、`azure`、`openai-codex`。+> **注意**:对于 embedding 模型,支持 `volcengine`(豆包)、`openai`、`azure`、`jina`、`ollama`、`voyage`、`dashscope`、`minimax`、`cohere`、`vikingdb`、`gemini`(需 `pip install "google-genai>=1.0.0"`)、`litellm` 和 `local`。对于 VLM 模型,常见提供商包括 `volcengine`、`openai`、`openai-codex`、`kimi`、`glm`。#### 服务器配置示例diff --git a/README_JA.md b/README_JA.mdindex c81a9fd8d..e0f1a32bf 100644--- a/README_JA.md+++ b/README_JA.md@@ -64,7 +64,7 @@ OpenVikingを使えば、開発者はローカルファイルを管理するよOpenVikingを始める前に、環境が以下の要件を満たしていることを確認してください:- **Pythonバージョン**: 3.10以上-- **Goバージョン**: 1.22以上(AGFSコンポーネントのビルドに必要)+- **Rustツールチェーン**: Cargo(RAGFSおよびCLIコンポーネントのソースビルドに必要)- **C++コンパイラ**: GCC 9以上 または Clang 11以上(コア拡張のビルドに必要)- **オペレーティングシステム**: Linux、macOS、Windows- **ネットワーク接続**: 安定したネットワーク接続が必要(依存関係のダウンロードとモデルサービスへのアクセスのため)@@ -203,7 +203,7 @@ OpenAIの公式APIを使用:}```-> **注意**: Embeddingモデルについては、現在`volcengine`(Doubao)、`openai`、`jina`プロバイダーがサポートされています。VLMモデルについては、`volcengine`と`openai`をサポートしています。+> **注意**: Embeddingモデルについては、`volcengine`(Doubao)、`openai`、`azure`、`jina`、`ollama`、`voyage`、`dashscope`、`minimax`、`cohere`、`vikingdb`、`gemini`(`pip install "google-genai>=1.0.0"` が必要)、`litellm`、`local` プロバイダーがサポートされています。VLMモデルについては、`volcengine`、`openai`、`openai-codex`、`kimi`、`glm` をサポートしています。#### サーバー設定例diff --git a/docs/en/api/01-overview.md b/docs/en/api/01-overview.mdindex f159efece..80ddeeac0 100644--- a/docs/en/api/01-overview.md+++ b/docs/en/api/01-overview.md@@ -370,6 +370,7 @@ Compact JSON with status wrapper (when `--compact` is true, which is the default| POST | `/api/v1/sessions/{id}/extract` | Extract memories from a session || POST | `/api/v1/sessions/{id}/messages` | Add message || POST | `/api/v1/sessions/{id}/used` | Record contexts / skills actually used |+| GET | `/api/v1/sessions/{id}/archives/{archive_id}` | Get a specific session archive |### Tasksdiff --git a/docs/en/concepts/07-retrieval.md b/docs/en/concepts/07-retrieval.mdindex 4dd5f87e2..b1666881d 100644--- a/docs/en/concepts/07-retrieval.md+++ b/docs/en/concepts/07-retrieval.md@@ -126,7 +126,7 @@ while dir_queue:|-----------|-------|-------------|| `SCORE_PROPAGATION_ALPHA` | 0.5 | 50% embedding + 50% parent || `MAX_CONVERGENCE_ROUNDS` | 3 | Convergence detection rounds |-| `GLOBAL_SEARCH_TOPK` | 3 | Global search candidates |+| `GLOBAL_SEARCH_TOPK` | 10 | Global search candidates || `MAX_RELATIONS` | 5 | Max relations per resource |## Rerank Strategydiff --git a/docs/en/concepts/12-metrics.md b/docs/en/concepts/12-metrics.mdindex f504a9fdd..56e01a22e 100644--- a/docs/en/concepts/12-metrics.md+++ b/docs/en/concepts/12-metrics.md@@ -137,7 +137,7 @@ Notes:## Key Metric Families-The metric summaries below are based on representative metrics currently exposed in `.vscode/.workdir/metric/METRIC_res.md`.+The metric summaries below are based on representative metrics currently exposed by the collectors in `openviking/metrics/collectors/`.### Requests and Operationsdiff --git a/docs/en/faq/faq.md b/docs/en/faq/faq.mdindex da9271be4..3fa747bf0 100644--- a/docs/en/faq/faq.md+++ b/docs/en/faq/faq.md@@ -56,7 +56,7 @@ viking://### What are the environment requirements?- **Python Version**: 3.10 or higher-- **Build Tools** (if installing from source or on unsupported platforms): Go 1.19+, GCC 9+ or Clang 11++- **Build Tools** (if installing from source or on unsupported platforms): Rust/Cargo, GCC 9+ or Clang 11+- **Required Dependencies**: Embedding model (Volcengine Doubao recommended)- **Optional Dependencies**:- VLM (Vision Language Model): For multimodal content processing and semantic extractiondiff --git a/docs/en/guides/01-configuration.md b/docs/en/guides/01-configuration.mdindex cf00d482a..00283aae7 100644--- a/docs/en/guides/01-configuration.md+++ b/docs/en/guides/01-configuration.md@@ -68,7 +68,7 @@ For `provider: "openai-codex"`, `vlm.api_key` is optional when Codex OAuth is al"api_base" : "https://ark.cn-beijing.volces.com/api/v3","api_key" : "your-volcengine-api-key","provider" : "volcengine",- "model" : "doubao-seed-2-0-code-preview-260215"+ "model" : "doubao-seed-2-0-pro-260215"}}```@@ -995,7 +995,7 @@ When running OpenViking as an HTTP service, add a `server` section to `ov.conf`:```json{"server": {- "host": "0.0.0.0",+ "host": "127.0.0.1","port": 1933,"auth_mode": "api_key","root_api_key": "your-secret-root-key",@@ -1006,7 +1006,7 @@ When running OpenViking as an HTTP service, add a `server` section to `ov.conf`:| Field | Type | Description | Default ||-------|------|-------------|---------|-| `host` | str | Bind address | `0.0.0.0` |+| `host` | str | Bind address | `127.0.0.1` || `port` | int | Bind port | `1933` || `auth_mode` | str | Authentication mode: `"api_key"` or `"trusted"`. Default is `"api_key"` | `"api_key"` || `root_api_key` | str | Root API key for multi-tenant auth in `api_key` mode. In `trusted` mode it is optional on localhost, but required for any non-localhost deployment; it does not become the source of user identity | `null` |@@ -1206,7 +1206,7 @@ For detailed encryption explanations, see [Data Encryption](../concepts/10-encry"code_summary_mode": "ast"},"server": {- "host": "0.0.0.0",+ "host": "127.0.0.1","port": 1933,"root_api_key": "string","cors_origins": ["*"]diff --git a/docs/en/guides/03-deployment.md b/docs/en/guides/03-deployment.mdindex be7e7e215..adecded0c 100644--- a/docs/en/guides/03-deployment.md+++ b/docs/en/guides/03-deployment.md@@ -29,7 +29,7 @@ curl http://localhost:1933/health| Option | Description | Default ||--------|-------------|---------|| `--config` | Path to ov.conf file | `~/.openviking/ov.conf` |-| `--host` | Host to bind to | `0.0.0.0` |+| `--host` | Host to bind to | `127.0.0.1` || `--port` | Port to bind to | `1933` |**Examples**diff --git a/docs/zh/api/01-overview.md b/docs/zh/api/01-overview.mdindex bfd3164b2..572a54ba0 100644--- a/docs/zh/api/01-overview.md+++ b/docs/zh/api/01-overview.md@@ -367,6 +367,7 @@ openviking -o json ls viking://resources/| POST | `/api/v1/sessions/{id}/extract` | 从会话提取记忆 || POST | `/api/v1/sessions/{id}/messages` | 添加消息 || POST | `/api/v1/sessions/{id}/used` | 记录实际使用的上下文 / 技能 |+| GET | `/api/v1/sessions/{id}/archives/{archive_id}` | 获取特定会话归档 |### 任务diff --git a/docs/zh/concepts/07-retrieval.md b/docs/zh/concepts/07-retrieval.mdindex 4b4e50abc..6b622c5e1 100644--- a/docs/zh/concepts/07-retrieval.md+++ b/docs/zh/concepts/07-retrieval.md@@ -126,7 +126,7 @@ while dir_queue:|------|-----|------|| `SCORE_PROPAGATION_ALPHA` | 0.5 | 50% embedding + 50% parent || `MAX_CONVERGENCE_ROUNDS` | 3 | 收敛检测轮数 |-| `GLOBAL_SEARCH_TOPK` | 3 | 全局搜索候选数 |+| `GLOBAL_SEARCH_TOPK` | 10 | 全局搜索候选数 || `MAX_RELATIONS` | 5 | 每资源最大关联数 |## Rerank 策略diff --git a/docs/zh/concepts/12-metrics.md b/docs/zh/concepts/12-metrics.mdindex 90cb08988..22d4f86fb 100644--- a/docs/zh/concepts/12-metrics.md+++ b/docs/zh/concepts/12-metrics.md@@ -137,7 +137,7 @@ scrape_configs:## 关键指标说明-下面的指标说明基于当前实际暴露的代表性指标输出(整理自 `.vscode/.workdir/metric/METRIC_res.md`)。+下面的指标说明基于当前实际暴露的代表性指标输出(整理自 `openviking/metrics/collectors/`)。### 请求与操作diff --git a/docs/zh/faq/faq.md b/docs/zh/faq/faq.mdindex c4c69b011..dc11eeebb 100644--- a/docs/zh/faq/faq.md+++ b/docs/zh/faq/faq.md@@ -56,7 +56,7 @@ viking://### 环境要求是什么?- **Python 版本**:3.10 或更高-- **编译工具**(如果从源码安装或在不支持的平台上):Go 1.19+, GCC 9+ 或 Clang 11++- **编译工具**(如果从源码安装或在不支持的平台上):Rust/Cargo, GCC 9+ 或 Clang 11+- **必需依赖**:Embedding 模型(推荐火山引擎 Doubao)- **可选依赖**:- VLM(视觉语言模型):用于多模态内容处理和语义提取diff --git a/docs/zh/guides/01-configuration.md b/docs/zh/guides/01-configuration.mdindex 2f4aa8cbf..d024dccef 100644--- a/docs/zh/guides/01-configuration.md+++ b/docs/zh/guides/01-configuration.md@@ -69,7 +69,7 @@ openviking-server doctor"api_base" : "https://ark.cn-beijing.volces.com/api/v3","api_key" : "your-volcengine-api-key","provider" : "volcengine",- "model" : "doubao-seed-2-0-code-preview-260215"+ "model" : "doubao-seed-2-0-pro-260215"}}```@@ -969,7 +969,7 @@ openviking add-resource ./docs --exclude "*.tmp"```json{"server": {- "host": "0.0.0.0",+ "host": "127.0.0.1","port": 1933,"auth_mode": "api_key","root_api_key": "your-secret-root-key",@@ -980,7 +980,7 @@ openviking add-resource ./docs --exclude "*.tmp"| 字段 | 类型 | 说明 | 默认值 ||------|------|------|--------|-| `host` | str | 绑定地址 | `0.0.0.0` |+| `host` | str | 绑定地址 | `127.0.0.1` || `port` | int | 绑定端口 | `1933` || `auth_mode` | str | 认证模式:`"api_key"` 或 `"trusted"`。默认值为 `"api_key"` | `"api_key"` || `root_api_key` | str | Root API Key。在 `api_key` 模式下启用多租户认证;在 `trusted` 模式下它只是可选附加保护,不负责解析普通用户身份 | `null` |diff --git a/docs/zh/guides/03-deployment.md b/docs/zh/guides/03-deployment.mdindex 072351524..9e0a0de09 100644--- a/docs/zh/guides/03-deployment.md+++ b/docs/zh/guides/03-deployment.md@@ -29,7 +29,7 @@ curl http://localhost:1933/health| 选项 | 描述 | 默认值 ||------|------|--------|| `--config` | 配置文件路径 | `~/.openviking/ov.conf` |-| `--host` | 绑定的主机地址 | `0.0.0.0` |+| `--host` | 绑定的主机地址 | `127.0.0.1` || `--port` | 绑定的端口 | `1933` |**示例**