跳到主要内容

获取 Entity

This operation gets specific entities by their IDs.

POST
/v2/vectordb/entities/get
集群 Endpoint

该 API 的 Base URL 格式如下:

https://${CLUSTER_ENDPOINT}

📘说明
export CLUSTER_ENDPOINT=""
参数
Authorizationstringheaderrequired

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

示例值:Bearer {{TOKEN}}
请求体application/json
collectionNamestring必填项

Collection 名称。

idstring | integer | string[] | integer[]必填项

Entity ID 或 Entity ID 列表。

outputFieldsarray

需要随查询结果返回的字段列表。

[]outputFieldsstring

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

partitionNamesarray

Partition 名称列表。

[]partitionNamesstring

Partition 名称。

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/get" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "quick_setup",
"id": [
1,
3,
5
],
"outputFields": [
"color"
]
}'
响应200 - application/json
codeinteger

响应码。

dataarray

查询结果。

[]dataobject

An entity object.

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

{
"code": 0,
"data": [
{
"color": "red_7025",
"id": 1
},
{
"color": "pink_9298",
"id": 3
},
{
"color": "yellow_4222",
"id": 5
}
]
}