Skip to content
Open
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
34 changes: 33 additions & 1 deletion docs/en/guides/01-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -1209,7 +1209,7 @@ Vector database storage configuration

| Parameter | Type | Description | Default |
|-----------|------|-------------|---------|
| `backend` | str | VectorDB backend type: 'local' (file-based), 'http' (remote service), 'volcengine' (cloud VikingDB), 'vikingdb' (private deployment), 'cuvs' (local storage + GPU dense search), 'qdrant', or 'opengauss' | "local" |
| `backend` | str | VectorDB backend type: 'local' (file-based), 'http' (remote service), 'volcengine' (cloud VikingDB), 'vikingdb' (private deployment), 'cuvs' (local storage + GPU dense search), 'qdrant', 'milvus', or 'opengauss' | "local" |
| `name` | str | VectorDB collection name | "context" |
| `url` | str | Remote service URL for 'http' type (e.g., 'http://localhost:5000') | null |
| `project_name` | str | Project name (alias project) | "default" |
Expand All @@ -1220,6 +1220,7 @@ Vector database storage configuration
| `vikingdb` | object | 'vikingdb' type private deployment configuration | - |
| `cuvs` | object | NVIDIA cuVS configuration for the 'cuvs' backend and the opt-in memory-aware auto mode on 'local'; see the [cuVS guide](./16-cuvs.md) | - |
| `qdrant` | object | 'qdrant' type Qdrant configuration | - |
| `milvus` | object | 'milvus' type Milvus or Zilliz Cloud configuration | - |
| `opengauss` | object | 'opengauss' native vector backend configuration | - |

Default local mode
Expand Down Expand Up @@ -1254,6 +1255,37 @@ Supports cloud-deployed VikingDB on Volcengine
```
</details>

<details>
<summary><b>Milvus</b></summary>

Install the `milvus` optional extra before using this backend. The default `uri`
uses Milvus Lite and stores data in a local `milvus.db` file. Use an HTTP URI for
self-hosted Milvus, or a cloud endpoint plus `token` for Zilliz Cloud.

```json
{
"storage": {
"vectordb": {
"name": "context",
"backend": "milvus",
"project": "default",
"distance_metric": "cosine",
"dimension": 1024,
"milvus": {
"uri": "./milvus.db",
"token": null,
"db_name": null,
"consistency_level": "Session"
}
}
}
}
```

For a self-hosted server, set `"uri": "http://localhost:19530"`. For Zilliz Cloud,
set `"uri"` to the cloud endpoint and provide `"token"`.
</details>

<details>
<summary><b>openGauss</b></summary>

Expand Down
34 changes: 33 additions & 1 deletion docs/zh/guides/01-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -1181,7 +1181,7 @@ RAGFS 默认使用 Rust binding 模式,通过 Rust 实现直接访问文件系

| 参数 | 类型 | 说明 | 默认值 |
|------|------|------|--------|
| `backend` | str | VectorDB 后端类型: 'local'(基于文件), 'http'(远程服务), 'volcengine'(云上 VikingDB), 'vikingdb'(私有部署), 'cuvs'(本地存储 + GPU dense search), 'qdrant' 或 'opengauss' | "local" |
| `backend` | str | VectorDB 后端类型: 'local'(基于文件), 'http'(远程服务), 'volcengine'(云上 VikingDB), 'vikingdb'(私有部署), 'cuvs'(本地存储 + GPU dense search), 'qdrant'、'milvus' 或 'opengauss' | "local" |
| `name` | str | VectorDB 的集合名称 | "context" |
| `url` | str | 'http' 类型的远程服务 URL(例如 'http://localhost:5000') | null |
| `project_name` | str | 项目名称(别名 project) | "default" |
Expand All @@ -1192,6 +1192,7 @@ RAGFS 默认使用 Rust binding 模式,通过 Rust 实现直接访问文件系
| `vikingdb` | object | 'vikingdb' 类型的私有部署配置 | - |
| `cuvs` | object | NVIDIA cuVS 配置,也用于在 'local' 下显式开启显存感知自动模式,参见 [cuVS 使用指南](./16-cuvs.md) | - |
| `qdrant` | object | 'qdrant' 类型的 Qdrant 配置 | - |
| `milvus` | object | 'milvus' 类型的 Milvus 或 Zilliz Cloud 配置 | - |
| `opengauss` | object | 'opengauss' 原生向量后端配置 | - |

默认使用本地模式
Expand Down Expand Up @@ -1226,6 +1227,37 @@ RAGFS 默认使用 Rust binding 模式,通过 Rust 实现直接访问文件系
```
</details>

<details>
<summary><b>Milvus</b></summary>

使用该后端前需要安装 `milvus` 可选依赖。默认 `uri` 使用 Milvus Lite,
并把数据写入本地 `milvus.db` 文件。自托管 Milvus 使用 HTTP URI;
Zilliz Cloud 使用云端 endpoint 并配置 `token`。

```json
{
"storage": {
"vectordb": {
"name": "context",
"backend": "milvus",
"project": "default",
"distance_metric": "cosine",
"dimension": 1024,
"milvus": {
"uri": "./milvus.db",
"token": null,
"db_name": null,
"consistency_level": "Session"
}
}
}
}
```

如果连接自托管服务,可设置 `"uri": "http://localhost:19530"`。如果使用
Zilliz Cloud,把 `"uri"` 设置为云端 endpoint,并填写 `"token"`。
</details>

<details>
<summary><b>openGauss</b></summary>

Expand Down
28 changes: 27 additions & 1 deletion openviking/storage/vectordb_adapters/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,32 @@
1. `backend`: 填写 Adapter 类的完整 Python 路径(例如 `my_project.adapters.MyAdapter`)。
2. `custom_params`: 这是一个字典,你可以放入任何自定义参数,Adapter 的 `from_config` 方法可以通过 `config.custom_params` 获取这些值。

内置 Milvus 后端可直接使用 registry 名称,并通过 `milvus` 配置块传递连接信息:

```json
{
"storage": {
"vectordb": {
"backend": "milvus",
"name": "context",
"project": "default",
"distance_metric": "cosine",
"dimension": 1024,
"milvus": {
"uri": "./milvus.db",
"token": null,
"db_name": null,
"consistency_level": "Session"
}
}
}
}
```

`uri` 默认为 Milvus Lite 本地文件;也可以设置为自建 Milvus 服务
(如 `http://localhost:19530`)或 Zilliz Cloud endpoint,认证统一使用
`token` 字段。



---
Expand Down Expand Up @@ -238,4 +264,4 @@ class ThirdPartyCollectionAdapter(CollectionAdapter):
- `backend=thirdparty` 可正常初始化。
- create 后可完成 upsert/get/query/delete/count 全流程。
- 不改上层业务调用方式即可参与 `find/search` 检索链路。
- 后端差异全部封装在 adapter 层。
- 后端差异全部封装在 adapter 层。
2 changes: 2 additions & 0 deletions openviking/storage/vectordb_adapters/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from .factory import create_collection_adapter
from .http_adapter import HttpCollectionAdapter
from .local_adapter import CuVSCollectionAdapter, LocalCollectionAdapter
from .milvus_adapter import MilvusCollectionAdapter
from .opengauss_adapter import OpenGaussCollectionAdapter
from .qdrant_adapter import QdrantCollectionAdapter
from .vikingdb_private_adapter import VikingDBPrivateCollectionAdapter
Expand All @@ -16,6 +17,7 @@
"LocalCollectionAdapter",
"CuVSCollectionAdapter",
"HttpCollectionAdapter",
"MilvusCollectionAdapter",
"OpenGaussCollectionAdapter",
"QdrantCollectionAdapter",
"VolcengineCollectionAdapter",
Expand Down
2 changes: 2 additions & 0 deletions openviking/storage/vectordb_adapters/factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from .base import CollectionAdapter
from .http_adapter import HttpCollectionAdapter
from .local_adapter import CuVSCollectionAdapter, LocalCollectionAdapter
from .milvus_adapter import MilvusCollectionAdapter
from .opengauss_adapter import OpenGaussCollectionAdapter
from .qdrant_adapter import QdrantCollectionAdapter
from .vikingdb_private_adapter import VikingDBPrivateCollectionAdapter
Expand All @@ -18,6 +19,7 @@
"local": LocalCollectionAdapter,
"cuvs": CuVSCollectionAdapter,
"http": HttpCollectionAdapter,
"milvus": MilvusCollectionAdapter,
"opengauss": OpenGaussCollectionAdapter,
"qdrant": QdrantCollectionAdapter,
"volcengine": VolcengineCollectionAdapter,
Expand Down
Loading