Mark COSINE Vector Similarity Function as Deprecated

apache · May 6, 2024 · 589d1e2 · 589d1e2
1 parent 40cae08
commit 589d1e2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lucene/core/src/java/org/apache/lucene/index/VectorSimilarityFunction.java b/lucene/core/src/java/org/apache/lucene/index/VectorSimilarityFunction.java
@@ -66,7 +66,11 @@ public float compare(byte[] v1, byte[] v2) {
  * vectors to unit length, and instead use {@link VectorSimilarityFunction#DOT_PRODUCT}. You
  * should only use this function if you need to preserve the original vectors and cannot normalize
  * them in advance. The similarity score is normalised to assure it is positive.
+ *
+ * @Deprecated Use MAXIMUM_INNER_PRODUCT or DOT_PRODUCT instead
  */
+
+ @Deprecated
  COSINE {
  @Override
  public float compare(float[] v1, float[] v2) {