查询

Conducts a query on scalar fields in a collection.

POST

/v1/vector/query

集群 Endpoint

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

📘说明

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

export CLUSTER_ENDPOINT=""

参数

Authorizationstringheaderrequired

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

示例值：Bearer {{TOKEN}}

请求体application/json

dbNamestring

数据库名称。

collectionNamestring必填项

Collection 名称。

partitionNamesarray

Partition 名称。

[]partitionNamesstring

PartitionName

filterstring必填项

查询的过滤条件。

limitinteger

本次查询要求返回的最大 Entity 数量。
limit 与 offset 的总和不能超过 16384。

取值范围：≥ 1≤ 16384

offsetinteger

本次查询结果中需要跳过的 Entity 数量。
limit 与 offset 的总和不能超过 16384。

取值范围：0≤ 16384

outputFieldsarray

每条返回的查询结果中需要包含的字段名称列表。

[]outputFieldsstring

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

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v1/vector/query" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "medium_articles",
    "outputFields": [
        "id",
        "title",
        "link"
    ],
    "filter": "id in [443300716234671427, 443300716234671426]",
    "limit": 100,
    "offset": 0
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataarray

响应负载，为包含了指定字段及其对应值的对象组成的数组。

[]dataobject

Response payload which is an object that contains the specified output fields and their corresponding values.

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

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