定義
バージョン8.3の新機能。
$similarityCosine配列または
binData値として表される 2 つの数値ベクトル間のコサイン類似度を返します。コサイン類似度は、2 つのベクトル間の角度のコサインを測定し、その方向がどれだけ類似しているかを示します。$similarityCosineには 2 つの構文形式があります。簡潔な構文では、以下のような未加工のコサイン類似度スコアが返されます。
{ $similarityCosine: [ <vector1>, <vector2> ] } 完全な構文は任意の正規化パラメータを受け入れます。
{ $similarityCosine: { vectors: [ <vector1>, <vector2> ], score: <boolean> } } 完全な構文を使用する場合、
$similarityCosineは次のフィールドを受け入れます。フィールドタイプ必要性説明vectors配列
必須
正確に 2 つの式の配列。各式は、数値の配列または
binData値に解決される必要があります。どちらのベクトルの長さは等しくなければなりません。scoreブール値
任意
trueの場合、 は式(1 + cosine) / 2を使用して、範囲[0, 1]内の正規化されたスコアを返します。デフォルトはfalseです。式の詳細については、「 式 」を参照してください。
動作
null および欠損値
null引数が に解決されるか、欠落しているフィールドを参照する場合、$similarityCosine nullは を返します。
ゼロ絶対値ベクトル
いずれかの入力ベクトルの大きさがゼロ(つまり、すべての要素が0 )の場合、$similarityCosine 0は を返します。
戻り値
は$similarityCosine doubleを返します。 がscorefalse (デフォルトの)の場合、結果は の範囲内の未加工のコサイン類似度の値です。[-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 }