/ /

$similarityCosine (operador de expresión)

Definición

Nuevo en la versión 8.3.

$similarityCosine

Devuelve la similitud coseno entre dos vectores numéricos representados como arreglos o valores de binData. La similitud del coseno mide el coseno del ángulo entre dos vectores e indica cuán similares son sus direcciones, independientemente de sus magnitudes.

$similarityCosine tiene dos formas de sintaxis.

La sintaxis concisa devuelve una puntuación bruta de similitud coseno:

{ $similarityCosine: [ <vector1>, <vector2> ] }

Sintaxis completa acepta un parámetro opcional de normalización:

{
   $similarityCosine: {
      vectors: [ <vector1>, <vector2> ],
      score: <boolean>
   }
}

Al usar la sintaxis completa, $similarityCosine acepta los siguientes campos:

Campo	Tipo	Necesidad	Descripción
`vectors`	Arreglo	Requerido	Arreglo de exactamente dos expresiones. Cada expresión debe resolverse en un arreglo de valores numéricos o un valor de `binData`. Ambos vectores deben tener la misma longitud.
`score`	Booleano	Opcional	Cuando `true`, devuelve una puntuación normalizada en el rango `[0, 1]` utilizando la fórmula `(1 + cosine) / 2`. Por defecto es `false`.

Para obtener más información sobre expresiones, vea expresión.

Comportamiento

`null` y valores faltantes

Si alguno de los argumentos se resuelve en null o se refiere a un campo inexistente, $similarityCosine devuelve null.

Vectores de magnitud cero

Si algún vector de entrada tiene una magnitud de cero (es decir, todos los elementos son 0), $similarityCosine devuelve 0.

Valor de retorno

$similarityCosine devuelve un double. Cuando score es false (por defecto), el resultado es el valor bruto de similitud coseno en el rango [-1, 1]:

1 indica que los vectores apuntan en direcciones idénticas.
0 indica que los vectores son ortogonales.
-1 indica que los vectores apuntan en direcciones opuestas.

Cuando score es true, el resultado se normaliza al rango [0, 1] con la fórmula (1 + cosine) / 2.

Errors

$similarityCosine devuelve un error en los siguientes casos:

Ningún argumento se resuelve en un arreglo o en un valor binData.
Los arreglos de entrada o los valores binData tienen diferentes longitudes.
Cualquiera de los arreglos contiene elementos no numéricos.

Ejemplo

El siguiente ejemplo utiliza una colección 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] }
] )

La siguiente cadena de agregación calcula la similitud del coseno entre los campos a y b para cada documento y devuelve tanto la puntuación cruda como la puntuación normalizada:

db.vectors.aggregate( [
   {
      $project: {
         raw: { $similarityCosine: [ "$a", "$b" ] },
         normalized: {
            $similarityCosine: {
               vectors: [ "$a", "$b" ],
               score: true
            }
         }
      }
   }
] )

La operación devuelve los siguientes resultados:

{ _id: 1, raw: 1, normalized: 1 }
{ _id: 2, raw: 0.7142857142857143,
  normalized: 0.8571428571428571 }
{ _id: 3, raw: 0.9746318461970762,
  normalized: 0.9873159230985381 }

Obtén más información

Volver

$sigmoid

$similarityDotProduct

Definición

Comportamiento

null y valores faltantes

Vectores de magnitud cero

Valor de retorno

Errors

Ejemplo

Obtén más información

`null` y valores faltantes