接口定义
def hybrid_search(self,database_name: str,collection_name: str,ann: Optional[Union[List[AnnSearch], AnnSearch]] = None,match: Optional[Union[List[KeywordSearch], KeywordSearch]] = None,filter: Union[Filter, str] = None,rerank: Optional[Rerank] = None,retrieve_vector: Optional[bool] = None,output_fields: Optional[List[str]] = None,limit: Optional[int] = None,timeout: Optional[float] = None,**kwargs) -> List[List[Dict]]
使用示例
说明:
如需使用稀疏向量,需要升级 Python SDK 至1.4.5或更高版本。
from tcvectordb.model.document import Document, AnnSearch, WeightedRerank, KeywordSearchfrom tcvdb_text.encoder.bm25 import BM25Encoder## 初始化稀疏向量编码器bm25 = BM25Encoder.default('zh')# search topn similary documents with filter# vectors 指定了检索的向量数据# filter 指定了过滤条件# params 指定索引类型对应的查询参数,HNSW 类型需要设置 ef,指定查询的遍历范围;IVF 系列需要设置 nprobe,指定查询的单位数量# retrieve_vector 指定是否输出向量字段# limit 指定返回最相似的 Top K 条结果。如果插入的数据不足 K 条,则返回实际插入的 Document 数量。# output_fields 指定输出字段doc_lists = client.hybrid_search(database_name='db-test',collection_name='book-vector',ann=[AnnSearch(field_name="vector",data=[0.3123, 0.43, 0.213],),],match=[KeywordSearch(field_name="sparse_vector",data=bm25.encode_queries('正大光明,忠良善果弥深'),),],rerank=WeightedRerank(field_list=['vector', 'sparse_vector'],weight=[0.9, 0.1],),retrieve_vector=True,limit=1,)for i, docs in enumerate(doc_lists):print(i)for doc in docs:print(doc)
入参描述
参数 | 是否必选 | 参数含义 | 配置方法及要求 |
database_name | 是 | 指定检索的数据库名。 | Database 命名要求如下: 只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。 长度要求:[1,128]。 |
collection_name | 是 | 指定检索的集合名 | Collection 命名要求如下: 只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。 长度要求:[1,128]。 |
ann | 是 | 设置向量检索信息。 | field_name:检索的字段名,可以设置为:vectors、id。 data:检索的向量,当仅支持输入一个向量。 params:检索参数,与索引类型相关。 HNSW 类型:需配置参数 ef,指定需要访问向量的数目。取值范围[1,32768],默认为10。 IVF 系列:需设置参数 nprobe,指定所需查询的单位数量。取值范围[1,nlist],其中 nlist 在创建 Collection 时已设置。 |
match | 否 | 稀疏向量检索配置。 | field_name:稀疏向量的字段名,例如:sparse_vector。 data:检索的稀疏向量,当前仅支持输入一个稀疏向量。 limit:指定返回的数量。 |
rerank | 否 | 检索中重排序(rerank)的配置。 | 参数 method 指定 Rerank 的方法,枚举如下值: WeightedRerank:基于不同字段的加权组合来进行排序。 field_list:列出用于加权计算的字段列表。例如,field_list=: ['vector', 'sparse_vector']表示密集型与稀疏型加权计算。 weight:定义了 "field_list" 中每个字段的权重,例如, weight=[0.9, 0.1] 表示"vector" 字段的权重是0.9,"sparse_vector" 字段的权重是0.1。RRFRerank:一种融合多个搜索方法的排名结果,通过为每个文档分配倒数排名分数并合并这些分数来生成一个新的综合排名,从而提高搜索结果的准确性和相关度。k 是一个用于计算倒数排名分数的常数,其作用是调整分数计算公式,以控制排名分数的分布。例如: rerank=RRFRerank(k=1) 。 |
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') |
retrieve_vector | 否 | | 标识是否需要返回检索结果的向量值。 true:需要。 false:不需要。默认为 false。 |
limit | 是 | | 指定返回最相似的 Top K 条数据的 K 的值。K 为大于0的正整数。 |
outputFields | 否 | | 指定需要输出的字段。若不设置,将返回所有字段。 说明: retrieveVector 和 outputFields 只要有其中一个配置输出向量字段即可输出 vector。 |
出参描述
0{'id': '0001', 'score': 0.874280571937561, 'vector': [0.21230000257492065, 0.23000000417232513, 0.21299999952316284], 'sparse_vector': [[2, 0.9599999785423279], [5, 0.5299999713897705], [100, 0.4429999887943268]], 'page': 21, 'tags': ['曹操', '诸葛亮', '刘备'], 'author': '罗贯中', 'bookName': '三国演义'}
参数名 | 参数含义 |
id | Document 的 ID 信息。 |
vector | Document 的向量值。 |
score | 表示查询向量与检索结果向量之间的相似性计算分数。 |
author、page、section | Document 其他自定义的标量字段。 |