Distance Metrics

Weaviate on Stackoverflow badge Weaviate issues on Github badge Weaviate total Docker pulls badge

💡 You are looking at older or release candidate documentation. The current Weaviate version is v1.15.1

Available Distance Metrics

If not specified explicitly, the default distance metric in Weaviate is cosine. It can be set in the vectorIndexConfig field as part of the schema (Example to add new schema class) to any of the following types:

cosineCosine (angular) distance between two vectors. For a more efficient calculation, when chosing cosine all vectors are normalized to length 1 at import/read time and dot product is used for the actual calculation. A distance of 0 represents identical vectors, a distance of 2 represents opposing vectors.1 - cosine_sim(a,b)0 <= d <= 2
dotThe negative dot product.¹ The larger the value, the more similar two vectors are. Example: Two vectors with dot distance -3 are more similar than two vectors with dot distance -2 or +5-dot(a,b)-∞ < d < ∞
l2-squaredThe sqaured euclidean distance between two vectors. A distance of 0 represents identical vectors. The larger the value, the farther the vectors are apart in the euclidean space.sum((a_i, b_i)^2)0 <= d < ∞

If you are missing your favorite distance type and would like to contribute it to Weaviate, please let us know. We are happy to receive your contribution.

¹ - Dot Product on its own is a similarity metric, not a distance metric. As a result, Weaviate returns the negative dot product to stick with the intuition that a smaller value of a distance indicates a more similar result and a higher distance value indicates a less similar result.

Distance Implementations and Optimizations

On a typical Weaviate use case the largest portion of CPU time is spent calculating vector distances. Even with an approximate nearest neighbor index - which leads to far fewer calculations - the efficiency of distance calculations has a major impact on overall performance.

You can use the following overview to find the best possible combination of distance metric and CPU architecture / instruction set.

Distancelinux/amd64 AVX2darwin/amd64 AVX2linux/amd64 AVX512linux/arm64darwin/arm64
cosineoptimizedoptimizedno SIMDno SIMDno SIMD
dotoptimizedoptimizedno SIMDno SIMDno SIMD
l2-squaredoptimizedoptimizedno SIMDno SIMDno SIMD

If you like dealing with Assembly programming, SIMD, and vector instruction sets we would love to receive your contribution for one of the combinations that have not yet received an SIMD-specific optimization.

Distance Fields in the APIs

The distance is exposed in the APIs in two ways:

  • Whenever a vector search is involved, the distance can be displayed as part of the results, for example using _additional { distance }
  • Whenever a vector search is involved, the distance can be specified as a limiting criteria, for example using nearVector({distance: 1.5, vector: ... })

Note: The distance field was intorduced in v1.14.0. In previous versions, only certainty (see below) was available.

Distance vs Certainty

Prior to version v1.14 only certainty was available in the APIs. The original ideas behind certainty was to normalize the distance score into a value between 0 <= certainty <= 1, where 1 would represent identical vectors and 0 would represent opposite vectors.

This concept is however unique to cosine distance. With other distance metrics, scores may be unbounded. As a result the preferred way is to use distance in favor of certainty.

For backward compatibility, certainty can still be used when the distance is cosine. If any other distance is selected certainty cannot be used.

See also distance and certainty _additional{} properties.