昇腾社区首页
中文
注册

full_text_search

功能描述

在关系型数据库中搜索文档信息。如果创建OpenGaussDocstore实例时,参数enable_bm25设置为False,则无法使用此接口,会返回空列表。

函数原型

def full_text_search(query, top_k, filter_dict) -> List[MxDocument]

输入参数说明

参数名

数据类型

可选/必选

说明

query

str

必选

待检索的文本信息,长度范围(0, 1000 * 1000]

top_k

int

可选

返回检索到的最匹配的chunk数量,默认值为3,若该参数的值大于实际检索到的有效chunk数量,则只返回有效的chunk,取值范围(0, 10000]

filter_dict

Dict

必选

由检索条件组成的字典,filter_dict包含元素的个数需小于等于32,当前只支持对document_id进行过滤,过滤的文档id以列表形式传入,例如,需要在document_id为1,2,4这几篇文档中过滤,则传入的字典为{"document_id": [1, 2, 4]}

返回值说明

数据类型

说明

List[MxDocument]

查询到结果时返回MxDocument类实例组成的列表,无结果时返回空列表。MxDocument参见MxDocument类。enable_bm25为False返回值为[]。