dev.langchain4j.store.embedding

Class Similarity

java.lang.Object

dev.langchain4j.store.embedding.Similarity

public class Similarity
extends Object

Constructor Summary

Constructors

Constructor and Description
Similarity()

Method Summary

Modifier and Type	Method and Description
static double	cosine(float[] a, float[] b) Calculates cosine similarity between two vectors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Similarity

public Similarity()

Method Detail

cosine

public static double cosine(float[] a,
                            float[] b)

Calculates cosine similarity between two vectors.

Cosine similarity measures the cosine of the angle between two vectors, indicating their directional similarity. It produces a value in the range: - -1 indicates vectors are diametrically opposed (opposite directions). - 0 indicates vectors are orthogonal (no directional similarity). - 1 indicates vectors are pointing in the same direction (but not necessarily of the same magnitude).

Not to be confused with cosine distance ([0..2]), which quantifies how different two vectors are.

Parameters:

a - first vector

b - second vector

Returns:

cosine similarity in the range [-1..1]