Milvus 基本操作

该页面将向您展示如何使用 Python SDK 运行 Milvus 基本操作。关于详细的 API 参考信息，请参考 Python API 文档。

您也可以使用其它客户端，例如 Java, C++, Go, 或 RESTful.

注意：建议您使用资源评估工具来估算数据所需的硬件资源。

连接 Milvus 服务端

1. 导入 pymilvus。

   # Import pymilvus
   >>> from milvus import Milvus, IndexType, MetricType, Status

2. 使用以下任意一种方法连接 Milvus 服务端：

   # Connect to Milvus server
   >>> milvus = Milvus()
   >>> milvus.connect(host='localhost', port='19530')

   注意：在上面的代码中，host 和 port 都使用了默认值。您可以将其更改为自己设定的 IP 地址和端口。

   >>> milvus.connect(uri='tcp://localhost:19530')

创建/删除 collection

创建 collection

1. 准备创建 collection 所需参数。

   # Prepare collection parameters
   >>> param = {'collection_name':'test01', 'dimension':256, 'index_file_size':1024, 'metric_type':MetricType.L2}

2. 创建 collection 名为 test01， 维度为 256， 自动创建索引的数据文件大小为 1024 MB，距离度量方式为欧氏距离（L2）的 collection 。

   # Create a collection
   >>> milvus.create_collection(param)

获取 collection 的统计信息

您可以调用如下接口查询 collection 的统计信息。查询结果的信息包含 collection /分区/ segment 的向量数量，存储使用量等信息。

>>> milvus.collection_info('test01')

注意：参考示例程序获取更详细的使用方式。

删除 collection

# Drop collection
>>> milvus.drop_collection(collection_name='test01')

在 collection 中创建/删除分区

创建分区

您可以通过标签将 collection 分割为若干个分区，从而提高搜索效率。每个分区实际上也是一个 collection 。

# Create partition
>>> milvus.create_partition('test01', 'tag01')

删除分区

>>> milvus.drop_partition(collection_name='test01', partition_tag='tag01')

在 collection 中创建/删除索引

创建索引

注意：在实际生产环境中，建议在插入向量之前先创建索引，以便系统自动增量创建索引。需要注意的是，在向量插入结束后，相同的索引需要手动再创建一次（因为可能存在大小不满足 index_file_size 的数据文件，系统不会为该文件自动创建索引）。更多索引的用法请参考 索引示例程序。

1. 准备创建索引所需参数(以 IVF_FLAT 为例)。索引参数是一个 JSON 字符串，在 Python SDK 中以字典来表示。

   # Prepare index param
   >>> ivf_param = {'nlist': 16384}

   注意：对于不同的索引类型，创建索引所需参数也有区别。所有的索引参数都必须赋值。

关于详细信息请参考 Milvus 索引类型。

1. 为 collection 创建索引。

   # Create index
   >>> milvus.create_index('test01', IndexType.IVF_FLAT, ivf_param)

删除索引

>>> milvus.drop_index('test01')

在 collection /分区中插入/删除向量

在 collection 中插入向量

1. 使用 random 函数生成 20 个 256 维的向量。

   >>> import random
   # Generate 20 vectors of 256 dimension
   >>> vectors = [[random.random() for _ in range(dim)] for _ in range(20)]

2. 插入向量列表。如果您不指定向量 ID，Milvus 自动为向量分配 ID。

   # Insert vectors
   >>> milvus.insert(collection_name='test01', records=vectors)

   您也可以自己定义向量 ID：

   >>> vector_ids = [id for id in range(20)]
   >>> milvus.insert(collection_name='test01', records=vectors, ids=vector_ids)

在分区中插入向量

>>> milvus.insert('test01', vectors, partition_tag="tag01")

您可以通过 get_vector_by_id() 验证已经插入的向量。此处验证插入的第一条向量。这里假设您的 collection 中存在以下向量 ID：

>>> status, vector = milvus.get_vector_by_id(collection_name='test01', vector_id=0)

通过 ID 删除向量

假设您的 collection 中存在以下向量 ID：

>>> ids = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]

您可以通过以下命令删除向量：

>>> milvus.delete_by_id(collection_name='test01', id_array=ids)

注意：目前删除向量操作仅支持在 CPU 上运行的 FLAT、IVFLAT、IVFSQ8 等索引类型。对于其他索引类型，即使执行了删除向量操作，再次搜索时也可以找到被删除的向量。

通过 ID 获取向量

您也可以根据向量 ID 获取向量， 目前仅支持一次获取单条向量，暂不支持批量获取：

>>> status, vector = milvus.get_vector_by_id(collection_name='test01', vector_id=ids[0])

将 collection 中的数据进行 flush 操作

当您在进行有关数据更改的操作时，您可以将 collection 中的数据从内存中进行 flush 操作以避免数据丢失。Milvus 也支持自动 flush。自动 flush 会在固定的时间周期将所有现存 collection 的数据进行 flush 操作。您可以通过 Milvus 服务端配置文件来设置自动 flush 的时间间隔。

>>> milvus.flush(collection_name_array=['test01'])

对 collection 中的 segment 进行 compact 操作

Segment 是 Milvus 自动将插入的向量数据合并所获得的数据文件。一个 collection 可包含多个 segment 。如果一个 segment 中的向量数据被删除，被删除的向量数据占据的空间并不会自动释放。您可以对 collection 中的 segment 进行 compact 操作以释放多余空间。

>>> milvus.compact(collection_name='test01', timeout='1')

获取 segment 中的向量 ID

您可以获取指定 segment 中向量 ID 信息。您需要提供 segment 的名称。 segment 的名称可以从 collection_info 中获取。

>>> milvus.get_vector_ids('test01', '1583727470444700000')

在 collection /分区中搜索向量

在 collection 中搜索向量

1. 创建搜索参数。搜索参数是一个 JSON 字符串，在 Python SDK 中以字典来表示。

   >>> search_param = {'nprobe': 16}

   注意：对于不同的索引类型，搜索所需参数也有区别。所有的搜索参数都必须赋值。

注意：top_k 是与目标向量最相似的 k 条向量，在搜索时定义。top_k 的取值范围是 (0, 2048]。

1. 创建随机向量作为 query_records 进行搜索。

   # create 5 vectors of 32-dimension
   >>> q_records = [[random.random() for _ in range(dim)] for _ in range(5)]
   >>> milvus.search(collection_name='test01', query_records=q_records, top_k=2, params=search_param)

在分区中搜索向量

# create 5 vectors of 32-dimension
>>> q_records = [[random.random() for _ in range(dim)] for _ in range(5)]
>>> milvus.search(collection_name='test01', query_records=q_records, top_k=1, partition_tags=['tag01'], params=search_param)

注意：如果您不指定 partition_tags， Milvus 会在整个 collection 中搜索。

与 Milvus 服务端断开连接

>>> milvus.disconnect()

接下来您可以

• 体验 Milvus 在线训练营 了解更多解决方案
• 故障诊断 API 行为