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

文档中心

立即注册

导航

SearchByText

最近更新时间：2025.04.12 14:54:05首次发布时间：2024.04.17 14:21:08

说明

目前向量数据库已支持多模态检索，可以直接通过文本搜索文本、文本搜索图片、图片搜索图片等，原有SearchByText 接口可迁移至SearchWithMultiModal

概述

SearchByText 用于非结构化数据检索。非结构化数据检索是指向量数据库支持非结构化原始数据，可以直接通过文本搜索文本。

说明

当前仅支持文本类型的非结构化数据。
Collection 数据写入/删除后，Index 数据更新时间预计20s，不能立即在 Index 检索到。

前提条件

从控制台选择了从向量化开始的数据库类型，并在创建数据集时配置了向量化字段；或通过 CreateCollection 接口创建数据集时，通过设置 vectorize 参数配置了 Collection 的向量化功能
通过 UpsertData 接口写入数据时，已写入text 类型的字段名称和字段值。
通过 CreateIndex 创建索引时，已创建 vector_index 向量索引。

请求参数

参数	子参数	类型	是否必选	默认值	参数说明
TextObject	Text	string	是		检索的输入文本是string 类型文本。
searchOptions	filter	map	否		过滤条件，详见 filter 表达式说明。默认为空，不做过滤。过滤条件包含 must、must_not、range、range_out四类查询算子，包含 and 和 or 两种对查询算子的组合。
	limit	int	否	10	检索结果数量，最大5000个。
	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._]+$"。
	denseWeight	float	否	0.5	对于混合检索，dense_weight 用于控制稠密向量在检索中的权重。范围为[0.2，1]。仅在检索的索引为混合索引时有效。

示例

请求参数

// 获取指定索引，程序初始化时调用即可，无需重复调用
index, _ := service.GetIndex("go_text_new", "goIndex")

searchOption := vikingdb.NewSearchOptions().SetLimit(5).SetOutputFields([]string{"doc_id"}).SetDenseWeight(0.5)
res, err := index.SearchByText(vikingdb.TextObject{Text: "example"}, searchOption)
if err != nil {
    fmt.Println(err)
}
for _, item := range res {
    fmt.Println(item)
}

返回值

Go 调用执行上面的任务，返回 Data 结构体地址构成的列表（[]*Data）。Data 结构体包含的属性如下表所示。

属性	说明
Id	主键 id。
Fields	请求返回中的 fields 字段，是具体的数据，map 类型。
Score	表示找到的向量和输入的向量的匹配程度。
Text	文本非结构化检索时返回。