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

Primary Key Search

在相似性搜索时，您通常需要提供一个或多个查询向量，无论这些查询向量是否已经存在于您的 Collection 中。为了避免在搜索前从 Collection 中获取需要的查询向量，您可以考虑使用主键搜索（Primary Key Search）。

概述​

在电商平台上购物时，用户通常会输入一个关键词让平台返回一些与该关键词相关的商品。当用户浏览其中某件商品的详情页时，在该页末尾还会推荐一些和当前商品相似的其它商品，供用户比较。

推荐商品是按照与关键词或当前商品的相似度排序的。为了实现上述功能，平台开发人员需要先根据关键词或用户浏览的当前商品获取对应的向量表示，然后再使用这些向量表示来进行相似性搜索。这样既增加了电商平台和 Milvus 之间的信息往返次数，还导致大量的高维数据在网络中传输。

为了简化与电商平台类似的应用与 Milvus 之间的交互逻辑，降低信息往返次数，避免在网络中传输大量高维数据，Milvus 推出了主键搜索。

在主键搜索中，您无需提供查询向量。只用提供包含查询向量的 Entity 的主键（ids）即可。

使用限制​

  • 除了使用 BM25 Function 从 VarChar 字段派生出的稀疏向量字段外，主键搜索适用于所有其它类型的向量数据。

  • 您可以使用 Entity 的主键代替该 Entity 中的指定字段中的查询向量进行 Filtered Search，Range Search 和 Grouping Search，并在这些搜索中选择性地启用搜索结果分页能力。但是，在多向量混合搜索和 Search Iterator 中不能使用主键代替查询向量。

  • 对于涉及 Embedding List 的查询，您仍然需要先从 Collection 中获取对应的向量，将它们组织成 Embedding List，然后再进行查询。

  • 对于 Collection 中不存在的主键或使用了不正确的数据类型进行查询，Milvus 均会报错。

  • 在查询请求中，主键和查询向量互斥。同时提供两者将会导致错误。

示例​

如果示例假设目标 Collection 的主键为 Int64 格式。

📘说明

在主键查询中，主键仅用来获取对应 Entity 指定字段上的向量，不会基于主键进行过滤。

在执行基本主键搜索时，您需要将查询向量替换为 Collection 中包含该查询向量的 Entity 主键。

from pymilvus import MilvusClient

client = MilvusClient(
    uri="YOUR_CLUSTER_ENDPOINT",
    token="YOUR_CLUSTER_TOKEN"
)

res = client.search(
    collection_name="my_collection",
    anns_field="vector",
    # highlight-start
    ids=[551, 296, 43], # a list of primary keys
    # highlight-end
    limit=3,
    search_params={"metric_type": "IP"}
)

for hits in res:
    for hit in hits:
        print(hit)

示例 2：使用主键进行 Filtered Search​

如下示例假设目标 Collection 的 Schema 中定义了 color 和 likes 两个字段。

res = client.search(
    collection_name="my_collection",
    # highlight-start
    ids=[551, 296, 43], #
    filter='color like "red%" and likes > 50',
    output_fields=["color", "likes"],
    # highlight-end
    limit=3,
)

示例 3：使用主键进行 Range Search​

res = client.search(
    collection_name="my_collection",
    # highlight-start
    ids=[551, 296, 43],
    # highlight-end
    limit=3,
    search_params={
        # highlight-start
        "params": {
            "radius": 0.4,
            "range_filter": 0.6
        }
        # highlight-end
    }
)

示例 4：使用主键进行 Grouping Search​

如下示例假设目标 Collection 的 Schema 中字义了一个名为 docId 的字段。

res = client.search(
    collection_name="my_collection",
    # highlight-start
    ids=[551, 296, 43],
    # highlight-end
    limit=3,
    group_by_field="docId",
    output_fields=["docId"]
)