文档中心

向量数据库VikingDB

请输入

检索能力

searchById

概述

searchById 用于主键 id 检索。根据主键 id，搜索与其距离最近的 limit 个向量。

支持对 hnsw-hybrid 混合索引使用 searchById；此时可通过 denseWeight 调节稠密向量在混合检索中的权重。
Collection 数据写入/删除后，Index 数据更新时间预计20s，不能立即在 Index 检索到。
当请求参数 filter 配置时，表示混合检索；当请求参数 filter 没有配置时，表示纯向量检索。

前提条件

通过 createCollection 接口创建数据集时，定义字段 fields 已添加 vector 字段。
通过 upsertData 接口写入数据时，已写入 vector 类型的字段名称和字段值。
通过 createIndex 接口创建索引时，已创建 vectorIndex 向量索引。

请求参数

请求参数是 SearchByIdParam，SearchByIdParam 实例包含的参数如下表所示。

参数	类型	是否必选	默认值	参数说明
id	int64	是		主键 id。
filter	map	否		过滤条件，详见标量过滤默认为空，不做过滤。过滤条件包含 must、must_not、range、range_out四类查询算子，包含 and 和 or 两种对查询算子的组合。
limit	int	否	10	检索结果数量，最大5000个。
outputFields	list	否		过滤字段，指定要返回的标量或向量字段列表。 outputFields 不传时，返回所有的标量字段，不返回向量字段。 outputFields 为空列表时，不返回 fields 字段。 outputFields 格式错误或者过滤字段不是 collection 里的字段时, 接口返回错误。如果索引的距离方式为cosine，向量字段返回的向量是归一化后的向量。
denseWeight	float	否	0.5	对于混合检索，dense_weight 用于控制稠密向量在检索中的权重。范围为[0.2，1]。仅在检索的索引为混合索引时有效。
partition	string/int	否	"default"	子索引名称，类型与 partitionBy 的 fieldType 一致，字段值对应 partition_by 的 fieldValue。 fieldType 为 int64，list 时，partition 输入类型为 int64。 fieldType 为 string，list 时，partition 输入类型为 string，格式要求 "^[a-zA-Z0-9._]+$"。
scale_k	float64	否	1	检索时的 ef 是索引参数 ef 的 scale_k 倍默认1，取值范围[0.1, 100]，值越大检索结果越精确，但相应地会降低性能。

示例

运行示例前，请完成以下准备：
在 Java 项目中引入对应版本的 VikingDB SDK，并将示例放入可执行的 main 方法后编译运行。
AK/SK 在火山引擎控制台“密钥管理”中创建；Host 和 Region 取自地域和访问域名。请按代码的参数或环境变量读取方式完成配置。
Collection、Index 名称从 VikingDB 控制台对应资源详情获取；Task ID 使用创建或查询任务接口返回的 ID。请将 <YOUR_...> 占位符替换为真实值。
若示例包含 TOS 路径，请从 TOS 控制台确认桶名和对象路径，并替换为真实的 <YOUR_BUCKET_NAME>/<YOUR_TOS_PATH>。

请求参数

请在火山引擎控制台的密钥管理页面获取 AK 和 SK，并将示例中的 <YOUR_AK>、<YOUR_SK> 等占位符替换为真实配置。

//获取指定索引，程序初始化时调用即可，无需重复调用
IndexClient indexClient = new IndexClient("<YOUR_COLLECTION_NAME>", "<YOUR_INDEX_NAME>", "api-vikingdb.volces.com", "cn-beijing", "<YOUR_AK>", "<YOUR_SK>", "http");

List<String> outputField = new ArrayList<>();
outputField.add("doc_id");
outputField.add("price");
outputField.add("text_vector");
HashMap<String, Object> filter = new HashMap<>();
filter.put("op", "range");
filter.put("field", "price");
filter.put("lt", 4);
SearchByIdParam searchByIdParam = new SearchByIdParam()
                                    .setOutputFields(outputField)
                                    .setId(22L)
                                    .setPartition("default")
                                    .setFilter(filter)
                                    .setLimit(2)
                                    .build();

List<DataObject> datas = indexClient.searchById(searchByIdParam);
System.out.println(datas);

返回值

Java 调用执行上面的任务，返回 List 。DataObject 实例包含的属性如下表所示。

属性	说明
id	主键 id。
fields	请求返回中的 fields 字段，是具体的数据，map 类型。
score	表示找到的向量和输入的向量的匹配程度。

使用说明修正

id 支持 int64 或 string，具体类型必须与 Collection 主键字段一致。因此示例中的 "22" 适用于字符串主键；整数主键应传 22。

最近更新时间：2026.09.08 15:30:53

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求参数 #

返回值 #

使用说明修正 #

请求参数

返回值

使用说明修正