Milvus2-sdk-node

The official Milvus client for Node.js.

📚 Documentation

👉 View Full Documentation

For complete documentation, API reference, guides, and examples, please visit our documentation site.

Compatibility

The following table shows the recommended @zilliz/milvus2-sdk-node versions for different Milvus versions:

| Milvus version | Node sdk version | Installation | | :------------: | :--------------: | :----------------------------------------- | | v2.6.0+ | latest | yarn add @zilliz/milvus2-sdk-node@latest | | v2.5.0+ | v2.5.0 | yarn add @zilliz/[email protected] | | v2.4.0+ | v2.4.9 | yarn add @zilliz/[email protected] | | v2.3.0+ | v2.3.5 | yarn add @zilliz/[email protected] | | v2.2.0+ | v2.3.5 | yarn add @zilliz/[email protected] |

Dependencies

• Milvus
• Zilliz Cloud
• Node: v18+

Installation

npm install @zilliz/milvus2-sdk-node
# or
yarn add @zilliz/milvus2-sdk-node

Quick Start

import { MilvusClient } from '@zilliz/milvus2-sdk-node';

const client = new MilvusClient({
  address: 'localhost:19530',
});

await client.connectPromise;

For more examples and detailed usage, see the documentation.

Contributing

1. yarn install
2. Fetch milvus proto
   • git submodule init (if this is your first time)
   • git submodule update --remote
3. Add feature in milvus folder
4. Run test yarn test -- test/Your-test-for-your-feature.spec.ts

Links

• Documentation
• Milvus Official Website
• GitHub Repository