fetch_data(index)--向量数据库VikingDB-火山引擎

文档中心

立即注册

导航

fetch_data(index)

最近更新时间：2025.06.10 11:47:54首次发布时间：2024.04.17 14:21:06

概述

fetch_data 用于 Index 数据查询。根据主键 id，在指定的 Index 查询单条或多条数据，单次最多可查询100条数据。
异步调用使用async_fetch_data接口，参数不变。

说明

Collection 数据写入/删除后，Index 数据更新时间最长滞后 20s，不能立即在 Index 查询到。

请求参数

参数	类型	是否必选	默认值	参数说明
id	string、int64、 list<int64>、 list<string>	是		主键或主键构成的列表。
output_fields	list<string>	否		过滤标量字段，指定要返回的标量字段列表。 output_fields 不传时，返回所有的标量字段。 output_fields 为空列表时，不返回 fields 字段。 output_fields 格式错误或者过滤字段不是 collection 里的字段时, 接口返回错误。
partition	string/int	否	"default"	子索引名称，类型与 partition_by 的 field_type 一致，字段值对应 partition_by 的 field_value。 field_type 为 int64，list<int64> 时，partition 输入类型为 int64。 field_type 为 string，list<string> 时，partition 输入类型为 string，格式要求 "^[a-zA-Z0-9._]+$"。

参数

类型

是否必选

默认值

参数说明

string、int64、
list<int64>、
list<string>

是

主键或主键构成的列表。

output_fields

list<string>

否

过滤标量字段，指定要返回的标量字段列表。

output_fields 不传时，返回所有的标量字段。
output_fields 为空列表时，不返回 fields 字段。
output_fields 格式错误或者过滤字段不是 collection 里的字段时, 接口返回错误。

partition

string/int

否

"default"

子索引名称，类型与 partition_by 的 field_type 一致，字段值对应 partition_by 的 field_value。

field_type 为 int64，list<int64> 时，partition 输入类型为 int64。
field_type 为 string，list<string> 时，partition 输入类型为 string，格式要求 "^[a-zA-Z0-9._]+$"。

完整示例

请求参数

# 获取指定数据集，程序初始化时调用即可，无需重复调用
from volcengine.viking_db import IndexClient

index_client = IndexClient("test_collection", "test_index", "api-vikingdb.volces.com", "cn-beijing", "your ak", "your sk", "http")

res = index_client.fetch_data(["11", "33"], partition="1", output_fields=["doc_id", "like"])


# 异步调用
async def index_fetch_data():
    index_client = IndexClient("test_collection", "test_index", "api-vikingdb.volces.com", "cn-beijing", "your ak", "your sk", "http")
    res = await index_client.async_fetch_data(["111", "222", "333", "444"])
asyncio.run(index_fetch_data())

请求参数

Python 调用执行上面的任务，返回 Data 实例或 Data 实例列表。Data 实例包含的属性如下表所示。

属性	说明
id	主键 id。
fields	请求返回中的 fields 字段，是具体的数据，字典类型。