最近更新时间：2024.04.16 13:11:48
首次发布时间：2023.11.03 15:00:09
/collection/fetch_data 接口用于根据主键在指定的 Collection 中查询单条或多条数据，单次最多可查询100条数据。
Collection 数据写入/删除后，可以实时查询数据。
说明
请求向量数据库 VikingDB 的 OpenAPI 接口时，需要构造签名进行鉴权，详细的 OpenAPI 签名调用方法请参见 API签名调用指南。
URI | /api/collection/fetch_data | 统一资源标识符 |
|---|---|---|
请求方法 | GET | 客户端对向量数据库服务器请求的操作类型 |
请求头 | Content-Type: application/json | 请求消息类型 |
Authorization: HMAC-SHA256 *** | 鉴权 |
参数 | 类型 | 是否必选 | 参数说明 |
|---|---|---|---|
collection_name/collection_alias | string | 是 | 指定查询数据的 Collection 名称/别名。
|
primary_keys | int64、 | 是 | 指定主键字段值，单次最多查询100条数据。primary_keys设置为不同类型时，数据查询逻辑如下：
|
参数 | 参数说明 |
|---|---|
code | 状态码 |
message | 返回信息 |
request_id | 标识每个请求的唯一标识符 |
data | 返回查询的数据。
|
状态码 | http状态码 | 返回信息 | 状态码说明 |
|---|---|---|---|
0 | 200 | success | 指定的 Collection 查询数据成功。 |
1000005 | 400 | collection not exist | Collection 不存在。 |
1000003 | 400 | invalid request：%s | 非法参数
|
1000001 | 401 | unauthorized | 请求头中缺乏鉴权信息。 |
1000002 | 403 | no permission | 权限不足。 |
curl -i -X GET \ -H 'Content-Type: application/json' \ -H 'Authorization: HMAC-SHA256 ***' \ http://***/api/collection/fetch_data \ -d '{ "collection": "test_name", "primary_keys": [123,124] }'
执行成功返回：
HTTP/1.1 200 OK Content-Length: 43 Content-Type: application/json { "code":0, "msg":"fetch data success", "request_id":"021695029748777fd001de6666600000000000000000002887b8d", "data": [ { "id": "123", "text": "hello world!", "vector_field": [0.10, 0.13.........0.52], "sparse_vector_field": {"hello": 0.34, "world": 0.03, "!": 0.11}, "time": "1690529701", "author": "zhangsan" }, { "id": "124", // 查不到，则没有vector, 并返回提示信息 "message": "no data found" } ] }
执行失败返回：
HTTP/1.1 400 OK Content-Length: 43 Content-Type: application/json {"code": 1000005, "msg": "collection not exist", "request_id":"021695029748777fd001de6666600000000000000000002887b8d"}