定义
8.3版本新增。
$similarityCosine返回以数组或
binData值表示的两个数值向量之间的余弦相似度。余弦相似度测量两个向量之间角度的余弦,并指示它们方向的相似程度,而与它们的幅度无关。$similarityCosine有两种语法形式。简洁语法返回原始余弦相似度分数:
{ $similarityCosine: [ <vector1>, <vector2> ] } 完整语法接受可选的规范化参数:
{ $similarityCosine: { vectors: [ <vector1>, <vector2> ], score: <boolean> } } 使用完整语法时,
$similarityCosine接受以下字段:字段类型必要性说明vectors阵列
必需
恰好包含两个表达式的数组。每个表达式必须解析为一个数值大量或一个
binData值。两个向量必须具有相同的长度。score布尔
Optional
为
true时,使用公式(1 + cosine) / 2返回[0, 1]范围内的规范化分数。默认为false。有关表达式的更多信息,请参阅表达式。
行为
null 和缺失值
如果任一参数解析为null 或引用缺失字段,则$similarityCosine null会返回 。
零幅度向量
如果任一输入向量的量值为零(即所有元素均为0 ),$similarityCosine 会返回0 。
返回值
$similarityCosine会返回double 。当score 为false (默认)时,结果是[-1, 1] 范围内的原始余弦相似度值:
1表示向量点相同的方向。0表示向量是正交的。-1表示向量点相反的方向。
当 score 为 true 时,使用公式 (1 + cosine) / 2 将结果标准化为范围[0, 1]。
Errors
$similarityCosine 在以下情况下返回错误:
任一参数均未解析为大量或
binData值。输入数组或
binData值具有不同的长度。这两个大量都包含非数字元素。
例子
以下示例使用 vectors集合:
db.vectors.insertMany( [ { _id: 1, a: [1, 2, 3], b: [1, 2, 3] }, { _id: 2, a: [1, 2, 3], b: [3, 2, 1] }, { _id: 3, a: [1, 2, 3], b: [4, 5, 6] } ] )
以下聚合管道计算每个文档的 a 和 b 字段之间的余弦相似度,并返回原始分数和归一化分数:
db.vectors.aggregate( [ { $project: { raw: { $similarityCosine: [ "$a", "$b" ] }, normalized: { $similarityCosine: { vectors: [ "$a", "$b" ], score: true } } } } ] )
操作返回以下结果:
{ _id: 1, raw: 1, normalized: 1 } { _id: 2, raw: 0.7142857142857143, normalized: 0.8571428571428571 } { _id: 3, raw: 0.9746318461970762, normalized: 0.9873159230985381 }