接口定义
若在创建 Collection 时,已配置 Embedding 模型,则可使用
SearchByText()
接口输入原始文本,在数据库中检索与原始文档相似的文档,返回指定的 Top K 个最相似的 Document。SearchByText(ctx context.Context, databaseName string, collectionName string, text map[string][]string, params ...*SearchDocumentParams) (result *SearchDocumentResult, err error)
使用示例
如下示例,相似性检索与原始文本
吕布
,相似的 Top 2 条数据。var (ctx = context.Background()database = "go-sdk-test-db"embeddingCollection = "go-sdk-test-emcoll")searchRes, err := client.SearchByText(ctx, database, embeddingCollection, map[string][]string{"segment": {"吕布"}}, &tcvectordb.SearchDocumentParams{Params: &tcvectordb.SearchDocParams{Ef: 100}, // 若使用HNSW索引,则需要指定参数ef,ef越大,召回率越高,但也会影响检索速度RetrieveVector: false, // 是否需要返回向量字段,False:不返回,True:返回Limit: 2, // 指定 Top K 的 K 值})log.Printf("searchByText-----------------")for i, docs := range searchRes.Documents {log.Printf("doc %d result: ", i)for _, doc := range docs {log.Printf("document: %+v", doc)}}
入参描述
参数 | 子参数 | 是否必选 | 参数含义 | 配置方法 |
databaseName | - | 是 | 指定检索的数据库名。 | Database 命名要求如下: 只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。 长度要求:[1,128]。 |
collectionName | - | 是 | 指定检索数据的集合。 | Collection 命名要求如下: 只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。 长度要求:[1,128]。 |
text | - | 是 | 待检索的文本信息。 | 输入文本信息,用于检索与该文本信息相似的数据。 类型:字符串数组。 范围:数组元素最大批量为20 。 |
SearchDocumentParams | Filter | 否 | 设置查询过滤条件。 | 使用创建 Collection 指定的 Filter 索引的字段设置查询过滤表达式。Filter 表达式格式为 <field_name><operator><value>,多个表达式之间支持 and(与)、or(或)、not(非)关系。具体信息,请参见 混合检索。其中: <field_name>:表示要过滤的字段名。 <operator>:表示要使用的运算符。 string :匹配单个字符串值(=)、排除单个字符串值(!=)、匹配任意一个字符串值(in)、排除所有字符串值(not in)。其对应的 Value 必须使用英文双引号括起来。 uint64:大于(>)、大于等于(>=)、等于(=)、小于(<)、小于等于(<=)。例如:expired_time > 1623388524。 array:数组类型,包含数组元素之一(include)、排除数组元素之一(exclude)、全包含数组元素(include all)。例如,name include (\\"Bob\\", \\"Jack\\")。 <value>:表示要匹配的值。 示例: Filter('author="jerry"').And('page>20') |
| Params | 否 | 指定索引查询参数。 | 索引类型不同,检索时,所需配置的参数不同。 FLAT :无需指定参数。 HNSW 类型:需配置参数 Ef,指定需要访问向量的数目。取值范围[1,32768],默认为10。如何设置,请参见选型指南。 IVF 系列:需设置参数 nprobe ,指定所需查询的单位数量。取值范围[1,nlist],其中 nlist 在创建 Collection 时已设置,可通过 ListCollection() 查看。 |
| RetrieveVector | 否 | 标识是否需要返回检索结果的向量值。 | 取值如下所示: true:需要。 false:不需要。默认为 false。 |
| Limit | 是 | 指定返回最相似的 Top K 的 K 的值。 | 如果插入的数据不足 K 条,则返回实际插入的 Document 数量。 |
| OutputFields | 否 | 配置需返回的字段。 | 以数组形式配置需返回的字段。若不配置,返回所有字段。 说明: OutputFields 与 RetrieveVector 参数均可以配置是否输出向量值,二者任意一个配置需输出向量字段,则将输出向量字段。 |
出参描述
searchByText----------------- 2023/12/20 19:12:18 doc 0 result: 2023/12/20 19:12:18 document: {Id:0005 Vector:[] Score:0.798083 Fields:map[author:罗贯中 bookName:三国演义 page:25 segment:玄德曰:“布乃当今英勇之士,可出迎之。”糜竺曰:“吕布乃虎狼之徒,不可收留;收则伤人矣。]} 2023/12/20 19:12:18 document: {Id:0003 Vector:[] Score:0.793226 Fields:map[author:罗贯中 bookName:三国演义 page:23 segment:细作探知这个消息,飞报吕布。]}
参数名 | 参数含义 |
Id | Document 的 ID 信息。 |
Vector | Document 的向量值。 |
Score | 表示查询向量与检索结果向量之间的相似性计算分数。 |
Fields | segment:开启 Embedding 功能,在建表时,指定文本信息的字段名,则显示该字段。 |
| Document 其他自定义的标量字段。例如:author、bookName。 |