如何通过HTTP API,根据id列表获取Collection中已存在的Doc

本文介绍如何通过HTTP API，根据id列表获取Collection中已存在的Doc。

说明

如果指定id不存在，则该id对应的Doc为空。

前提条件

已创建Cluster：创建Cluster。
已获得API-KEY：API-KEY管理。

Method与URL

HTTP

GET https://{Endpoint}/v1/collections/{CollectionName}/docs?ids={IDs}&partition={PartitionName}

使用示例

说明

需要使用您的api-key替换示例中的YOUR_API_KEY、您的Cluster Endpoint替换示例中的YOUR_CLUSTER_ENDPOINT，代码才能正常运行。
本示例需要参考新建Collection-使用示例提前创建好名称为quickstart的Collection

Shell

curl -H 'dashvector-auth-token: YOUR_API_KEY' \
 'https://YOUR_CLUSTER_ENDPOINT/v1/collections/quickstart/docs?ids=1,2'

# example output:
# {
#   "code": 0,
#   "request_id": "b6e03358-d396-445d-88a5-d5e9bb1edead",
#   "message": "Success",
#   "output": {
#     "1": {
#       "id": "1",
#       "vector": [
#         0.1,
#         0.2,
#         0.3,
#         0.4
#       ],
#       "fields": {
#         "name": null,
#         "weight": null,
#         "age": null
#       },
#       "score": 0.0
#     },
#     "2": {
#       "id": "2",
#       "vector": [
#         0.2,
#         0.3,
#         0.4,
#         0.5
#       ],
#       "fields": {
#         "name": "zhangsan",
#         "weight": null,
#         "age": 20
#       },
#       "score": 0.0
#     }
#   }
# }

入参描述

参数	Location	类型	必填	说明
{Endpoint}	path	str	是	Cluster的Endpoint，可在控制台Cluster详情中查看
{CollectionName}	path	str	是	Collection名称
dashvector-auth-token	header	str	是	api-key
{IDs}	query param	str	是	待获取的Doc id列表，逗号分隔
{PartitionName}	query param	str	否	Partition名称

出参描述

字段	类型	描述	示例
code	int	返回值，参考返回状态码说明	0
message	str	返回消息	success
request_id	str	请求唯一id	19215409-ea66-4db9-8764-26ce2eb5bb99
output	object	key为Doc id、value为对应Doc的Dict
usage	map	对Serverless实例（按量付费）集合的Doc获取请求，成功后返回实际消耗的读请求单元数	`{ Usage: { read_units: 1 } }`