Deprecate topK for search/hybridSearch/iterator, replaced with limit (milvus-io#1438)

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

Author: yhmo

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

@@ -157,7 +157,7 @@ public static void main(String[] args) {
             R<SearchResults> searchRet = milvusClient.search(SearchParam.newBuilder()
                     .withCollectionName(COLLECTION_NAME)
                     .withMetricType(MetricType.HAMMING)
-                    .withTopK(3)
+                    .withLimit(3L)
                     .withBinaryVectors(Collections.singletonList(targetVector))
                     .withVectorFieldName(VECTOR_FIELD)
                     .addOutField(VECTOR_FIELD)

examples/src/main/java/io/milvus/v1/ClientPoolExample.java

@@ -163,7 +163,7 @@ public static Thread runSearchThread(MilvusClientV1Pool pool, String clientName,
                     R<SearchResults> searchRet = client.search(SearchParam.newBuilder()
                             .withCollectionName(CollectionName)
                             .withMetricType(MetricType.L2)
-                            .withTopK(10)
+                            .withLimit(10L)
                             .withFloatVectors(Collections.singletonList(CommonUtils.generateFloatVector(DIM)))
                             .withVectorFieldName(VectorFieldName)
                             .withParams("{}")

examples/src/main/java/io/milvus/v1/ConsistencyLevelExample.java

@@ -137,7 +137,7 @@ private static List<SearchResultsWrapper.IDScore> search(String collectionName,
                 .withCollectionName(collectionName)
                 .withVectorFieldName("vector")
                 .withFloatVectors(Collections.singletonList(CommonUtils.generateFloatVector(VECTOR_DIM)))
-                .withTopK(topK)
+                .withLimit((long)topK)
                 .withMetricType(MetricType.L2)
                 .build());
         CommonUtils.handleResponseStatus(searchR);
@@ -204,7 +204,7 @@ private static void testSessionLevel() throws ClassNotFoundException, NoSuchMeth
                     .withCollectionName(collectionName)
                     .withVectorFieldName("vector")
                     .withFloatVectors(Collections.singletonList(vector))
-                    .withTopK(1)
+                    .withLimit(1L)
                     .withMetricType(MetricType.L2)
                     .build());
             pool.returnClient(clientName2, client2); // don't forget to return the client to pool

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

@@ -184,7 +184,7 @@ private static void testFloat16(boolean bfloat16) {
             SearchParam.Builder builder = SearchParam.newBuilder()
                     .withCollectionName(COLLECTION_NAME)
                     .withMetricType(MetricType.L2)
-                    .withTopK(3)
+                    .withLimit(3L)
                     .withVectorFieldName(VECTOR_FIELD)
                     .addOutField(VECTOR_FIELD)
                     .withParams("{\"nprobe\":32}");

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

@@ -64,7 +64,7 @@ public class GeneralExample {
     private static final IndexType INDEX_TYPE = IndexType.IVF_FLAT;
     private static final String INDEX_PARAM = "{\"nlist\":128}";
 
-    private static final Integer SEARCH_K = 5;
+    private static final Long SEARCH_K = 5L;
     private static final String SEARCH_PARAM = "{\"nprobe\":10}";
 
 
@@ -331,7 +331,7 @@ private R<SearchResults> searchFace(String expr) {
                 .withCollectionName(COLLECTION_NAME)
                 .withMetricType(MetricType.L2)
                 .withOutFields(outFields)
-                .withTopK(SEARCH_K)
+                .withLimit(SEARCH_K)
                 .withFloatVectors(vectors)
                 .withVectorFieldName(VECTOR_FIELD)
                 .withExpr(expr)

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

@@ -226,30 +226,30 @@ private void hybridSearch() {
                 .withFloatVectors(CommonUtils.generateFloatVectors(FLOAT_VECTOR_DIM, NQ))
                 .withMetricType(FLOAT_VECTOR_METRIC)
                 .withParams("{\"nprobe\": 32}")
-                .withTopK(10)
+                .withLimit(10L)
                 .build();
 
         AnnSearchParam req2 = AnnSearchParam.newBuilder()
                 .withVectorFieldName(BINARY_VECTOR_FIELD)
                 .withBinaryVectors(CommonUtils.generateBinaryVectors(BINARY_VECTOR_DIM, NQ))
                 .withMetricType(BINARY_VECTOR_METRIC)
-                .withTopK(15)
+                .withLimit(15L)
                 .build();
 
         AnnSearchParam req3 = AnnSearchParam.newBuilder()
                 .withVectorFieldName(FLOAT16_VECTOR_FIELD)
                 .withFloat16Vectors(CommonUtils.generateFloat16Vectors(FLOAT16_VECTOR_DIM, NQ, false))
                 .withMetricType(FLOAT16_VECTOR_METRIC)
                 .withParams("{\"ef\":64}")
-                .withTopK(20)
+                .withLimit(20L)
                 .build();
 
         AnnSearchParam req4 = AnnSearchParam.newBuilder()
                 .withVectorFieldName(SPARSE_VECTOR_FIELD)
                 .withSparseFloatVectors(CommonUtils.generateSparseVectors(NQ))
                 .withMetricType(SPARSE_VECTOR_METRIC)
                 .withParams("{\"drop_ratio_search\":0.2}")
-                .withTopK(20)
+                .withLimit(20L)
                 .build();
 
         HybridSearchParam searchParam = HybridSearchParam.newBuilder()
@@ -262,7 +262,7 @@ private void hybridSearch() {
                 .addSearchRequest(req2)
                 .addSearchRequest(req3)
                 .addSearchRequest(req4)
-                .withTopK(5)
+                .withLimit(5L)
                 .withConsistencyLevel(ConsistencyLevelEnum.STRONG)
                 .withRanker(RRFRanker.newBuilder()
                         .withK(2)

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

@@ -239,16 +239,18 @@ private void searchIteratorCollectionWithLimit() {
 
     private void iterateQueryResult(QueryIterator queryIterator) {
         int pageIdx = 0;
+        int iterateCount = 0;
         while (true) {
             List<QueryResultsWrapper.RowRecord> res = queryIterator.next();
             if (res.isEmpty()) {
-                System.out.println("query iteration finished, close");
+                System.out.printf("query iteration finished, %d rows iterated, iterator close\n", iterateCount);
                 queryIterator.close();
                 break;
             }
 
             for (QueryResultsWrapper.RowRecord re : res) {
                 System.out.println(re);
+                iterateCount++;
             }
             pageIdx++;
             System.out.printf("page%s-------------------------%n", pageIdx);
@@ -257,16 +259,18 @@ private void iterateQueryResult(QueryIterator queryIterator) {
 
     private void iterateSearchResult(SearchIterator searchIterator) {
         int pageIdx = 0;
+        int iterateCount = 0;
         while (true) {
             List<QueryResultsWrapper.RowRecord> res = searchIterator.next();
             if (res.isEmpty()) {
-                System.out.println("search iteration finished, close");
+                System.out.printf("search iteration finished, %d rows iterated, iterator close\n", iterateCount);
                 searchIterator.close();
                 break;
             }
 
             for (QueryResultsWrapper.RowRecord re : res) {
                 System.out.println(re);
+                iterateCount++;
             }
             pageIdx++;
             System.out.printf("page%s-------------------------%n", pageIdx);
@@ -302,7 +306,7 @@ private SearchIterator getSearchIterator(List<List<Float>> vectors, Long batchSi
                 .withMetricType(MetricType.L2);
 
         if (topK != null) {
-            searchIteratorParamBuilder.withTopK(topK);
+            searchIteratorParamBuilder.withLimit(topK.longValue());
         }
 
         R<SearchIterator> response = milvusClient.searchIterator(searchIteratorParamBuilder.build());

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

@@ -144,8 +144,8 @@ public static void main(String[] args) {
         R<SearchResults> searchRet = milvusClient.search(SearchParam.newBuilder()
                 .withCollectionName(COLLECTION_NAME)
                 .withMetricType(MetricType.L2)
-                .withTopK(5)
-                .withFloatVectors(Arrays.asList(vector))
+                .withLimit(5L)
+                .withFloatVectors(Collections.singletonList(vector))
                 .withVectorFieldName(VECTOR_FIELD)
                 .withParams("{}")
                 .addOutField(VECTOR_FIELD)

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

@@ -153,7 +153,7 @@ public static void main(String[] args) {
             R<SearchResults> searchRet = milvusClient.search(SearchParam.newBuilder()
                     .withCollectionName(COLLECTION_NAME)
                     .withMetricType(MetricType.IP)
-                    .withTopK(3)
+                    .withLimit(3L)
                     .withSparseFloatVectors(Collections.singletonList(targetVector))
                     .withVectorFieldName(VECTOR_FIELD)
                     .addOutField(VECTOR_FIELD)

examples/src/main/java/io/milvus/v2/BinaryVectorExample.java

@@ -136,7 +136,7 @@ public static void main(String[] args) {
                     .annsField(VECTOR_FIELD)
                     .outputFields(Collections.singletonList(VECTOR_FIELD))
                     .searchParams(params)
-                    .topK(3)
+                    .limit(3)
                     .build());
 
             // The search() allows multiple target vectors to search in a batch.