搜索
该 API 的 Base URL 格式如下：
https://${CLUSTER_ENDPOINT}
- 你需要填入您的 Zilliz Cloud 集群的
${CLUSTER_ENDPOINT}。 - 您可以使用 查看集群详情 V2 来获取集群的 Endpoint.
export CLUSTER_ENDPOINT=""
认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 username:password。
数据库名称。
当前操作的目标 Collection 名称。
一个向量嵌入列表。 Zilliz Cloud 会搜索与指定向量嵌入最相似的向量。
一个向量嵌入。
向量字段名称。
在检索结果中根据标量字段进行过滤的表达式。
对搜索结果进行分组，以确保结果的多样性，并避免返回来自同一组的多个结果。
每个组返回的 Entity 数量。该参数仅在 groupingField 被指定时有效。
是否仅返回每个组的前 k 个 Entity。该参数仅在 groupingField 被指定时有效。
需要在搜索结果中返回的 Entity 数量。 您可以使用此参数与 offset 参数结合使用以实现分页。 此值与 offset 参数之和不应超过 16,384。
需要在搜索结果中跳过的 Entity 数量。 您可以使用此参数与 limit 参数结合使用以实现分页。 此值与 limit 参数之和不应超过 16,384。
需要在搜索结果中包含的字段名称列表。
字段名称
当前操作的附加参数。
当前操作使用的相似度度量类型。该值应与目标 Collection 的度量类型相同。
其它附加参数。
确定最低相似度阈值。当设置 metrictype 为 L2 时，请确保该值大于 rangefilter 的值。否则，该值应小于 range_filter 的值。
优化搜索结果的相似度范围。当设置 metric_type 为 IP 或 COSINE 时，请确保该值大于 radius 的值。否则，该值应小于 radius 的值。
一个 Partition 名称列表。设置此参数表示搜索仅限于指定的 Partition。否则，搜索会在 Collection 中搜索所有 Partition。
一个 Partition 名称。
当前搜索操作的一致性级别。
A set of key-value pairs that can be filled back in to the filter parameter to enable filtering templating. For details, refer to Filter Templating.
当前搜索请求的 Function 设置。
待应用的 Function 名称。
待应用的 Function 描述。
待应用的 Function 类型。
作为 Function 输入的标量字段名称列表。
作为 Function 输入的一个标量字段名称。
作为 Function 输出的向量字段名称列表。
作为 Function 输出的一个向量字段名称。
Function 附加参数，以键值对形式提供。
搜索附加参数，以键值对形式提供。
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"
]
}'
响应码。
搜索结果，为一组 Entity 对象。
An entity object.
Returns an error message.
响应码。
错误描述。
{
"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
}
]
}