Skip to content

Commit 9f7feb0

Browse files
authored
fix: cap pymilvus<2.6.10, add milvus_token param, sync version (#19)
- Cap pymilvus to <2.6.10 to fix MilvusClient hanging with milvus-lite 2.5.1 - Add milvus_token parameter to VectorGraphRAG and create_rag for Zilliz Cloud support - Sync __version__ in __init__.py to match pyproject.toml (0.1.1) - Add milvus_token column to Milvus backend table in README - Add Zilliz Cloud section and deployment modes table to docs/getting-started.md Signed-off-by: Cheney Zhang <chen.zhang@zilliz.com>
1 parent 2a93a56 commit 9f7feb0

6 files changed

Lines changed: 259 additions & 13 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -183,11 +183,11 @@ Evaluated on three multi-hop QA benchmarks (Recall@5):
183183

184184
Vector Graph RAG supports three Milvus deployment modes — just change `milvus_uri`:
185185

186-
| Mode | `milvus_uri` | Best for |
187-
|------|-------------|----------|
188-
| **Milvus Lite** (default) | `./vector_graph_rag.db` | Personal use, dev — zero config |
189-
| **Milvus Server** | `http://localhost:19530` | Multi-dataset, team environments |
190-
|**Zilliz Cloud** | `https://in03-xxx.api.gcp-us-west1.zillizcloud.com` | Production, fully managed — [free tier available](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) |
186+
| Mode | `milvus_uri` | `milvus_token` | Best for |
187+
|------|-------------|----------------|----------|
188+
| **Milvus Lite** (default) | `./vector_graph_rag.db` | | Personal use, dev — zero config |
189+
| **Milvus Server** | `http://localhost:19530` | Optional | Multi-dataset, team environments |
190+
|**Zilliz Cloud** | `https://in03-xxx.api.gcp-us-west1.zillizcloud.com` | API key | Production, fully managed — [free tier available](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) |
191191

192192
> **Recommended:** [Zilliz Cloud](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) gives you zero-config, zero-ops Milvus with concurrent access and real-time indexing — no Docker needed.
193193

docs/getting-started.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,26 @@ rag = VectorGraphRAG(
6565
)
6666
```
6767

68+
### With Zilliz Cloud
69+
70+
```python
71+
rag = VectorGraphRAG(
72+
milvus_uri="https://in03-xxx.api.gcp-us-west1.zillizcloud.com",
73+
milvus_token="your-api-key",
74+
)
75+
```
76+
77+
!!! tip "Free tier available"
78+
[Sign up for Zilliz Cloud](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-docs) to get a free cluster. Use the cluster endpoint as `milvus_uri` and your API key as `milvus_token`.
79+
80+
### Milvus Deployment Modes
81+
82+
| Mode | `milvus_uri` | `milvus_token` | Best for |
83+
|------|-------------|----------------|----------|
84+
| **Milvus Lite** (default) | `./vector_graph_rag.db` || Personal use, dev — zero config |
85+
| **Milvus Server** | `http://localhost:19530` | Optional | Multi-dataset, team environments |
86+
|**Zilliz Cloud** | `https://in03-xxx.api.gcp-us-west1.zillizcloud.com` | API key | Production, fully managed |
87+
6888
!!! info "Collection naming"
6989
With `collection_prefix="my_project"`, collections are named `my_project_vgrag_entities`, `my_project_vgrag_relations`, `my_project_vgrag_passages`.
7090

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ classifiers = [
2222
]
2323

2424
dependencies = [
25-
"pymilvus>=2.4.0",
25+
"pymilvus>=2.4.0,<2.6.10",
2626
"milvus-lite>=2.4.0",
2727
"numpy>=1.24.0",
2828
"scipy>=1.10.0",

src/vector_graph_rag/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
from vector_graph_rag.rag import VectorGraphRAG, create_rag
1919
from vector_graph_rag.llm.cache import LLMCache, get_llm_cache
2020

21-
__version__ = "0.1.0"
21+
__version__ = "0.1.1"
2222

2323
__all__ = [
2424
"Settings",

src/vector_graph_rag/rag.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ def __init__(
5555
self,
5656
settings: Optional[Settings] = None,
5757
milvus_uri: Optional[str] = None,
58+
milvus_token: Optional[str] = None,
5859
milvus_db: Optional[str] = None,
5960
collection_prefix: Optional[str] = None,
6061
openai_api_key: Optional[str] = None,
@@ -67,6 +68,7 @@ def __init__(
6768
Args:
6869
settings: Full settings object (overrides other parameters).
6970
milvus_uri: Milvus connection URI. Defaults to local file.
71+
milvus_token: Milvus authentication token (for Zilliz Cloud).
7072
milvus_db: Milvus database name. Defaults to None (use server default).
7173
collection_prefix: Prefix for collection names (e.g., graph/dataset name).
7274
openai_api_key: OpenAI API key. Uses environment variable if not provided.
@@ -83,6 +85,12 @@ def __init__(
8385
... llm_model="gpt-4o",
8486
... )
8587
>>>
88+
>>> # Zilliz Cloud
89+
>>> rag = VectorGraphRAG(
90+
... milvus_uri="https://in03-xxx.api.gcp-us-west1.zillizcloud.com",
91+
... milvus_token="your-api-key",
92+
... )
93+
>>>
8694
>>> # Separate graphs with collection prefix
8795
>>> rag = VectorGraphRAG(
8896
... milvus_uri="http://localhost:19530",
@@ -97,6 +105,8 @@ def __init__(
97105
settings_kwargs = {}
98106
if milvus_uri:
99107
settings_kwargs["milvus_uri"] = milvus_uri
108+
if milvus_token:
109+
settings_kwargs["milvus_token"] = milvus_token
100110
if milvus_db:
101111
settings_kwargs["milvus_db"] = milvus_db
102112
if collection_prefix:
@@ -712,6 +722,7 @@ def reset(self) -> None:
712722

713723
def create_rag(
714724
milvus_uri: Optional[str] = None,
725+
milvus_token: Optional[str] = None,
715726
milvus_db: Optional[str] = None,
716727
collection_prefix: Optional[str] = None,
717728
openai_api_key: Optional[str] = None,
@@ -725,6 +736,7 @@ def create_rag(
725736
726737
Args:
727738
milvus_uri: Milvus connection URI. Defaults to local file.
739+
milvus_token: Milvus authentication token (for Zilliz Cloud).
728740
milvus_db: Milvus database name. Defaults to None (use server default).
729741
collection_prefix: Prefix for collection names (e.g., graph/dataset name).
730742
openai_api_key: OpenAI API key. Uses environment variable if not provided.
@@ -741,6 +753,7 @@ def create_rag(
741753
"""
742754
return VectorGraphRAG(
743755
milvus_uri=milvus_uri,
756+
milvus_token=milvus_token,
744757
milvus_db=milvus_db,
745758
collection_prefix=collection_prefix,
746759
openai_api_key=openai_api_key,

0 commit comments

Comments
 (0)