跳到主要内容
版本：BYOC 开发指南

安装 SDK

本文介绍如何安装 Milvus SDK，以连接到 Zilliz Cloud 集群。

Zilliz Cloud 提供托管式 Milvus 向量数据库服务。您可以按需安装以下语言的 SDK 以连接到集群：Python、Java、Go 或 Node.js。

📘说明

  • Zilliz Cloud 会定期将您的集群升级到可兼容的最新版本。更多信息，请参见设置运维窗口。升级后如果您无法使用最新版本的 SDK 连接到集群，请按照提示降级 SDK 到其他可兼容版本。运维完成后，我们会发送邮件通知，之后您便可以安全地升级 SDK。

  • 下列所有 SDK 均提供了稳定版和 Beta 版，分别对应稳定版和 Beta 版集群。如果您将集群升级到了 Beta 版本，请同步升级您的 SDK 版本。

SDK 兼容性​

下表罗列了各个 Milvus 版本对应的兼容 SDK 版本。

Milvus 版本

Python SDK

Node.js SDK

Java SDK

Go SDK

2.6.x

2.6.9

2.6.10

2.6.14

2.6.2

2.5.x

2.5.18

2.5.13

2.5.15

2.5.6

安装 PyMilvus：Python SDK​

PyMilvus 是 Milvus 的 Python SDK。您可以在 GitHub 上找到相关源代码。

📘说明

安装前，请确保您的 Python 版本在 3.8 以上。

执行以下命令，安装 PyMilvus：

# Install pymilvus compatible with Milvus v2.5.x
python -m pip install pymilvus==2.5.18

# Update PyMilvus to the newest version
python -m pip install --upgrade pymilvus

# Verify installation success
python -m pip list | grep pymilvus

如果您的集群兼容 Milvus v2.6.x 的公测版本，请将上述版本号由 2.5.18 修改为 2.6.9。

安装 Node.js SDK​

要使用 Node.js SDK，建议您使用 npm（Node 包管理器）或 yarn 在项目中安装相关依赖。您可以在 GitHub 上找到相关源代码。

📘说明

安装前，请确保您的 Node.js 版本在 14 以上。

# Install Node.js SDK compatible with Milvus v2.5.x
npm install @zilliz/milvus2-sdk-node@2.5.13
# Alternatively,
yarn add @zilliz/milvus2-sdk-node@2.5.13

# Upgrade to the latest version
npm update @zilliz/milvus2-sdk-node
# Alternatively,
yarn upgrade @zilliz/milvus2-sdk-node

# Verify installation
npm list | grep @zilliz/milvus2-sdk-node
# or
yarn list | grep @zilliz/milvus2-sdk-node

您可以将 SDK 以 CommonJS 模块或 ES6 模块导入到项目中。一般而言，对于使用npm init创建的项目，可以将 SDK 以 CommonJS 模块导入；对于使用npm init es6创建的项目，可以将 SDK 以 ES6 模块导入。

// Import the SDK as a CommonJS module
const { MilvusClient } = require("@zilliz/milvus2-sdk-node")

// Import the SDK as a ES6 module
import { MilvusClient } from "@zilliz/milvus2-sdk-node"

如果您的集群兼容 Milvus v2.6.x 的公测版本，请将上述版本号由 2.5.13 修改为 2.6.4。

安装 Java SDK​

您可以使用 Apache Maven 或 Gradle / Grails 下载 Java SDK。您可以在 GitHub 找到相关源代码。

  • Apache Maven

    只需将以下依赖项添加到 pom.xml：

    <!-- Install Java SDK compatible with Milvus v2.5.x -->
    <dependency>
         <groupId>io.milvus</groupId>
         <artifactId>milvus-sdk-java</artifactId>
         <version>2.5.15</version>
     </dependency>

  • Gradle / Grails

    在 Shell 中执行以下命令：

    # Install Java SDK compatible with Milvus v2.5.x
    compile 'io.milvus:milvus-sdk-java:2.5.15'

如果您的集群兼容 Milvus v2.6.x 的公测版本，请将上述版本号由 2.5.15 修改为 2.6.14。

安装 Go SDK​

您可以通过 go get 安装 Go SDK。您可以在 GitHub 找到相关源代码。

# Install Go SDK compatible with Milvus v2.5.x
go get -u github.com/milvus-io/milvus-sdk-go/v2@v2.5.6

如果您的集群兼容 Milvus v2.6.x 的公测版本，请将上述版本号由 2.5.6 修改为 2.6.2。