搜索

This operation conducts a vector similarity search with an optional scalar filtering expression.

POST

/v2/vectordb/entities/search

集群 Endpoint

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

📘说明

• 你需要填入您的 Zilliz Cloud 集群的 ${CLUSTER_ENDPOINT}。
• 您可以参考 On Zilliz Cloud 控制台或使用 查看集群详情 V2 来获取集群的 Endpoint.

export CLUSTER_ENDPOINT=""

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 username:password。

示例值：Bearer {{TOKEN}}

请求体application/json

collectionNamestring必填项

当前操作的目标 Collection 名称。

dataarrayrequired

一个向量嵌入列表。 Zilliz Cloud 会搜索与指定向量嵌入最相似的向量。

[]datanumber<float32>

一个向量嵌入。

annsFieldstring必填项

向量字段名称。

filterstring

在检索结果中根据标量字段进行过滤的表达式。

limitinteger

需要在搜索结果中返回的 Entity 数量。 您可以使用此参数与 offset 参数结合使用以实现分页。 此值与 offset 参数之和不应超过 16,384。

offsetinteger

需要在搜索结果中跳过的 Entity 数量。 您可以使用此参数与 limit 参数结合使用以实现分页。 此值与 limit 参数之和不应超过 16,384。

groupingFieldstring

充当分组聚合条件的字段名称。

outputFieldsarray

需要在搜索结果中包含的字段名称列表。

[]outputFieldsstring

字段名称

searchParamsobject

当前操作的附加参数。

metricTypestring

当前操作使用的相似度度量类型。该值应与目标 Collection 的度量类型相同。

枚举值：

L2IPCOSINE

paramsobject

其它附加参数。

radiusinteger

确定最低相似度阈值。当设置 metrictype 为 L2 时，请确保该值大于 rangefilter 的值。否则，该值应小于 range_filter 的值。

range_filterinteger

优化搜索结果的相似度范围。当设置 metric_type 为 IP 或 COSINE 时，请确保该值大于 radius 的值。否则，该值应小于 radius 的值。

partitionNamesarray

一个 Partition 名称列表。设置此参数表示搜索仅限于指定的 Partition。否则，搜索会在 Collection 中搜索所有 Partition。

[]partitionNamesstring

一个 Partition 名称。

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/search" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "quick_setup",
    "data": [
        [
            0.3580376395471989,
            -0.6023495712049978,
            0.18414012509913835,
            -0.26286205330961354,
            0.9029438446296592
        ]
    ],
    "annsField": "vector",
    "limit": 3,
    "outputFields": [
        "color"
    ]
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataarray

搜索结果，为一组 Entity 对象。

[]dataobject

An entity object.

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": [
        {
            "color": "orange_6781",
            "distance": 1,
            "id": 448300048035776800
        },
        {
            "color": "red_4794",
            "distance": 0.9353201,
            "id": 448300048035776800
        },
        {
            "color": "grey_8510",
            "distance": 0.7733054,
            "id": 448300048035776800
        }
    ]
}