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

文档中心

立即注册

导航

searchByVector

最近更新时间：2025.11.03 12:22:35首次发布时间：2025.11.03 12:22:35

概述

searchByVector 用于向量检索。根据查询的向量，搜索与其距离最近的 limit 个向量。

说明

Collection 数据写入/删除后，Index 数据更新时间预计 20s，不能立即在 Index 检索到。
当请求参数 filter 配置时，表示混合检索；当请求参数 filter 没有配置时，表示纯向量检索。

前提条件

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

方法定义

public DataApiResponse<SearchResult> searchByVector(SearchByVectorRequest request)
            throws ApiClientException, VectorApiException

请求参数

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

参数	类型	是否必选	参数说明
denseVector	List	是	用于检索的向量字段名称。
sparseVector	Map<String, Float>	否	检索的稀疏向量。
filter	Map<String, Object>	否	过滤条件，详见标量过滤默认为空，不做过滤。过滤条件包含 must、must_not、range、range_out四类查询算子，包含 and 和 or 两种对查询算子的组合。
outputFields	List	否	要返回的标量字段列表. 用户不传 output_fields 时, 返回所有标量字段用户传一个空列表不返回标量字段 output_fields格式错误或者过滤字段不是 collection 里的字段时, 接口返回错误
limit	Integer	否	检索结果数量，最大5000个。
offset	Integer	否	偏移量。仅分页场景下使用，不建议设置过大值，否则有深分页影响。默认值为0。设置值至少为0，语义和mysql的offset相同。
advance	SearchAdvance	否	高级参数，详见检索公共参数

返回参数

属性	类型	说明
data	List	见下
filterMatchedCount	Integer	筛选匹配数量
totalReturnCount	Integer	返回数量
realTextQuery	String
tokenUsage	Object	使用token

List

属性	类型	说明
id	Object	主键 id。
fields	Map<String, Object>	请求返回中的 fields 字段
score	Float	相似度
annScore	Float	ann得分

示例

请求参数

package org.example.newsubproduct.data.search;

import com.volcengine.vikingdb.runtime.core.ClientConfig;
import com.volcengine.vikingdb.runtime.core.auth.AuthWithAkSk;
import com.volcengine.vikingdb.runtime.enums.Scheme;
import com.volcengine.vikingdb.runtime.exception.VectorApiException;
import com.volcengine.vikingdb.runtime.vector.model.request.*;
import com.volcengine.vikingdb.runtime.vector.model.response.*;
import com.volcengine.vikingdb.runtime.vector.service.VectorService;

import java.util.ArrayList;
import java.util.List;
import java.util.Random;

public class SearchByVector {

    public static void main(String[] args) {
        VectorService vectorService = null;
        try {
            vectorService = new VectorService(
                    Scheme.HTTPS,
                    "api-vikingdb.vikingdb.cn-beijing.volces.com", // 填写向量库数据面v2的域名  https://www.volcengine.com/docs/84313/1792715
                    "cn-beijing",
                    new AuthWithAkSk(System.getenv("AK"), System.getenv("SK")),
                    ClientConfig.builder().build()
            );
        } catch (Exception e) {
            System.err.println("Client initialization failed: " + e.getMessage());
            e.printStackTrace();
            return;
        }

        SearchByVectorRequest request = SearchByVectorRequest.builder()
                .collectionName("your_collection_name") // 替换为您的集合名称
                .indexName("your_index_name") // 替换为您的索引名称
                .denseVector(generateRandomVector(128)) // 提供用于查询的向量
                .limit(5) // 返回最相似的 5 个结果
                .build();

        try {
            DataApiResponse<SearchResult> response = vectorService.searchByVector(request);
            System.out.println("request success:");
            System.out.println(response);
        } catch (VectorApiException vectorApiException) {
            System.err.println("request vectorApiException:");
            System.out.println("apiName: " + vectorApiException.getApiName());
            System.out.println("httpStatusCode: " + vectorApiException.getHttpStatusCode());
            System.out.println("code: " + vectorApiException.getCode());
            System.out.println("message: " + vectorApiException.getMessage());
            System.out.println("requestId: " + vectorApiException.getRequestId());
            System.out.println("responseContext: " + vectorApiException.getResponseContext().getBody());
        } catch (Exception e) {
            System.err.println("request exception, message : " + e.getMessage());
            e.printStackTrace();
        }
    }


    private static List<Float> generateRandomVector(int n) {
        List<Float> randomList = new ArrayList();
        Random random = new Random();

        for(int i = 0; i < n; ++i) {
            float randomFloat = random.nextFloat() * 2.0F - 1.0F;
            randomList.add(randomFloat);
        }

        return randomList;
    }
}