向量数据库单路稀疏向量相似性检索

接口定义
本接口fullTextSearch()基于稀疏向量实现全文检索，对查询词与文档内容进行匹配，并按相关度排序结果。
public FullTextSearchRes fullTextSearch(String database, String collection, FullTextSearchParam param)
使用示例
说明：
如需使用稀疏向量，至少需要升级 Java SDK 至2.0.16版本，推荐使用2.1.1版本使用最新的 TerminateAfter、CutoffFrequency 等新特性，使得召回效果和性能更佳。 
腾讯云向量数据库团队提供了一款稀疏向量工具包，旨在帮助用户高效生成稀疏向量。具体信息，请参见 工具介绍。
FullTextSearchParam fullTextSearchParam = FullTextSearchParam.newBuilder()
        .withMatch(MatchParam.newBuilder()
                .withFieldName("sparse_vector")
                .withData(bm25Encoder.encodeQueries(Arrays.asList("什么是腾讯云向量数据库")))
                //.withCutoffFrequency(0.05)
                //.withTerminateAfter(1)
                .build())
        .withLimit(3)
        .withRetrieveVector(false)
        //.withOutputFields(Arrays.asList("id"))
        .build();
FullTextSearchRes res= client.fullTextSearch("db-test", "vector-sparse", fullTextSearchParam);
System.out.println(JsonUtils.toJsonString(res));
int i = 0;
for (Object docs : res.getDocuments()) {
        System.out.println("\\tres: " + (i++) + docs.toString());
}
入参描述
参数名
子参数
是否必选
参数含义
配置方法及要求
database
-
  是
指定检索数据的数据库名。
Database 命名要求如下：
只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。
长度要求：[1,128]。
collection
-
  是
指定检索数据的集合名。
Collection 命名要求如下：
只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。
长度要求：[1,128]。
﻿
Match
否
稀疏向量检索配置。
FieldName：稀疏向量的字段名，例如：sparse_vector。
Data：检索的稀疏向量列表，当仅支持输入一个稀疏向量。
TerminateAfter：设置检索数量上限，即检索数量超过 TerminateAfter 值之后，提前终止检索行为，可以有效的控制速率。在数据量较大的情况下，推荐经验值：4000。
CutoffFrequency：设置高频词出现的频次或频率上限，即词频大于 CutoffFrequency 的值之后，该关键词被忽略。
频数：可指定关键词出现的频数，取值为正整数，范围为[1,+∞]。
频率：可指定为关键词出现的频率，取值范围为[0,1]的小数。例如：0.8。
说明：
CutoffFrequency可以排序阶段去掉高频词，在数据量较大的情况下（>=50w）推荐值：0.1。
﻿
﻿
RetrieveVector
﻿
否
标识是否需要返回检索结果的向量值。
取值如下所示：
true：需要。
false：不需要。默认为 false。
﻿
Limit
是
指定返回最相似的 Top K 的 K 的值。
大于等于0的正整数。
﻿
Filter
否
设置 Filter 表达式，过滤所需的数据。
使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式。Filter 表达式格式为 <field_name><operator><value>，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见 Filter 条件表达式。其中： 
<field_name>：表示要过滤的字段名。
<operator>：表示要使用的运算符。
string ：匹配单个字符串值（=）、排除单个字符串值（!=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。
uint64：大于（>）、大于等于（>=）、等于（=）、小于（<）、小于等于（<=）、不等于（!=）。例如：expired_time > 1623388524。
array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。
json：json 类型的 Filter 表达式语法和 json 字段的键值类型保持一致。若访问 Json 对象中的键，使用点（.）符号连接。例如：Json 类型的字段 bookInfo ，其键 bookName 的 Filter 表达式如下所示。更多信息，请参见Json 类型表达式。
.withFilter("bookInfo.bookName=\\"三国演义\\"")
<value>：表示要匹配的值。
﻿
OutputFields
否
配置需返回的字段。
以数组形式配置需返回的字段。若不配置，返回所有字段。
说明：
OutputFields 与 RetrieveVector 参数均可以配置是否输出向量值，二者任意一个配置需输出向量字段，则将输出向量字段。
出参描述
---------------------- full text search ----------------------
	res: 0{"id":"0001","score":0.510307252407074,"text":"腾讯云向量数据库（Tencent Cloud VectorDB）是一款全托管的自研企业级分布式数据库服务，专用于存储、索引、检索、管理由深度神经网络或其他机器学习模型生成的大量多维嵌入向量。"}
	res: 1{"id":"0005","score":0.31104958057403564,"text":"腾讯云向量数据库可以和大语言模型 LLM 配合使用。企业的私域数据在经过文本分割、向量化后，可以存储在腾讯云向量数据库中，构建起企业专属的外部知识库，从而在后续的检索任务中，为大模型提供提示信息，辅助大模型生成更加准确的答案。"}
	res: 2{"id":"0004","score":0.2857203185558319,"text":"腾讯云向量数据库（Tencent Cloud VectorDB）作为一种专门存储和检索向量数据的服务提供给用户， 在高性能、高可用、大规模、低成本、简单易用、稳定可靠等方面体现出显著优势。 "}
﻿
参数名
参数含义
id
Document 的 ID 信息。
sparse_vector
稀疏向量。
score
表示查询稀疏向量与检索结果向量之间的相似性计算分数。
other_scalar_field
Document 其他自定义的标量字段。

参数名	子参数	是否必选	参数含义	配置方法及要求
database	-	是	指定检索数据的数据库名。	Database 命名要求如下：只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。长度要求：[1,128]。
collection	-	是	指定检索数据的集合名。	Collection 命名要求如下：只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。长度要求：[1,128]。
	Match	否	稀疏向量检索配置。	FieldName：稀疏向量的字段名，例如：sparse_vector。 Data：检索的稀疏向量列表，当仅支持输入一个稀疏向量。 TerminateAfter：设置检索数量上限，即检索数量超过 TerminateAfter 值之后，提前终止检索行为，可以有效的控制速率。在数据量较大的情况下，推荐经验值：4000。 CutoffFrequency：设置高频词出现的频次或频率上限，即词频大于 CutoffFrequency 的值之后，该关键词被忽略。频数：可指定关键词出现的频数，取值为正整数，范围为[1,+∞]。频率：可指定为关键词出现的频率，取值范围为[0,1]的小数。例如：0.8。说明： CutoffFrequency可以排序阶段去掉高频词，在数据量较大的情况下（>=50w）推荐值：0.1。
		RetrieveVector	否	标识是否需要返回检索结果的向量值。	取值如下所示： true：需要。 false：不需要。默认为 false。
		Limit	是	指定返回最相似的 Top K 的 K 的值。	大于等于0的正整数。
		Filter	否	设置 Filter 表达式，过滤所需的数据。	使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式。Filter 表达式格式为 <field_name><operator><value>，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见 Filter 条件表达式。其中： <field_name>：表示要过滤的字段名。 <operator>：表示要使用的运算符。 string ：匹配单个字符串值（=）、排除单个字符串值（!=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。 uint64：大于（>）、大于等于（>=）、等于（=）、小于（<）、小于等于（<=）、不等于（!=）。例如：expired_time > 1623388524。 array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。 json：json 类型的 Filter 表达式语法和 json 字段的键值类型保持一致。若访问 Json 对象中的键，使用点（.）符号连接。例如：Json 类型的字段 bookInfo ，其键 bookName 的 Filter 表达式如下所示。更多信息，请参见Json 类型表达式。 .withFilter("bookInfo.bookName=\\"三国演义\\"") <value>：表示要匹配的值。
		OutputFields	否	配置需返回的字段。	以数组形式配置需返回的字段。若不配置，返回所有字段。说明： OutputFields 与 RetrieveVector 参数均可以配置是否输出向量值，二者任意一个配置需输出向量字段，则将输出向量字段。

参数名	参数含义
id	Document 的 ID 信息。
sparse_vector	稀疏向量。
score	表示查询稀疏向量与检索结果向量之间的相似性计算分数。
other_scalar_field	Document 其他自定义的标量字段。

单路稀疏向量相似性检索

本页目录：

接口定义

使用示例

入参描述

出参描述