kNN 搜索 API
编辑kNN 搜索 API编辑
已在 8.4.0 中弃用。
kNN 搜索 API 已被搜索 API 中的 knn 选项 替代。
执行 k 最近邻 (kNN) 搜索并返回匹配的文档。
GET my-index/_knn_search
{
"knn": {
"field": "image_vector",
"query_vector": [0.3, 0.1, 1.2],
"k": 10,
"num_candidates": 100
},
"_source": ["name", "file_type"]
}
描述编辑
kNN 搜索 API 对 dense_vector 字段执行 k 最近邻 (kNN) 搜索。给定一个查询向量，它会找到 *k* 个最接近的向量，并将这些文档作为搜索结果返回。
Elasticsearch 使用 HNSW 算法 来支持高效的 kNN 搜索。与大多数 kNN 算法一样，HNSW 是一种近似方法，它牺牲了结果的准确性来提高搜索速度。这意味着返回的结果并不总是真正的 *k* 个最近邻。
kNN 搜索 API 支持使用过滤器限制搜索。搜索将返回也与过滤器查询匹配的前 k 个文档。
路径参数编辑
-
<target> - （可选，字符串）要搜索的数据流、索引和别名的逗号分隔列表。支持通配符 (
*)。要搜索所有数据流和索引，请使用*或_all。
查询参数编辑
-
routing - （可选，字符串）用于将操作路由到特定分片的自定义值。
请求正文编辑
-
filter - （可选，查询 DSL 对象）用于过滤可以匹配的文档的查询。kNN 搜索将返回也与该过滤器匹配的前
k个文档。该值可以是单个查询或查询列表。如果未提供filter，则允许所有文档匹配。 -
knn -
（必填，对象）定义要运行的 kNN 查询。
knn对象的属性-
field - （必填，字符串）要搜索的向量字段的名称。必须是启用了索引的
dense_vector字段。 -
k - （可选，整数）要作为热门结果返回的最近邻的数量。此值必须小于
num_candidates。默认为size。 -
num_candidates - （可选，整数）每个分片要考虑的最近邻候选数量。需要大于
k，或者如果省略了k则大于size，并且不能超过 10,000。Elasticsearch 从每个分片收集num_candidates个结果，然后合并它们以找到前k个结果。增加num_candidates往往会提高最终k个结果的准确性。默认为Math.min(1.5 * k, 10_000)。 -
query_vector - （必填，浮点数数组或字符串）查询向量。必须与您要搜索的向量字段具有相同的维度数。必须是浮点数数组或十六进制编码的字节向量。
-
-
docvalue_fields -
（可选，字符串和对象数组）字段模式数组。请求返回响应的
hits.fields属性中与这些模式匹配的字段名称的值。您可以将数组中的项指定为字符串或对象。请参阅 文档值字段。
docvalue_fields对象的属性-
field - （必填，字符串）通配符模式。请求返回与该模式匹配的字段名称的文档值。
-
format -
（可选，字符串）返回文档值的格式。
对于 日期字段，您可以指定日期 日期
格式。对于 数字字段，您可以指定 DecimalFormat 模式。对于其他字段数据类型，不支持此参数。
-
-
fields -
（可选，字符串和对象数组）字段模式数组。请求返回响应的
hits.fields属性中与这些模式匹配的字段名称的值。您可以将数组中的项指定为字符串或对象。请参阅
fields选项。fields对象的属性-
field - （必填，字符串）要返回的字段。支持通配符 (
*)。 -
format -
（可选，字符串）日期和地理空间字段的格式。其他字段数据类型不支持此参数。
date和date_nanos字段接受 日期格式。geo_point和geo_shape字段接受-
geojson（默认） - GeoJSON
-
wkt - 众所周知的文本
-
mvt(<spec>) -
二进制 Mapbox 矢量切片。API 以 base64 编码的字符串形式返回切片。
<spec>的格式为<zoom>/<x>/<y>，带有两个可选的后缀：@<extent>和/或:<buffer>。例如，2/0/1或2/0/1@4096:5。mvt参数-
<zoom> - （必填，整数）切片的缩放级别。接受
0-29。 -
<x> - （必填，整数）切片的 X 坐标。
-
<y> - （必填，整数）切片的 Y 坐标。
-
<extent> - （可选，整数）切片一侧的大小（以像素为单位）。矢量切片是边长相等的正方形。默认为
4096。 -
<buffer> - （可选，整数）切片外部裁剪缓冲区的大小（以像素为单位）。这允许渲染器避免来自超出切片范围的几何图形的轮廓伪影。默认为
5。
-
-
-
-
_source -
（可选）指示为匹配文档返回哪些 源字段。这些字段在搜索响应的
hits._source属性中返回。默认为true。请参阅 源过滤。_source的有效值-
true - （布尔值）返回整个文档源。
-
false - （布尔值）不返回文档源。
-
<wildcard_pattern> - （字符串或字符串数组）包含要返回的源字段的通配符 (
*) 模式或模式数组。 -
<object> -
（对象）包含要包含或排除的源字段列表的对象。
<object>的属性-
excludes -
（字符串或字符串数组）包含要从响应中排除的源字段的通配符 (
*) 模式或模式数组。您还可以使用此属性从
includes属性中指定的子集中排除字段。 -
includes -
（字符串或字符串数组）包含要返回的源字段的通配符 (
*) 模式或模式数组。如果指定了此属性，则仅返回这些源字段。您可以使用
excludes属性从此子集中排除字段。
-
-
-
stored_fields -
（可选，字符串）要作为匹配结果的一部分返回的存储字段的逗号分隔列表。如果未指定任何字段，则响应中不包含任何存储字段。请参阅 存储字段。
如果指定了此选项，则
_source参数默认为false。您可以传递_source: true以在搜索响应中同时返回源字段和存储字段。
响应正文编辑
kNN 搜索响应的结构与 搜索 API 响应 完全相同。但是，某些部分的含义特定于 kNN 搜索
- 文档
_score由查询向量和文档向量之间的相似度决定。请参阅similarity。 hits.total对象包含考虑的最近邻候选总数，即num_candidates * num_shards。hits.total.relation将始终为eq，表示精确值。