Milvus 基本操作

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

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

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

连接 Milvus 服务端

  1. 导入 pymilvus。

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

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

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

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

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

创建/删除 collection

创建 collection

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

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

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

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

获取 collection 的统计信息

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

  1. >>> milvus.get_collection_stats('test01')

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

删除 collection

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

在 collection 中创建/删除分区

创建分区

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

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

删除分区

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

在 collection 中创建/删除索引

创建索引

目前，一个集合只支持一种索引类型，切换索引类型会自动删除旧的索引文件。在创建其它索引前，FLAT作为集合的默认索引类型。

注意：create_index() 会指定该集合的索引类型，并同步为之前插入的数据建立索引，后续插入的数据在大小达到 index_file_size 时，索引会在后台自动建立。在实际生产环境中，如果是流式数据，建议在插入向量之前先创建索引，以便后续系统自动建立；如果是静态数据，建议所有数据导入后再一次性创建。更多索引用法请参考 索引示例程序。

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

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

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

索引类型 索引参数 示例参数 取值范围
IVFLAT / SQ8/ SQ8H nlist：建立索引时对向量数据文件进行聚类运算的分簇数。索引文件会记录聚类运算后的结果，包括索引的类型，每个簇的中心向量，以及每个簇分别有哪些向量，以便于后期搜索。 {nlist: 16384} nlist：[1, 999999]
IVFPQ nlist：建立索引时对向量数据文件进行聚类运算的分簇数。索引文件会记录聚类运算后的结果，包括索引的类型，每个簇的中心向量，以及每个簇分别有哪些向量，以便于后期搜索。

m：建立索引时数据的压缩率。m 越小压缩率越高。		 {nlist: 16384, m: 12} nlist：[1, 999999]

m: {96, 64, 56, 48, 40, 32, 28, 24, 20, 16, 12, 8, 4, 3, 2, 1} 中的值
NSG search_length：值越大，代表在图中搜索的节点越多，召回率越高，但速度也越慢。建议 search_length 小于 candidate_pool 的值，取值范围建议在 [40, 80]。

out_degree：值越大，则占用内存越大，搜索性能也越好。

candidate_pool：影响索引质量，建议取值范围 [200,500]。
knng：影响索引质量，建议取值为 out_degree + 20.		 {search_length: 45, out_degree:50, candidate_pool_size:300, knng:100} search_length range: [10, 300]

out_degree: [5, 300]

candidate_pool_size: [50, 1000]

knng: [5, 300]
HNSW M：影响 build 的时间以及索引的质量。 M 越大，构建索引耗时越长，索引质量越高，内存占用也越大。

efConstruction：影响 build 的时间以及索引的质量。 efConstruction 越大，构建索引耗时越长，索引质量越高，内存占用也越大。		 {M: 16, efConstruction:500} M :[5, 48]
efConstruction :[100, 500]
ANNOY n_trees: 影响建立索引的时间和索引大小。值越大，搜索结果越精确，但索引越大。 {"n_trees": 8} [1, 1024]

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

2. 为 collection 创建索引。

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

删除索引

删除索引后，集合再次使用默认索引类型FLAT。

  1. >>> milvus.drop_index('test01')

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

在 collection 中插入向量

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

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

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

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

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

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

在分区中插入向量

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

通过 ID 删除向量

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

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

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

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

通过 ID 获取向量

您也可以根据向量 ID 获取向量：

  1. >>> status, vector = milvus.get_entity_by_id(collection_name='test01', ids=ids[:10])

将 collection 中的数据进行 flush 操作

当您在进行有关数据更改的操作时，您可以将 collection 中的数据从内存中进行 flush 操作使数据落盘。Milvus 也会执行自动 flush。自动 flush 会在固定的时间周期（1 秒）将所有现存 collection 的数据进行 flush 操作。

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

对 collection 中的 segment 进行 compact 操作

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

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

获取 segment 中的向量 ID

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

  1. >>> milvus.list_id_in_segment('test01', '1583727470444700000')

在 collection /分区中搜索向量

在 collection 中搜索向量

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

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

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

索引类型 搜索参数 示例参数 取值范围
FLAT - -
IVFLAT/SQ8/SQ8H/IVFPQ nprobe：查询时所涉及的向量类的个数。nprobe 影响查询精度。数值越大，精度越高，速度越慢。 {nprobe: 32} [1, nlist]
NSG search_length：值越大，代表在图中搜索的节点越多，召回率越高，速度越慢。 {search_length:100} [10, 300]
HNSW ef：值越大，则在索引中搜索的数据越多，召回率越高，速度越慢。 {ef: 64} [topk, 4096]
ANNOY search_k: 影响搜索性能。值越大，搜索结果越精确，但搜索时间越长。
-1表示默认值，取总数据量的5%。		 {"search_k": -1} {-1} ∪ [topk, ∞)

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

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

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

在分区中搜索向量

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

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

关闭客户端

  1. >>> milvus.close()

接下来您可以