Milvus - Vector Store
Use Milvus as a vector store for RAG.
Quick Startβ
You need three things:
- A Milvus instance (cloud or self-hosted)
- An embedding model (to convert your queries to vectors)
- A Milvus collection with vector fields
Usageβ
- SDK
- PROXY
Basic Searchβ
from litellm import vector_stores
import os
# Set your credentials
os.environ["MILVUS_API_KEY"] = "your-milvus-api-key"
os.environ["MILVUS_API_BASE"] = "https://your-milvus-instance.milvus.io"
# Search the vector store
response = vector_stores.search(
vector_store_id="my-collection-name", # Your Milvus collection name
query="What is the capital of France?",
custom_llm_provider="milvus",
litellm_embedding_model="azure/text-embedding-3-large",
litellm_embedding_config={
"api_base": "your-embedding-endpoint",
"api_key": "your-embedding-api-key",
"api_version": "2025-09-01"
},
milvus_text_field="book_intro", # Field name that contains text content
api_key=os.getenv("MILVUS_API_KEY"),
)
print(response)
Async Searchβ
from litellm import vector_stores
response = await vector_stores.asearch(
vector_store_id="my-collection-name",
query="What is the capital of France?",
custom_llm_provider="milvus",
litellm_embedding_model="azure/text-embedding-3-large",
litellm_embedding_config={
"api_base": "your-embedding-endpoint",
"api_key": "your-embedding-api-key",
"api_version": "2025-09-01"
},
milvus_text_field="book_intro",
api_key=os.getenv("MILVUS_API_KEY"),
)
print(response)
Advanced Optionsβ
from litellm import vector_stores
response = vector_stores.search(
vector_store_id="my-collection-name",
query="What is the capital of France?",
custom_llm_provider="milvus",
litellm_embedding_model="azure/text-embedding-3-large",
litellm_embedding_config={
"api_base": "your-embedding-endpoint",
"api_key": "your-embedding-api-key",
},
milvus_text_field="book_intro",
api_key=os.getenv("MILVUS_API_KEY"),
# Milvus-specific parameters
limit=10, # Number of results to return
offset=0, # Pagination offset
dbName="default", # Database name
annsField="book_intro_vector", # Vector field name
outputFields=["id", "book_intro", "title"], # Fields to return
filter='book_id > 0', # Metadata filter expression
searchParams={"metric_type": "L2", "params": {"nprobe": 10}}, # Search parameters
)
print(response)
Setup Configβ
Add this to your config.yaml:
vector_store_registry:
- vector_store_name: "milvus-knowledgebase"
litellm_params:
vector_store_id: "my-collection-name"
custom_llm_provider: "milvus"
api_key: os.environ/MILVUS_API_KEY
api_base: https://your-milvus-instance.milvus.io
litellm_embedding_model: "azure/text-embedding-3-large"
litellm_embedding_config:
api_base: https://your-endpoint.cognitiveservices.azure.com/
api_key: os.environ/AZURE_API_KEY
api_version: "2025-09-01"
milvus_text_field: "book_intro"
# Optional Milvus parameters
annsField: "book_intro_vector"
limit: 10
Start Proxyβ
litellm --config /path/to/config.yaml
Search via APIβ
curl -X POST 'http://0.0.0.0:4000/v1/vector_stores/my-collection-name/search' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer sk-1234' \
-d '{
"query": "What is the capital of France?"
}'
Required Parametersβ
| Parameter | Type | Description |
|---|---|---|
vector_store_id | string | Your Milvus collection name |
custom_llm_provider | string | Set to "milvus" |
litellm_embedding_model | string | Model to generate query embeddings (e.g., "azure/text-embedding-3-large") |
litellm_embedding_config | dict | Config for the embedding model (api_base, api_key, api_version) |
milvus_text_field | string | Field name in your collection that contains text content |
api_key | string | Your Milvus API key (or set MILVUS_API_KEY env var) |
api_base | string | Your Milvus API base URL (or set MILVUS_API_BASE env var) |
Optional Parametersβ
| Parameter | Type | Description |
|---|---|---|
dbName | string | Database name (default: "default") |
annsField | string | Vector field name to search (default: "book_intro_vector") |
limit | integer | Maximum number of results to return |
offset | integer | Pagination offset |
filter | string | Filter expression for metadata filtering |
groupingField | string | Field to group results by |
outputFields | list | List of fields to return in results |
searchParams | dict | Search parameters like metric type and search parameters |
partitionNames | list | List of partition names to search |
consistencyLevel | string | Consistency level for the search |
Supported Featuresβ
| Feature | Status | Notes |
|---|---|---|
| Logging | β Supported | Full logging support available |
| Guardrails | β Not Yet Supported | Guardrails are not currently supported for vector stores |
| Cost Tracking | β Supported | Cost is $0 for Milvus searches |
| Unified API | β Supported | Call via OpenAI compatible /v1/vector_stores/search endpoint |
| Passthrough | β Supported | Use native Milvus API format |
Response Formatβ
The response follows the standard LiteLLM vector store format:
{
"object": "vector_store.search_results.page",
"search_query": "What is the capital of France?",
"data": [
{
"score": 0.95,
"content": [
{
"text": "Paris is the capital of France...",
"type": "text"
}
],
"file_id": null,
"filename": null,
"attributes": {
"id": "123",
"title": "France Geography"
}
}
]
}
Passthrough API (Native Milvus Format)β
Use this to allow developers to create and search vector stores using the native Milvus API format, without giving them the Milvus credentials.
This is for the proxy only.
Admin Flowβ
1. Add the vector store to LiteLLMβ
model_list:
- model_name: embedding-model
litellm_params:
model: azure/text-embedding-3-large
api_base: https://your-endpoint.cognitiveservices.azure.com/
api_key: os.environ/AZURE_API_KEY
api_version: "2025-09-01"
vector_store_registry:
- vector_store_name: "milvus-store"
litellm_params:
vector_store_id: "can-be-anything" # vector store id can be anything for the purpose of passthrough api
custom_llm_provider: "milvus"
api_key: os.environ/MILVUS_API_KEY
api_base: https://your-milvus-instance.milvus.io
general_settings:
database_url: "postgresql://user:password@host:port/database"
master_key: "sk-1234"
Add your vector store credentials to LiteLLM.
2. Start the proxyβ
litellm --config /path/to/config.yaml
# RUNNING on http://0.0.0.0:4000
3. Create a virtual indexβ
curl -L -X POST 'http://0.0.0.0:4000/v1/indexes' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer sk-1234' \
-d '{
"index_name": "dall-e-6",
"litellm_params": {
"vector_store_index": "real-collection-name",
"vector_store_name": "milvus-store"
}
}'
This is a virtual index, which the developer can use to create and search vector stores.
4. Create a key with the vector store permissionsβ
curl -L -X POST 'http://0.0.0.0:4000/key/generate' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer sk-1234' \
-d '{
"allowed_vector_store_indexes": [{"index_name": "dall-e-6", "index_permissions": ["write", "read"]}],
"models": ["embedding-model"]
}'
Give the key access to the virtual index and the embedding model.
Expected response
{
"key": "sk-my-virtual-key"
}
Developer Flowβ
MilvusRESTClientβ
To use the passthrough API, you need a simple REST client. Copy this milvus_rest_client.py file to your project:
Click to expand milvus_rest_client.py
"""
Simple Milvus REST API v2 Client
Based on: https://milvus.io/api-reference/restful/v2.6.x/
"""
import requests
from typing import List, Dict, Any, Optional
class DataType:
"""Milvus data types"""
INT64 = "Int64"
FLOAT_VECTOR = "FloatVector"
VARCHAR = "VarChar"
BOOL = "Bool"
FLOAT = "Float"
class CollectionSchema:
"""Collection schema builder"""
def __init__(self):
self.fields = []
def add_field(
self,
field_name: str,
data_type: str,
is_primary: bool = False,
dim: Optional[int] = None,
description: str = "",
):
"""Add a field to the schema"""
field = {
"fieldName": field_name,
"dataType": data_type,
"isPrimary": is_primary,
"description": description,
}
if data_type == DataType.FLOAT_VECTOR and dim:
field["elementTypeParams"] = {"dim": str(dim)}
self.fields.append(field)
return self
def to_dict(self):
"""Convert schema to dict for API"""
return {"fields": self.fields}
class IndexParams:
"""Index parameters builder"""
def __init__(self):
self.indexes = []
def add_index(
self, field_name: str, metric_type: str = "L2", index_name: Optional[str] = None
):
"""Add an index"""
index = {
"fieldName": field_name,
"indexName": index_name or f"{field_name}_index",
"metricType": metric_type,
}
self.indexes.append(index)
return self
def to_list(self):
"""Convert to list for API"""
return self.indexes
class MilvusRESTClient:
"""
Simple Milvus REST API v2 Client
Reference: https://milvus.io/api-reference/restful/v2.6.x/
"""
def __init__(self, uri: str, token: str, db_name: str = "default"):
"""
Initialize Milvus REST client
Args:
uri: Milvus server URI (e.g., http://localhost:19530)
token: Authentication token
db_name: Database name
"""
self.base_url = uri.rstrip("/")
self.token = token
self.db_name = db_name
self.headers = {
"Authorization": f"Bearer {token}",
"Content-Type": "application/json",
}
def _make_request(self, endpoint: str, data: Dict[str, Any]) -> Dict[str, Any]:
"""Make a POST request to Milvus API"""
url = f"{self.base_url}{endpoint}"
# Add dbName if not already in data and not default
if "dbName" not in data and self.db_name != "default":
data["dbName"] = self.db_name
try:
response = requests.post(url, json=data, headers=self.headers)
response.raise_for_status()
except requests.exceptions.HTTPError as e:
print(f"e.response.text: {e.response.content}")
raise e
result = response.json()
# Check for API errors
if result.get("code") != 0:
raise Exception(
f"Milvus API Error: {result.get('message', 'Unknown error')}"
)
return result
def has_collection(self, collection_name: str) -> bool:
"""
Check if a collection exists
Reference: https://milvus.io/api-reference/restful/v2.6.x/v2/Collection%20(v2)/Has.md
"""
try:
result = self._make_request(
"/v2/vectordb/collections/has", {"collectionName": collection_name}
)
return result.get("data", {}).get("has", False)
except Exception:
return False
def drop_collection(self, collection_name: str):
"""
Drop a collection
Reference: https://milvus.io/api-reference/restful/v2.6.x/v2/Collection%20(v2)/Drop.md
"""
return self._make_request(
"/v2/vectordb/collections/drop", {"collectionName": collection_name}
)
def create_schema(self) -> CollectionSchema:
"""Create a new collection schema"""
return CollectionSchema()
def prepare_index_params(self) -> IndexParams:
"""Create index parameters"""
return IndexParams()
def create_collection(
self,
collection_name: str,
schema: CollectionSchema,
index_params: Optional[IndexParams] = None,
):
"""
Create a collection
Reference: https://milvus.io/api-reference/restful/v2.6.x/v2/Collection%20(v2)/Create.md
"""
data = {"collectionName": collection_name, "schema": schema.to_dict()}
if index_params:
data["indexParams"] = index_params.to_list()
return self._make_request("/v2/vectordb/collections/create", data)
def describe_collection(self, collection_name: str) -> Dict[str, Any]:
"""
Describe a collection
Reference: https://milvus.io/api-reference/restful/v2.6.x/v2/Collection%20(v2)/Describe.md
"""
result = self._make_request(
"/v2/vectordb/collections/describe", {"collectionName": collection_name}
)
return result.get("data", {})
def insert(
self,
collection_name: str,
data: List[Dict[str, Any]],
partition_name: Optional[str] = None,
):
"""
Insert data into a collection
Reference: https://milvus.io/api-reference/restful/v2.6.x/v2/Vector%20(v2)/Insert.md
"""
payload = {"collectionName": collection_name, "data": data}
if partition_name:
payload["partitionName"] = partition_name
result = self._make_request("/v2/vectordb/entities/insert", payload)
return result.get("data", {})
def flush(self, collection_name: str):
"""
Flush collection data to storage
Reference: https://milvus.io/api-reference/restful/v2.6.x/v2/Collection%20(v2)/Flush.md
"""
return self._make_request(
"/v2/vectordb/collections/flush", {"collectionName": collection_name}
)
def search(
self,
collection_name: str,
data: List[List[float]],
anns_field: str,
limit: int = 10,
search_params: Optional[Dict[str, Any]] = None,
output_fields: Optional[List[str]] = None,
) -> List[List[Dict]]:
"""
Search for vectors
Reference: https://milvus.io/api-reference/restful/v2.6.x/v2/Vector%20(v2)/Search.md
"""
payload = {
"collectionName": collection_name,
"data": data,
"annsField": anns_field,
"limit": limit,
}
if search_params:
payload["searchParams"] = search_params
if output_fields:
payload["outputFields"] = output_fields
result = self._make_request("/v2/vectordb/entities/search", payload)
return result.get("data", [])
1. Create a collection with schemaβ
Note: Use the /milvus endpoint for the passthrough api that uses the milvus provider in your config.
from milvus_rest_client import MilvusRESTClient, DataType # Use the client from above
import random
import time
# Configuration
uri = "http://0.0.0.0:4000/milvus" # IMPORTANT: Use the '/milvus' endpoint for passthrough
token = "sk-my-virtual-key"
collection_name = "dall-e-6" # Virtual index name
# Initialize client
milvus_client = MilvusRESTClient(uri=uri, token=token)
print(f"Connected to DB: {uri} successfully")
# Check if the collection exists and drop if it does
check_collection = milvus_client.has_collection(collection_name)
if check_collection:
milvus_client.drop_collection(collection_name)
print(f"Dropped the existing collection {collection_name} successfully")
# Define schema
dim = 64 # Vector dimension
print("Start to create the collection schema")
schema = milvus_client.create_schema()
schema.add_field(
"book_id", DataType.INT64, is_primary=True, description="customized primary id"
)
schema.add_field("word_count", DataType.INT64, description="word count")
schema.add_field(
"book_intro", DataType.FLOAT_VECTOR, dim=dim, description="book introduction"
)
# Prepare index parameters
print("Start to prepare index parameters with default AUTOINDEX")
index_params = milvus_client.prepare_index_params()
index_params.add_index("book_intro", metric_type="L2")
# Create collection
print(f"Start to create example collection: {collection_name}")
milvus_client.create_collection(
collection_name, schema=schema, index_params=index_params
)
collection_property = milvus_client.describe_collection(collection_name)
print("Collection details: %s" % collection_property)
2. Insert data into the collectionβ
# Insert data with customized ids
nb = 1000
insert_rounds = 2
start = 0 # first primary key id
total_rt = 0 # total response time for insert
print(
f"Start to insert {nb*insert_rounds} entities into example collection: {collection_name}"
)
for i in range(insert_rounds):
vector = [random.random() for _ in range(dim)]
rows = [
{"book_id": i, "word_count": random.randint(1, 100), "book_intro": vector}
for i in range(start, start + nb)
]
t0 = time.time()
milvus_client.insert(collection_name, rows)
ins_rt = time.time() - t0
start += nb
total_rt += ins_rt
print(f"Insert completed in {round(total_rt, 4)} seconds")
# Flush the collection
print("Start to flush")
start_flush = time.time()
milvus_client.flush(collection_name)
end_flush = time.time()
print(f"Flush completed in {round(end_flush - start_flush, 4)} seconds")
3. Search the collectionβ
# Search configuration
nq = 3 # Number of query vectors
search_params = {"metric_type": "L2", "params": {"level": 2}}
limit = 2 # Number of results to return
# Perform searches
for i in range(5):
search_vectors = [[random.random() for _ in range(dim)] for _ in range(nq)]
t0 = time.time()
results = milvus_client.search(
collection_name,
data=search_vectors,
limit=limit,
search_params=search_params,
anns_field="book_intro",
)
t1 = time.time()
print(f"Search {i} results: {results}")
print(f"Search {i} latency: {round(t1-t0, 4)} seconds")
Complete Exampleβ
Here's a full working example:
from milvus_rest_client import MilvusRESTClient, DataType # Use the client from above
import random
import time
# ----------------------------
# π CONFIGURATION
# ----------------------------
uri = "http://0.0.0.0:4000/milvus" # IMPORTANT: Use the '/milvus' endpoint
token = "sk-my-virtual-key"
collection_name = "dall-e-6" # Your virtual index name
# ----------------------------
# π STEP 1 β Initialize Client
# ----------------------------
milvus_client = MilvusRESTClient(uri=uri, token=token)
print(f"β
Connected to DB: {uri} successfully")
# ----------------------------
# ποΈ STEP 2 β Drop Existing Collection (if needed)
# ----------------------------
check_collection = milvus_client.has_collection(collection_name)
if check_collection:
milvus_client.drop_collection(collection_name)
print(f"ποΈ Dropped the existing collection {collection_name} successfully")
# ----------------------------
# π STEP 3 β Create Collection Schema
# ----------------------------
dim = 64 # Vector dimension
print("π Creating the collection schema")
schema = milvus_client.create_schema()
schema.add_field(
"book_id", DataType.INT64, is_primary=True, description="customized primary id"
)
schema.add_field("word_count", DataType.INT64, description="word count")
schema.add_field(
"book_intro", DataType.FLOAT_VECTOR, dim=dim, description="book introduction"
)
# ----------------------------
# π STEP 4 β Create Index
# ----------------------------
print("π Preparing index parameters with default AUTOINDEX")
index_params = milvus_client.prepare_index_params()
index_params.add_index("book_intro", metric_type="L2")
# ----------------------------
# ποΈ STEP 5 β Create Collection
# ----------------------------
print(f"ποΈ Creating collection: {collection_name}")
milvus_client.create_collection(
collection_name, schema=schema, index_params=index_params
)
collection_property = milvus_client.describe_collection(collection_name)
print(f"β
Collection created: {collection_property}")
# ----------------------------
# π€ STEP 6 β Insert Data
# ----------------------------
nb = 1000
insert_rounds = 2
start = 0
total_rt = 0
print(f"π€ Inserting {nb*insert_rounds} entities into collection")
for i in range(insert_rounds):
vector = [random.random() for _ in range(dim)]
rows = [
{"book_id": i, "word_count": random.randint(1, 100), "book_intro": vector}
for i in range(start, start + nb)
]
t0 = time.time()
milvus_client.insert(collection_name, rows)
ins_rt = time.time() - t0
start += nb
total_rt += ins_rt
print(f"β
Insert completed in {round(total_rt, 4)} seconds")
# ----------------------------
# πΎ STEP 7 β Flush Collection
# ----------------------------
print("πΎ Flushing collection")
start_flush = time.time()
milvus_client.flush(collection_name)
end_flush = time.time()
print(f"β
Flush completed in {round(end_flush - start_flush, 4)} seconds")
# ----------------------------
# π STEP 8 β Search
# ----------------------------
nq = 3
search_params = {"metric_type": "L2", "params": {"level": 2}}
limit = 2
print(f"π Performing {5} search operations")
for i in range(5):
search_vectors = [[random.random() for _ in range(dim)] for _ in range(nq)]
t0 = time.time()
results = milvus_client.search(
collection_name,
data=search_vectors,
limit=limit,
search_params=search_params,
anns_field="book_intro",
)
t1 = time.time()
print(f"β
Search {i} results: {results}")
print(f" Search {i} latency: {round(t1-t0, 4)} seconds")
How It Worksβ
When you search:
- LiteLLM converts your query to a vector using the embedding model you specified
- It sends the vector to your Milvus instance via the
/v2/vectordb/entities/searchendpoint - Milvus finds the most similar documents in your collection using vector similarity search
- Results come back with distance scores
The embedding model can be any model supported by LiteLLM - Azure OpenAI, OpenAI, Bedrock, etc.