向量数据库 Doc ID 相似性检索

接口定义
基于相似度匹配的查询方式，searchById() 根据输入的1到 N 个文档 ID，查找存储在数据库中的相应向量，并执行相似性 Top K 检索。
public List<List<Document>> searchById(String database, String collection, SearchByIdParam param)
使用示例
如下示例，检索与0002相似的数据。
SearchByIdParam searchByIdParam = SearchByIdParam.newBuilder()
        .withDocumentIds(Arrays.asList("0002")) 
        // 若使用 HNSW 索引，则需要指定参数 ef，ef 越大，召回率越高，但也会影响检索速度       
        .withParams(new HNSWSearchParams(200))
        // 设置标量字段的 Filter 表达式，过滤所需查询的文档
        .withRetrieveVector(true)
         // 指定 Top K 的 K 值        
        .withLimit(2)
        // 指定返回的 fields                
        .withOutputFields(Arrays.asList("id", "bookName"))       
        .build();
         
List<List<Document>> siDocs = client.searchById("db-test", "book-vector", searchByIdParam);
int i = 0;
for (List<Document> docs : siDocs) {
    System.out.println("\\tres: " + i++);
    for (Document doc : docs) {    
        System.out.println("\\tres: " + doc.toString());    
    }
}
入参描述
参数名
子参数
是否必选
参数含义
配置方法
database
-
  是
指定检索数据的数据库名。
Database 命名要求如下：
只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。
长度要求：[1,128]。
collection
-
  是
指定检索数据的集合名。
Collection 命名要求如下：
只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。
长度要求：[1,128]。
searchByIdParam
DocumentIds
是
待检索的文档 ID。
每个 ID 长度限制为[1,128]。数组元素数量最大为20。
﻿
Params
否
设置索引类型对应的检索参数。
若索引类型为 HNSW，设置检索参数 efConstruction，指定需要访问的候选向量的数目。取值范围[1,32768]，默认为10。
若索引类型为 IVF 系列，设置参数 nprobe ，指定所需查询的单位数量。取值范围[1,nlist]，其中 nlist 在创建 Collection 时已设置，可通过 listCollections() 查看。
﻿
﻿
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>：表示要匹配的值。
﻿
Radius
否
指定相似性检索半径。
指定相似性检索的半径范围。每一种相似性计算方法的检索半径范围如下所示。
IP：检索结果返回满足 score >= radius 的数据。此时，Radius 取值范围为 (-∞, +∞)。
COSINE：检索结果返回满足 score >= radius 的数据。此时，Radius 取值范围为 [-1, 1]。
L2：检索结果返回满足 score <= radius 的数据。此时，Radius 取值范围为 [0, +∞)。
说明：
支持的索引类型为：FLAT、IVF 系列。
检索结果将限定在指定的检索半径内，并根据您设置的 'limit' 参数值来确定返回结果的数量。
﻿
OutputFields
否
配置需返回的字段。
以数组形式配置需返回的字段。若不配置，返回所有字段。
说明：
OutputFields 与 RetrieveVector 参数均可以配置是否输出向量值，二者任意一个配置需输出向量字段，则将输出向量字段。
输出 Json 字段时，OutputFields 仅支持指定 Json 字段的名称，而不支持直接指定 Json 字段内部的键（key）。例如，写入"a": {"b": "test", "c": 12}，OutputFields 只能指定返回整个 "a" 字段，而无法单独指定返回 "a.b" 。
输出参数
查看输出，如下所示。
说明：
输出的 Document ID 顺序与查询时配置的参数 document_ids 输入的顺序一致。
每一个查询结果都返回 Top K 条相似度计算的结果。其中，K 为 limit 设置的数值，如果插入的数据不足 K 条，则返回实际插入的 Document 数量。
检索结果会按照与查询向量的相似程度进行排列，相似度最高的结果会排在最前面，相似度最低的结果则排在最后面。
res: 0
res: {"id":"0002","vector":[0.21230000257492065,0.2199999988079071,0.21299999952316284],"sparse_vector":[[2,0.97],[5,0.54],[100,0.444]],"score":1.000000238418579,"bookName":"西游记"}
res: {"id":"0003","vector":[0.21230000257492065,0.23000000417232513,0.21299999952316284],"sparse_vector":[[2,0.98],[5,0.55],[100,0.445]],"score":0.9997729063034058,"bookName":"红楼梦"}
参数名
参数含义
id
Document 的 ID 信息。
vector
Document 的向量值。
score
表示查询向量与检索结果向量之间的相似性计算分数。欧式距离（L2）与汉明距离（Hamming Distance）计算所得的分数越小与搜索值越相似；而余弦相似度（COSINE）与内积（IP） 计算所得的分数越大与搜索值越相似。
author、page、section
Document 其他自定义的标量字段。

参数名	子参数	是否必选	参数含义	配置方法
database	-	是	指定检索数据的数据库名。	Database 命名要求如下：只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。长度要求：[1,128]。
collection	-	是	指定检索数据的集合名。	Collection 命名要求如下：只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。长度要求：[1,128]。
searchByIdParam	DocumentIds	是	待检索的文档 ID。	每个 ID 长度限制为[1,128]。数组元素数量最大为20。
		Params	否	设置索引类型对应的检索参数。	若索引类型为 HNSW，设置检索参数 efConstruction，指定需要访问的候选向量的数目。取值范围[1,32768]，默认为10。若索引类型为 IVF 系列，设置参数 nprobe ，指定所需查询的单位数量。取值范围[1,nlist]，其中 nlist 在创建 Collection 时已设置，可通过 listCollections() 查看。
		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>：表示要匹配的值。
		Radius	否	指定相似性检索半径。	指定相似性检索的半径范围。每一种相似性计算方法的检索半径范围如下所示。 IP：检索结果返回满足 score >= radius 的数据。此时，Radius 取值范围为 (-∞, +∞)。 COSINE：检索结果返回满足 score >= radius 的数据。此时，Radius 取值范围为 [-1, 1]。 L2：检索结果返回满足 score <= radius 的数据。此时，Radius 取值范围为 [0, +∞)。说明：支持的索引类型为：FLAT、IVF 系列。检索结果将限定在指定的检索半径内，并根据您设置的 'limit' 参数值来确定返回结果的数量。
		OutputFields	否	配置需返回的字段。	以数组形式配置需返回的字段。若不配置，返回所有字段。说明： OutputFields 与 RetrieveVector 参数均可以配置是否输出向量值，二者任意一个配置需输出向量字段，则将输出向量字段。输出 Json 字段时，OutputFields 仅支持指定 Json 字段的名称，而不支持直接指定 Json 字段内部的键（key）。例如，写入`"a": {"b": "test", "c": 12}`，OutputFields 只能指定返回整个 "a" 字段，而无法单独指定返回 "a.b" 。

参数名	参数含义
id	Document 的 ID 信息。
vector	Document 的向量值。
score	表示查询向量与检索结果向量之间的相似性计算分数。欧式距离（L2）与汉明距离（Hamming Distance）计算所得的分数越小与搜索值越相似；而余弦相似度（COSINE）与内积（IP）计算所得的分数越大与搜索值越相似。
author、page、section	Document 其他自定义的标量字段。

Doc ID 相似性检索

本页目录：

接口定义

使用示例

入参描述

输出参数