查询

This operation conducts a filtering on the scalar field with a specified boolean expression.

POST

/v2/vectordb/entities/query

集群 Endpoint

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

📘说明

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

export CLUSTER_ENDPOINT=""

参数

Authorizationstringheader

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

示例值：Bearer {{TOKEN}}

请求体application/json

dbNamestring

数据库名称。

collectionNamestring必填项

Collection 名称。

filterstring必填项

用于对标量字段进行过滤的表达式。

outputFieldsarray

需要在查询结果中返回的字名称数组。

[]outputFieldsstring

随查询结果返回的字段名称。

partitionNamesarray

Partition 名称列表。设置此参数可限制操作范围到指定的 Partition。未设置时，操作范围为 Collection 中的所有 Partition。

[]partitionNamesstring

Partition 名称。

limitinteger

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

offsetinteger

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

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/query" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "quick_setup",
    "filter": "color like \"red_%\"",
    "outputFields": [
        "color"
    ],
    "limit": 3
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataarray

查询到的 Entity 列表，每个字典表示一个查询到的 Entity。

[]dataobject

An entity object

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "cost": 0,
    "data": [
        {
            "color": "red_7025",
            "id": 1
        },
        {
            "color": "red_4794",
            "id": 4
        },
        {
            "color": "red_9392",
            "id": 6
        }
    ]
}