文档中心

向量数据库VikingDB

请输入

检索能力

search_by_vector

概述

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

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

前提条件

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

请求参数

参数	类型	是否必选	默认值	参数说明
vector	map	是		用于检索的稠密向量字段。
sparse_vectors	map	Spa		用于检索的稀疏向量。格式是字典，k 为 string 类型，表示关键词的字面量，v 为 float 类型，表示该关键词的权重数值。
dense_weight	float	否	0.5	对于混合检索，dense_weight 用于控制稠密向量在检索中的权重。范围为[0.2，1]。仅在检索的索引为混合索引(IndexType.HNSW_HYBRID)时有效。
filter	map	否	None	过滤条件，详见标量过滤。默认为空，不做过滤。过滤条件包含 must、must_not、range、range_out四类查询算子，包含 and 和 or 两种对查询算子的组合。
limit	int	否	10	检索结果数量，最大5000个。
offset	int	否	0	偏移量。仅分页场景下使用，不建议设置过大值，否则有深分页影响。默认值为0。设置值至少为0，语义和mysql的offset相同。
output_fields	list	否		过滤字段，指定要返回的标量或向量字段列表。向量字段返回必须填入到output_fields。 output_fields 不传时，返回所有的标量字段，不返回向量字段。 output_fields 为空列表时，不返回 fields 字段。 output_fields 格式错误或者过滤字段不是 collection 里的字段时, 接口返回错误。如果索引的距离方式为cosine，向量字段返回的向量是归一化后的向量。。
partition	string/int	否	"default"	子索引名称，类型与 partition_by 的 field_type 一致，字段值对应 partition_by 的 field_value。 field_type 为 int64，list 时，partition 输入类型为 int64。 field_type 为 string，list 时，partition 输入类型为 string，格式要求 "^[a-zA-Z0-9._]+$"。
scale_k	float64	否	1	检索 ef 是索引参数 ef 的 scale_k 倍。默认1，取值范围[0.1, 100]，值越大检索结果越精确，但相应地会降低性能。

示例

运行示例前，请完成以下准备：
安装 VikingDB Python SDK，将完整代码保存为 example.py 后执行 python3 example.py。
将 <YOUR_HOST>、<YOUR_REGION> 和 <YOUR_SCHEME> 替换为地域和访问域名中与实例一致的服务地址、地域和协议。
将 <YOUR_AK>、<YOUR_SK> 替换为火山引擎控制台“密钥管理”中创建的 Access Key ID 和 Secret Access Key；请勿把真实凭证提交到代码仓库。
将 Collection、Index、Task 等资源占位符替换为控制台中对应资源的名称或接口返回的 ID。若示例包含 TOS 路径，请从 TOS 控制台确认桶名和对象路径，并使用 tos://<YOUR_BUCKET_NAME>/<YOUR_OBJECT_KEY> 或文档要求的路径格式。

请求参数

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

index_client = IndexClient("<YOUR_COLLECTION_NAME>", "<YOUR_INDEX_NAME>", "api-vikingdb.volces.com", "cn-beijing", "<YOUR_AK>", "<YOUR_SK>", "http")

def gen_random_vector(dim):
    res = [0, ] * dim
    for i in range(dim):
        res[i] = random.random() - 0.5
    return res
res = index_client.search_by_vector(gen_random_vector(10), {"hello": 0.34, "world": 0.03, "!": 0.11},limit=2, dense_weight = 0.5, output_fields=["doc_id", "like", "text_vector"], partition="default") #混合检索

res = index_client.search_by_vector(gen_random_vector(10),limit=2, output_fields=["doc_id", "like", "text_vector"], partition="default") #纯稠密检索

# 异步调用
async def search_by_vector():
    def gen_random_vector(dim):
        res = [0, ] * dim
        for i in range(dim):
            res[i] = random.random() - 0.5
        return res
    index_client = IndexClient("<YOUR_COLLECTION_NAME>", "<YOUR_INDEX_NAME>", "api-vikingdb.volces.com", "cn-beijing", "<YOUR_AK>", "<YOUR_SK>", "http")
    res = await index_client.async_search_by_vector(gen_random_vector(10))
asyncio.run(search_by_vector())

返回值

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

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

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求参数 #

返回值 #

请求参数

返回值