@anvia/milvus 1.1.4 → 1.1.5

package/README.md

@@ -0,0 +1,68 @@
+# @anvia/milvus
+
+Store and search Anvia documents in Milvus. Pair the store with your choice of
+embedding model to add semantic retrieval to agents and applications.
+
+## Install
+
+```sh
+pnpm add @anvia/milvus @anvia/core @anvia/openai
+```
+
+`@anvia/openai` supplies the embedding model in this example; other embedding adapters work too.
+
+## Quickstart
+
+Start Milvus at `localhost:19530` and set `OPENAI_API_KEY`.
+
+```ts
+import { embedDocuments } from "@anvia/core/embeddings";
+import { retrieveDocuments } from "@anvia/core/vector-store";
+import { OpenAIClient } from "@anvia/openai";
+import { MilvusVectorClient } from "@anvia/milvus";
+
+const openai = new OpenAIClient({ apiKey: process.env.OPENAI_API_KEY! });
+const model = openai.embeddingModel({ modelId: "text-embedding-3-small" });
+const client = new MilvusVectorClient({ address: "localhost:19530" });
+const store = client.vectorStore<{ id: string; text: string }>({
+  collectionName: "support_docs",
+  dimensions: 1536,
+  metric: "cosine",
+});
+
+try {
+  await store.ensure();
+  const { documents } = await embedDocuments({
+    model,
+    documents: [{ id: "password-reset", text: "Reset links expire after 30 minutes." }],
+    id: (document) => document.id,
+    content: (document) => document.text,
+  });
+  await store.upsert({ documents });
+
+  const results = await retrieveDocuments({
+    store,
+    model,
+    query: "How long does a reset link last?",
+    topK: 3,
+  });
+  console.log(results);
+} finally {
+  await client.close();
+}
+```
+
+## Store capabilities
+
+- Explicit provisioning with `ensure()` and readiness checks with `validate()`.
+- Document replacement, vector search, and metadata filtering.
+- Bring your own embedding model; `store.search()` accepts vectors directly.
+
+Configure `address` and optional `token`, or supply a caller-owned native client.
+
+Pass `client` to use a preconfigured native SDK client. Injected clients remain caller-owned.
+
+## Learn more
+
+- [Anvia overview](https://github.com/anvia-hq/anvia/blob/main/README.md)
+- [Contributing](https://github.com/anvia-hq/anvia/blob/main/CONTRIBUTING.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anvia/milvus",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "Milvus vector store adapter for Anvia.",
   "author": "anvia",
   "license": "MIT",
@@ -32,10 +32,10 @@
     "tsup": "^8.5.0",
     "typescript": "^5.9.3",
     "vitest": "^4.1.11",
-    "@anvia/core": "1.5.0"
+    "@anvia/core": "1.6.1"
   },
   "peerDependencies": {
-    "@anvia/core": "^1.5.0"
+    "@anvia/core": "^1.6.1"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm --dts --sourcemap --clean",