文档中心

向量数据库VikingDB

检索能力

概述

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

当请求参数 order 配置为向量 VectorOrder 对象中的 vector 字段，表示根据向量字段名称进行向量检索。
当请求参数 order 配置为向量 VectorOrder 对象中的主键 id，表示根据主键 id 进行向量检索。
当请求参数 order 配置为标量 ScalarOrder 对象中的 field_name 和 order，表示根据标量字段名称进行标量排序检索。filter 参数可选配置，均表示标量检索。
Collection 数据写入/删除后，Index 数据更新时间预计 20s，不能立即在 Index 检索到。
异步调用使用async_search接口，参数不变。

请求参数

参数	类型	是否必选	默认值	参数说明
order	map	否		指定向量 VectorOrder 对象或者标量 ScalarOrder 对象，两者二选一进行配置。 VectorOrder：参数 vector 和 id 两者二选一进行配置。 vector：向量字段名称，该场景即 search_by_vector，根据向量字段名称，搜索与其相似的向量。 sparse_vectors：稀疏向量，仅对 search_by_vector 的混合索引必传。 id：主键 id，该场景即 search_by_id，根据主键 id，搜索与其相似的向量。支持使用 hnsw-hybrid 混合索引执行 search_by_id；此时可通过 dense_weight 调节稠密向量权重。 ScalarOrder：参数 field_name 和 order 需要同时配置。 field_name：用于做排序的标量字段名称。 order：排序方式，Order.Asc（升序）、Order.Desc（降序）。
filter	map	否	None	过滤条件，详见标量过滤。默认为空，不做过滤。过滤条件包含 must、must_not、range、range_out四类查询算子，包含 and 和 or 两种对查询算子的组合。
limit	int	否	10	检索结果数量，最大5000个。
offset	int	否	0	偏移量。仅分页场景下使用，不建议设置过大值，否则有深分页影响。默认值为0。设置值至少为0，语义和mysql的offset相同。
dense_weight	float	否	0.5	对于标量过滤检索，dense_weight 用于控制稠密向量在检索中的权重。范围为[0.2，1]。仅在检索的索引为混合索引时有效。
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。
AK/SK 在火山引擎控制台“密钥管理”中创建；Host 和 Region 取自地域和访问域名。请按代码的参数或环境变量读取方式完成配置。
Collection、Index 名称从 VikingDB 控制台对应资源详情获取；Task ID 使用创建或查询任务接口返回的 ID。请将 <YOUR_...> 占位符替换为真实值。
若示例包含 TOS 路径，请从 TOS 控制台确认桶名和对象路径，并替换为真实的 <YOUR_BUCKET_NAME>/<YOUR_TOS_PATH>。

请求参数

# 获取指定索引，程序初始化时调用即可，无需重复调用
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(order=VectorOrder(gen_random_vector(10), "1"), limit=2,
                   output_fields=["doc_id", "like", "text_vector"],
                   partition="default", ffilter={"op": "range", "field": "price", "lt": 3.5})
                   
# 异步调用
async def search():
    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 = await index_client.async_search(order=VectorOrder(gen_random_vector(10)), limit=2,
                       output_fields=["doc_id", "like", "text_vector"],
                       ffilter={"op": "range", "field": "price", "lt": 3.5})
    print("-----------search_vector---------")
    for item in res:
        print(item)
        print(item.score)
    print("-----------search_scalar---------")
    res = index_client.search(order=ScalarOrder("price", Order.Desc), limit=6,
                       output_fields=["price"],
                       filter={"op": "range", "field": "price", "lt": 5})
    for item in res:
        print(item)
        print(item.score)
    print("-----------search_None---------")
    res = index_client.search(limit=5, output_fields=["doc_id", "like"],
                        filter={"op": "range", "field": "price", "lt": 3.5})
    for item in res:
         print(item.fields)
         print(item.score)
asyncio.run(search())

返回值

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

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

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

这个页面对您有帮助吗？

有用

无用