定義
バージョン8.3の新機能。
$similarityDotProduct配列または
binData値として表される 2 つの数値ベクトルのドット積を返します。ドット積は、対応する要素の積の合計と等しくなります。$similarityDotProductには 2 つの構文形式があります。簡潔な構文では、以下のように未加工のドット積スコアが返されます。
{ $similarityDotProduct: [ <vector1>, <vector2> ] } 完全な構文は任意の正規化パラメータを受け入れます。
{ $similarityDotProduct: { vectors: [ <vector1>, <vector2> ], score: <boolean> } } 完全な構文を使用する場合、
$similarityDotProductは次のフィールドを受け入れます。フィールドタイプ必要性説明vectors配列
必須
正確に 2 つの式の配列。各式は、数値の配列または
binData値に解決される必要があります。どちらのベクトルの長さは等しくなければなりません。scoreブール値
任意
trueの場合、 は式(1 + dotProduct) / 2を使用して正規化されたスコアを返します。デフォルトはfalseです。式の詳細については、「 式 」を参照してください。
動作
null および欠損値
null引数が に解決されるか、欠落しているフィールドを参照する場合、$similarityDotProduct nullは を返します。
戻り値
は$similarityDotProduct doubleを返します。 がscorefalse (デフォルトの)の場合、結果は未加工のドット積です。値は、入力ベクトルの大きさによって異なります。大きさが大きいベクトルでは、ドット積の値も大きくなります。
score が true の場合、結果は式 (1 + dotProduct) / 2 を使用して正規化されます。この正規化では、単位長(正規化)の入力ベクトルを前提としています。単位長ベクトルの場合、未加工ドット積は範囲 [-1, 1] にあり、正規化されたスコアは範囲 [0, 1] にあります。
Errors
$similarityDotProduct は、次の場合にエラーを返します。
どちらの引数も配列または
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: { $similarityDotProduct: [ "$a", "$b" ] }, normalized: { $similarityDotProduct: { vectors: [ "$a", "$b" ], score: true } } } } ] )
この操作は次の結果を返します。
{ _id: 1, raw: 14, normalized: 7.5 } { _id: 2, raw: 10, normalized: 5.5 } { _id: 3, raw: 32, normalized: 16.5 }