基于 Doc ID 相似度检索

最近更新时间:2024-01-18 17:43:01

我的收藏

功能介绍

基于相似度匹配的查询方式,searchById() 用于在 Base 类数据中根据指定的 Document id 进行相似度查询,并支持搭配自定义的标量字段的 Filter 表达式一并进行相似度检索,返回指定的 Top K 个最相似的数据。

请求示例

如下示例已经通过 create_database() 创建数据库 db-test,已通过 create_collection() 创建集合为 book-vector,通过 searchById() 进行数据检索。
import tcvectordb
from tcvectordb.model.enum import FieldType, IndexType, MetricType, ReadConsistency
from tcvectordb.model.index import Index, VectorIndex, FilterIndex, HNSWParams
from tcvectordb.model.document import Document, Filter, SearchParams

#create a database client object
client = tcvectordb.VectorDBClient(url='http://10.0.X.X', username='root', key='eC4bLRy2va******************************', read_consistency=ReadConsistency.EVENTUAL_CONSISTENCY, timeout=30)

db = client.database('db-test')
coll = db.collection('book-vector')
# search by document id
# document_ids 指定了检索文档 id
# filter 指定了过滤条件
# params 指定索引类型对应的查询参数,HNSW 类型需要设置 ef,指定查询的遍历范围;IVF 系列需要设置 nprobe,指定查询的单位数量
# retrieve_vector 指定是否输出向量字段
# limit 指定返回最相似的 Top K 条结果。如果插入的数据不足 K 条,则返回实际插入的 Document 数量。
# output_fields 指定输出字段
doc_lists = coll.searchById(
document_ids=['0001','0002'],
filter=Filter(Filter.In("bookName",["三国演义", "西游记"])),
params=SearchParams(ef=200),
limit=3,
retrieve_vector=True,
output_fields=['bookName','author']
)

for i, docs in enumerate(doc_lists):
print(i)
for doc in docs:
print(doc)

请求参数

参数
是否必选
参数含义
配置方法
document_ids
待查询的文档 ID。
每个 ID 长度限制为[1,128]。数组元素数量最大为20。
filter
设置查询过滤条件。
Filter 的表达式格式为 '<field_name><operator><value>',多个表达式之间支持 and(与)、or(或)、not(非)关系。具体信息,请参见 Filter 条件表达式。其中
<field_name>:表示要过滤的字段名。
<operator>:表示要使用的运算符。
string :匹配单个字符串值(=)、排除单个字符串值(!=)、匹配任意一个字符串值(in)、排除所有字符串值(not in)。其对应的 Value 必须使用英文双引号括起来。
unit64:大于(>)、大于等于(>=)、等于(==)、小于(<)、小于等于(<=)。例如: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 时已设置,可通过 list_collections() 查看。

retrieve_vector

标识是否需要返回检索结果的向量值。
取值如下所示:
True:需要。
False:不需要。默认为 False。
limit
指定返回最相似的 Top K 的 K 的值。
如果插入的数据不足 K 条,则返回实际插入的 Document 数量。
output_fields
配置需返回的字段。
以数组形式配置需返回的字段。若不配置,返回所有字段。
说明:
output_fields retrieve_vector 参数均可以配置是否输出向量值,二者任意一个配置需输出向量字段,则将输出向量字段。


输出参数

查看输出,如下所示。查询参数 document_ids = ['0001','0002'],查询结果中0下面的三行为 id 为0001进行相似度查询的结果,1下面的三行为 id 为0002进行相似度查询的结果。
说明:
输出的 Document ID 顺序与查询时配置的参数 document_ids 输入的顺序一致。
每一个查询结果都返回 TopK 条相似度计算的结果。其中,K 为 limit 设置的数值,如果插入的数据不足 K 条,则返回实际插入的 Document 数量。
检索结果会按照与查询向量的相似程度进行排列,相似度最高的结果会排在最前面,相似度最低的结果则排在最后面。相似程度则通过 L2(欧几里得距离)、IP(内积)或 COSINE(余弦相似度)计算得出的分数来衡量,输出参数 score 表示相似性计算分数。其中,欧式距离(L2)计算所得的分数越小与搜索值越相似;而余弦相似度(COSINE)与 内积(IP) 计算所得的分数越大与搜索值越相似。
0
{'id': '0001', 'vector': [0.21230000257492065, 0.23000000417232513, 0.21299999952316284], 'score': 1.0000001192092896, 'author': '罗贯中', 'bookName': '三国演义'}
{'id': '0002', 'vector': [0.21230000257492065, 0.2199999988079071, 0.21299999952316284], 'score': 0.9997729659080505, 'author': '吴承恩', 'bookName': '西游记'}
1
{'id': '0002', 'vector': [0.21230000257492065, 0.2199999988079071, 0.21299999952316284], 'score': 0.9997580051422119, 'author': '吴承恩', 'bookName': '西游记'}
{'id': '0001', 'vector': [0.21230000257492065, 0.23000000417232513, 0.21299999952316284], 'score': 0.9990617632865906, 'bookName': '三国演义', 'author': '罗贯中'}
参数名
参数含义
id
Document 的 ID 信息。
vector
Document 的向量值。
score
表示查询向量与检索结果向量之间的相似性计算分数。
author、page、section
Document 其他自定义的标量字段。