Rename distance to score (#947)

Signed-off-by: yhmo <yihua.mo@zilliz.com>

examples/main/java/io/milvus/v1/BinaryVectorExample.java

@@ -37,7 +37,7 @@ import java.nio.ByteBuffer;
 import java.util.*;
 
 public class BinaryVectorExample {
-    private static final String COLLECTION_NAME = "java_sdk_example_binary_vector";
+    private static final String COLLECTION_NAME = "java_sdk_example_binary_vector_v1";
     private static final String ID_FIELD = "id";
     private static final String VECTOR_FIELD = "vector";
 

examples/main/java/io/milvus/v1/BulkWriterExample.java

@@ -135,8 +135,8 @@ public class BulkWriterExample {
         public static final String OBJECT_SECRET_KEY = "_your_storage_secret_key_";
     }
 
-    private static final String SIMPLE_COLLECTION_NAME = "for_bulkwriter";
-    private static final String ALL_TYPES_COLLECTION_NAME = "all_types_for_bulkwriter";
+    private static final String SIMPLE_COLLECTION_NAME = "java_sdk_bulkwriter_simple_v1";
+    private static final String ALL_TYPES_COLLECTION_NAME = "java_sdk_bulkwriter_all_v1";
     private static final Integer DIM = 512;
     private MilvusClient milvusClient;
 

examples/main/java/io/milvus/v1/Float16VectorExample.java

@@ -36,7 +36,7 @@ import java.util.*;
 
 
 public class Float16VectorExample {
-    private static final String COLLECTION_NAME = "java_sdk_example_float16_vector";
+    private static final String COLLECTION_NAME = "java_sdk_example_float16_vector_v1";
     private static final String ID_FIELD = "id";
     private static final String VECTOR_FIELD = "vector";
     private static final Integer VECTOR_DIM = 128;

examples/main/java/io/milvus/v1/GeneralExample.java

@@ -54,7 +54,7 @@ public class GeneralExample {
         milvusClient = new MilvusServiceClient(connectParam).withRetry(retryParam);
     }
 
-    private static final String COLLECTION_NAME = "java_sdk_example_general";
+    private static final String COLLECTION_NAME = "java_sdk_example_general_v1";
     private static final String ID_FIELD = "userID";
     private static final String VECTOR_FIELD = "userFace";
     private static final Integer VECTOR_DIM = 64;

examples/main/java/io/milvus/v1/HighLevelExample.java

@@ -52,7 +52,7 @@ public class HighLevelExample {
         milvusClient = new MilvusServiceClient(connectParam);
     }
 
-    private static final String COLLECTION_NAME = "java_sdk_example_hl";
+    private static final String COLLECTION_NAME = "java_sdk_example_highlevel_v1";
     private static final String ID_FIELD = "userID";
     private static final String VECTOR_FIELD = "userFace";
     private static final String USER_JSON_FIELD = "userJson";

examples/main/java/io/milvus/v1/HybridSearchExample.java

@@ -50,7 +50,7 @@ public class HybridSearchExample {
                 .build());
     }
 
-    private static final String COLLECTION_NAME = "java_sdk_example_hybrid_search";
+    private static final String COLLECTION_NAME = "java_sdk_example_hybrid_search_v1";
     private static final String ID_FIELD = "ID";
 
     private static final String FLOAT_VECTOR_FIELD = "float_vector";

examples/main/java/io/milvus/v1/IteratorExample.java

@@ -61,7 +61,7 @@ public class IteratorExample {
         milvusClient = new MilvusServiceClient(connectParam).withRetry(retryParam);
     }
 
-    private static final String COLLECTION_NAME = "java_sdk_example_iterator";
+    private static final String COLLECTION_NAME = "java_sdk_example_iterator_v1";
     private static final String ID_FIELD = "userID";
     private static final String VECTOR_FIELD = "userFace";
     private static final Integer VECTOR_DIM = 8;

examples/main/java/io/milvus/v1/SimpleExample.java

@@ -31,7 +31,7 @@ import java.util.*;
 
 
 public class SimpleExample {
-    private static final String COLLECTION_NAME = "java_sdk_example_simple";
+    private static final String COLLECTION_NAME = "java_sdk_example_simple_v1";
     private static final String ID_FIELD = "book_id";
     private static final String VECTOR_FIELD = "book_intro";
     private static final String TITLE_FIELD = "book_title";

examples/main/java/io/milvus/v1/SparseVectorExample.java

@@ -37,7 +37,7 @@ import java.util.*;
 
 
 public class SparseVectorExample {
-    private static final String COLLECTION_NAME = "java_sdk_example_sparse_vector";
+    private static final String COLLECTION_NAME = "java_sdk_example_sparse_vector_v1";
     private static final String ID_FIELD = "id";
     private static final String VECTOR_FIELD = "vector";
 

examples/main/java/io/milvus/v2/Float16VectorExample.java

@@ -27,7 +27,7 @@ import java.util.*;
 
 
 public class Float16VectorExample {
-    private static final String COLLECTION_NAME = "java_sdk_example_float16_vector";
+    private static final String COLLECTION_NAME = "java_sdk_example_float16_vector_v2";
     private static final String ID_FIELD = "id";
     private static final String FP16_VECTOR_FIELD = "fp16_vector";
     private static final String BF16_VECTOR_FIELD = "bf16_vector";
@@ -145,6 +145,7 @@ public class Float16VectorExample {
             if (!vectorBuf.equals(targetVectors.get(i).getData())) {
                 throw new RuntimeException("The top1 output vector is incorrect");
             }
+            System.out.println(results.get(0));
         }
         System.out.println("Search result of float16 vector is correct");
     }

examples/main/java/io/milvus/v2/IteratorExample.java

@@ -26,7 +26,7 @@ import io.milvus.v2.service.vector.response.QueryResp;
 import java.util.*;
 
 public class IteratorExample {
-    private static final String COLLECTION_NAME = "java_sdk_example_iterator";
+    private static final String COLLECTION_NAME = "java_sdk_example_iterator_v2";
     private static final String ID_FIELD = "userID";
     private static final String AGE_FIELD = "userAge";
     private static final String VECTOR_FIELD = "userFace";

examples/main/java/io/milvus/v2/SimpleExample.java

@@ -19,7 +19,7 @@ public class SimpleExample {
                 .build();
         MilvusClientV2 client = new MilvusClientV2(config);
 
-        String collectionName = "java_sdk_example_simple";
+        String collectionName = "java_sdk_example_simple_v2";
         // drop collection if exists
         client.dropCollection(DropCollectionReq.builder()
                 .collectionName(collectionName)
@@ -81,7 +81,7 @@ public class SimpleExample {
         System.out.println("\nSearch results:");
         for (List<SearchResp.SearchResult> results : searchResults) {
             for (SearchResp.SearchResult result : results) {
-                System.out.printf("ID: %d, Distance: %f, %s\n", (long)result.getId(), result.getDistance(), result.getEntity().toString());
+                System.out.printf("ID: %d, Score: %f, %s\n", (long)result.getId(), result.getScore(), result.getEntity().toString());
             }
         }
     }

src/main/java/io/milvus/orm/iterator/SearchIterator.java

@@ -468,7 +468,7 @@ public class SearchIterator {
     }
 
     private float getDistance(QueryResultsWrapper.RowRecord record) {
-        return (float) record.get("distance");
+        return (float) record.get("score");
     }
 
     // Avoiding precision loss when converting to exponent notation.

src/main/java/io/milvus/response/SearchResultsWrapper.java

@@ -87,7 +87,7 @@ public class SearchResultsWrapper extends RowRecordWrapper {
                 record.put("id", score.getStrID());
             }
 
-            record.put("distance", score.getScore());
+            record.put("score", score.getScore()); // use score instead
             buildRowRecord(record, i);
             records.add(record);
         }
@@ -156,7 +156,7 @@ public class SearchResultsWrapper extends RowRecordWrapper {
 
         List<IDScore> idScores = new ArrayList<>();
 
-        // set id and distance
+        // set id and score
         IDs ids = results.getIds();
         if (ids.hasIntId()) {
             LongArray longIDs = ids.getIntId();

src/main/java/io/milvus/v2/service/vector/response/SearchResp.java

@@ -34,7 +34,7 @@ public class SearchResp {
     @SuperBuilder
     public static class SearchResult {
         private Map<String, Object> entity;
-        private Float distance;
+        private Float score;
         private Object id;
     }
 }

src/main/java/io/milvus/v2/utils/ConvertUtils.java

@@ -65,7 +65,7 @@ public class ConvertUtils {
         for (int i = 0; i < numQueries; i++) {
             searchResults.add(searchResultsWrapper.getIDScore(i).stream().map(idScore -> SearchResp.SearchResult.builder()
                     .entity(idScore.getFieldValues())
-                    .distance(idScore.getScore())
+                    .score(idScore.getScore())
                     .id(idScore.getStrID().isEmpty() ? idScore.getLongID() : idScore.getStrID())
                     .build()).collect(Collectors.toList()));
         }

src/test/java/io/milvus/client/MilvusClientDockerTest.java

@@ -83,7 +83,7 @@ class MilvusClientDockerTest {
     protected static final Gson GSON_INSTANCE = new Gson();
 
     @Container
-    private static final MilvusContainer milvus = new MilvusContainer("milvusdb/milvus:2.4-20240605-443197bd-amd64");
+    private static final MilvusContainer milvus = new MilvusContainer("milvusdb/milvus:v2.4.4");
 
     @BeforeAll
     public static void setUp() {

src/test/java/io/milvus/v2/client/MilvusClientV2DockerTest.java

@@ -1361,9 +1361,9 @@ class MilvusClientV2DockerTest {
             }
 
             for (QueryResultsWrapper.RowRecord record : res) {
-                Assertions.assertInstanceOf(Float.class, record.get("distance"));
-                Assertions.assertTrue((float)record.get("distance") >= 5.0);
-                Assertions.assertTrue((float)record.get("distance") <= 50.0);
+                Assertions.assertInstanceOf(Float.class, record.get("score"));
+                Assertions.assertTrue((float)record.get("score") >= 5.0);
+                Assertions.assertTrue((float)record.get("score") <= 50.0);
 
                 Assertions.assertInstanceOf(Boolean.class, record.get("bool_field"));
                 Assertions.assertInstanceOf(Integer.class, record.get("int8_field"));
@@ -1407,7 +1407,7 @@ class MilvusClientV2DockerTest {
                 counter++;
             }
         }
-        System.out.println(String.format("There are %d items match distance between [5.0, 50.0]", counter));
+        System.out.println(String.format("There are %d items match score between [5.0, 50.0]", counter));
 
         // query iterator
         QueryIterator queryIterator = client.queryIterator(QueryIteratorReq.builder()