VectorDistance(NoSQL 查询)
适用范围: NoSQL
返回两个指定矢量之间的相似性分数。
语法
VectorDistance(<vector_expr1>, <vector_expr2>, [<bool_expr>], [<obj_expr>])
参数
说明 | |
---|---|
spatial_expr_1 |
float32 数组或更小的数组。 |
spatial_expr_2 |
float32 数组或更小的数组。 |
bool_expr |
一个布尔值,指定如何在 ORDER BY 表达式中使用计算值。 如果为 true ,则使用暴力攻击。 false 的值使用在矢量属性上定义的任何索引(如果存在)。 默认值是 false 。 |
obj_expr |
JSON 格式的对象文字,用于指定矢量距离计算选项。 有效的项包括 distanceFunction 和 dataType 。 |
distanceFunction |
用于计算距离/相似度的指标。 |
dataType |
矢量的数据类型。 float32 、int8 、uint8 值。 默认值是 float32 。 |
distanceFunction
支持的指标包括:
cosine
,其值范围为-1
(最不相似)到+1
(最相似)。dotproduct
,其值范围为-∞
(-inf
)(最不相似)到+∞
(+inf
)(最相似)。euclidean
,其值范围为0
(最不相似)到+∞
(+inf
)(最相似)。
返回类型
返回一个数值表达式,它用于枚举两个表达式之间的相似性分数。
示例
第一个示例仅包含必需的参数。
SELECT VALUE {
name: s.name,
similarityScore: VectorDistance(s.vector1, s.vector2)
}
FROM
source s
ORDER BY
VectorDistance(s.vector1, s.vector2)
下一个示例还包括可选参数。
SELECT VALUE {
name: s.name,
similarityScore: VectorDistance(s.vector1, s.vector2, true, {'distanceFunction':'cosine', 'dataType':'float32',})
}
FROM
source s
ORDER BY
VectorDistance(s.vector1, s.vector2)
注解
- 此函数需要注册 Azure Cosmos DB NoSQL 矢量搜索预览功能。
- 此函数受益于矢量索引
- 如果提供
false
作为可选的bool_expr
,则使用路径上定义的矢量索引(如果存在)。 如果未在矢量路径上定义任何索引,则此函数将恢复为完全扫描,并且与使用矢量索引相比,会产生更高的 RU 费用和更高的延迟。 - 在
ORDER BY
子句中使用VectorDistance
时,不需要为ORDER BY
指定方向,因为根据使用的相似度指标,结果始终按最相似(第一个)到最不相似(最后一个)的顺序排序。 - 结果表示为相似性分数。