search--向量数据库VikingDB-火山引擎

文档中心

立即注册

导航

最近更新时间：2025.04.12 14:52:42首次发布时间：2024.04.17 14:21:07

概述

search 用于在当前 Index 进行检索，支持向量检索、标量检索、标量过滤检索。

当请求参数配置向量 VectorOrder 对象中的 vector 字段，表示根据向量字段名称进行向量检索。
当请求参数配置向量 VectorOrder 对象中的主键 id，表示根据主键 id 进行向量检索。
当请求参数配置标量 ScalarOrder 对象中的 fieldName 和 order，表示根据标量字段名称进行标量排序检索。filter 参数可选配置，均表示标量检索。

说明

Collection 数据写入/删除后，Index 数据更新时间预计 20s，不能立即在 Index 检索到。

请求参数

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

参数	类型	是否必选	默认值	参数说明
vectorOrder	map	否		VectorOrder：参数 vector（与sparse_vectors组合）和 id 两者二选一进行配置。 vector：向量字段名称，该场景即 search_by_vector，根据向量字段名称，搜索与其相似的向量。 sparse_vectors：稀疏向量，仅对 search_by_vector 的混合索引必传。 id：主键 id，该场景即 search_by_id，根据主键 id，搜索与其相似的向量。说明对于使用了 hnsw-hybrid 算法的混合索引，暂时不支持基于 id 进行检索。
scalarOrder	map	否		指定标量 ScalarOrder 对象，参数 fieldName 和 order 需要同时配置。 fieldName：用于做排序的标量字段名称。 order：排序方式，Order.Asc（升序）、Order.Desc（降序）。
filter	map	否		过滤条件，详见标量过滤。默认为空，不做过滤。过滤条件包含 must、must_not、range、range_out四类查询算子，包含 and 和 or 两种对查询算子的组合。
limit	int	否	10	检索结果数量，最大5000个。
denseWeight	float	否	0.5	对于混合检索，dense_weight 用于控制稠密向量在检索中的权重。范围为[0.2，1]。仅在检索的索引为混合索引时有效。
outputFields	list<string>	否		过滤字段，指定要返回的标量或向量字段列表。 outputFields 不传时，返回所有的标量字段，不返回向量字段。 outputFields 为空列表时，不返回 fields 字段。 outputFields 格式错误或者过滤字段不是 collection 里的字段时, 接口返回错误。如果索引的距离方式为cosine，向量字段返回的向量是归一化后的向量。
partition	string/int	否	"default"	子索引名称，类型与 partitionBy 的 fieldType 一致，字段值对应 partitionBy 的 fieldValue。 fieldType 为 int64，list<int64> 时，partition 输入类型为 int64。 fieldType 为 string，list<string> 时，partition 输入类型为 string，格式要求 "^[a-zA-Z0-9._]+$"。

示例

请求参数

// 获取指定索引，程序初始化时调用即可，无需重复调用
Index index = vikingDBService.getIndex("javaSDKTest", "test_index");

List<String> outputField = new ArrayList<>();
outputField.add("doc_id");
outputField.add("like");
outputField.add("text_vector");
HashMap<String, Object> filter = new HashMap<>();
filter.put("op", "range");
filter.put("field", "price");
filter.put("lt", 4);
List<DataObject> datas = index.search(new SearchParam()
                                        .setVectorOrder(new VectorOrder().setVector(genRandomVector(12)).setSparseVector({"hello": 0.34, "world": 0.03, "!": 0.11}).build())
                                        .setOutputFields(outputField)
                                        .setFilter(filter)
                                        .setPartition("default");
                                        .setLimit(2)
                                        .build());

System.out.println(datas);

List<DataObject> datas = index.search(new SearchParam()
                                     .setVectorOrder(new VectorOrder().setId("22").build())
                                     .setPartition("default");
                                     .build());

System.out.println(datas);


List<DataObject> datas = index.search(new SearchParam()
                                 .setScalarOrder(new ScalarOrder("price", Order.Asc).build())
                                 .setPartition("default");
                                 .setLimit(2)
                                 .build());
System.out.println(datas);

返回值

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

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