Add example for struct field

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

@@ -0,0 +1,244 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package io.milvus.v2;
+
+import com.google.gson.JsonArray;
+import com.google.gson.JsonObject;
+import io.milvus.common.utils.JsonUtils;
+import io.milvus.v1.CommonUtils;
+import io.milvus.v2.client.ConnectConfig;
+import io.milvus.v2.client.MilvusClientV2;
+import io.milvus.v2.common.ConsistencyLevel;
+import io.milvus.v2.common.DataType;
+import io.milvus.v2.common.IndexParam;
+import io.milvus.v2.service.collection.request.AddFieldReq;
+import io.milvus.v2.service.collection.request.CreateCollectionReq;
+import io.milvus.v2.service.collection.request.DropCollectionReq;
+import io.milvus.v2.service.collection.request.LoadCollectionReq;
+import io.milvus.v2.service.index.request.CreateIndexReq;
+import io.milvus.v2.service.vector.request.InsertReq;
+import io.milvus.v2.service.vector.request.QueryReq;
+import io.milvus.v2.service.vector.request.SearchReq;
+import io.milvus.v2.service.vector.request.data.BaseVector;
+import io.milvus.v2.service.vector.request.data.EmbeddingList;
+import io.milvus.v2.service.vector.request.data.FloatVec;
+import io.milvus.v2.service.vector.response.InsertResp;
+import io.milvus.v2.service.vector.response.QueryResp;
+import io.milvus.v2.service.vector.response.SearchResp;
+
+import java.util.*;
+
+public class StructExample {
+    private static final MilvusClientV2 client;
+    static {
+        client = new MilvusClientV2(ConnectConfig.builder()
+                .uri("http://localhost:19530")
+                .build());
+    }
+
+    private static final String COLLECTION_NAME = "java_sdk_example_struct_v2";
+    private static final String ID_FIELD = "id";
+    private static final String NAME_FIELD = "film_name";
+    private static final String STRUCT_FIELD = "clips";
+    private static final String FRAME_FIELD = "frame_number";
+    private static final String CLIP_VECTOR_FIELD = "clip_embedding";
+    private static final String DESC_FIELD = "clip_desc";
+    private static final String DESC_VECTOR_FIELD = "description_embedding";
+    private static final Integer VECTOR_DIM = 4;
+
+    private static void createCollection() {
+        CreateCollectionReq.CollectionSchema collectionSchema = CreateCollectionReq.CollectionSchema.builder()
+                .build();
+        collectionSchema.addField(AddFieldReq.builder()
+                .fieldName(ID_FIELD)
+                .dataType(DataType.Int64)
+                .isPrimaryKey(true)
+                .build());
+        collectionSchema.addField(AddFieldReq.builder()
+                .fieldName(NAME_FIELD)
+                .dataType(DataType.VarChar)
+                .maxLength(1024)
+                .build());
+        // define struct field schema, note that each name of sub-field must be unique in the entire collection
+        collectionSchema.addField(AddFieldReq.builder()
+                .fieldName(STRUCT_FIELD)
+                .description("clips of a film")
+                .dataType(DataType.Array)
+                .elementType(DataType.Struct)
+                .maxCapacity(100)
+                .addStructField(AddFieldReq.builder()
+                        .fieldName(FRAME_FIELD)
+                        .description("from which frame this clip begin")
+                        .dataType(DataType.Int32)
+                        .build())
+                .addStructField(AddFieldReq.builder()
+                        .fieldName(CLIP_VECTOR_FIELD)
+                        .description("embedding of a clip")
+                        .dataType(DataType.FloatVector)
+                        .dimension(VECTOR_DIM)
+                        .build())
+                .addStructField(AddFieldReq.builder()
+                        .fieldName(DESC_FIELD)
+                        .description("description of a clip")
+                        .dataType(DataType.VarChar)
+                        .maxLength(1024)
+                        .build())
+                .addStructField(AddFieldReq.builder()
+                        .fieldName(DESC_VECTOR_FIELD)
+                        .description("embedding of description")
+                        .dataType(DataType.FloatVector)
+                        .dimension(VECTOR_DIM)
+                        .build())
+                .build());
+
+        client.dropCollection(DropCollectionReq.builder()
+                .collectionName(COLLECTION_NAME)
+                .build());
+
+        CreateCollectionReq requestCreate = CreateCollectionReq.builder()
+                .collectionName(COLLECTION_NAME)
+                .collectionSchema(collectionSchema)
+                .build();
+        client.createCollection(requestCreate);
+
+        // struct vector uses special index/metric type
+        List<IndexParam> indexParams = new ArrayList<>();
+        indexParams.add(IndexParam.builder()
+                .fieldName(CLIP_VECTOR_FIELD)
+                .indexName("index_1")
+                .indexType(IndexParam.IndexType.EMB_LIST_HNSW)
+                .metricType(IndexParam.MetricType.MAX_SIM)
+                .build());
+        indexParams.add(IndexParam.builder()
+                .fieldName(DESC_VECTOR_FIELD)
+                .indexName("index_2")
+                .indexType(IndexParam.IndexType.EMB_LIST_HNSW)
+                .metricType(IndexParam.MetricType.MAX_SIM)
+                .build());
+        client.createIndex(CreateIndexReq.builder()
+                .collectionName(COLLECTION_NAME)
+                .indexParams(indexParams)
+                .build());
+        client.loadCollection(LoadCollectionReq.builder()
+                .collectionName(COLLECTION_NAME)
+                .build());
+        System.out.println("Collection created: " + COLLECTION_NAME);
+    }
+
+    private static void insertData(int rowCount) {
+        final int batchSize = 300;
+        int insertedCount = 0;
+        Random ran = new Random();
+        while (insertedCount < rowCount) {
+            int nextBatch = batchSize;
+            int leftCount = rowCount - insertedCount;
+            if (nextBatch > leftCount) {
+                nextBatch = leftCount;
+            }
+            List<JsonObject> rows = new ArrayList<>();
+            for (int i = 0; i < nextBatch; i++) {
+                JsonObject row = new JsonObject();
+                int id = insertedCount + i;
+                row.addProperty(ID_FIELD, id);
+                row.addProperty(NAME_FIELD, "film_" + id);
+                JsonArray structArr = new JsonArray();
+                for (int k = 0; k < 5; k++) {
+                    JsonObject struct = new JsonObject();
+                    struct.addProperty(FRAME_FIELD, ran.nextInt(1000000));
+                    struct.add(CLIP_VECTOR_FIELD, JsonUtils.toJsonTree(CommonUtils.generateFloatVector(VECTOR_DIM)));
+                    struct.addProperty(DESC_FIELD, "clip_description_" + id);
+                    struct.add(DESC_VECTOR_FIELD, JsonUtils.toJsonTree(CommonUtils.generateFloatVector(VECTOR_DIM)));
+                    structArr.add(struct);
+                }
+                row.add(STRUCT_FIELD, structArr);
+                rows.add(row);
+            }
+
+            InsertResp insertResp = client.insert(InsertReq.builder()
+                    .collectionName(COLLECTION_NAME)
+                    .data(rows)
+                    .build());
+            insertedCount += (int) insertResp.getInsertCnt();
+            System.out.println("Inserted row count: " + insertResp.getInsertCnt());
+        }
+
+        QueryResp countR = client.query(QueryReq.builder()
+                .collectionName(COLLECTION_NAME)
+                .outputFields(Collections.singletonList("count(*)"))
+                .consistencyLevel(ConsistencyLevel.STRONG)
+                .build());
+        System.out.printf("%d rows persisted\n", (long)countR.getQueryResults().get(0).getEntity().get("count(*)"));
+
+    }
+    private static void query(String filter) {
+        System.out.println("===================================================");
+        System.out.println("Query with filter expression: " + filter);
+        QueryResp queryResp = client.query(QueryReq.builder()
+                .collectionName(COLLECTION_NAME)
+                .filter(filter)
+                .consistencyLevel(ConsistencyLevel.BOUNDED)
+                .outputFields(Collections.singletonList(STRUCT_FIELD))
+                .build());
+        List<QueryResp.QueryResult> queryResults = queryResp.getQueryResults();
+        for (QueryResp.QueryResult result : queryResults) {
+            System.out.println(result.getEntity());
+        }
+    }
+
+    private static void search(String annsField, int nq, int targetVectorsPerNQ) {
+        System.out.println("===================================================");
+        String msg = String.format("Search on field '%s' with nq=%d and vectors_per_nq=%d", annsField, nq, targetVectorsPerNQ);
+        System.out.println(msg);
+        List<BaseVector> searchData = new ArrayList<>();
+        for (int i = 0; i < nq; i++) {
+            EmbeddingList embList = new EmbeddingList();
+            for (int k = 0; k < targetVectorsPerNQ; k++) {
+                embList.add(new FloatVec(CommonUtils.generateFloatVector(VECTOR_DIM)));
+            }
+            searchData.add(embList);
+        }
+
+        int topK = 5;
+        SearchResp searchResp = client.search(SearchReq.builder()
+                .collectionName(COLLECTION_NAME)
+                .annsField(annsField)
+                .data(searchData)
+                .limit(topK)
+                .consistencyLevel(ConsistencyLevel.BOUNDED)
+                .outputFields(Arrays.asList(NAME_FIELD, FRAME_FIELD, DESC_FIELD))
+                .build());
+        List<List<SearchResp.SearchResult>> searchResults = searchResp.getSearchResults();
+        for (int i = 0; i < searchResults.size(); i++) {
+            System.out.println("Results of No." + i + " embedding list");
+            List<SearchResp.SearchResult> results = searchResults.get(i);
+            for (SearchResp.SearchResult result : results) {
+                System.out.println(result);
+            }
+        }
+    }
+
+    public static void main(String[] args) {
+        createCollection();
+        insertData(2000);
+        query(ID_FIELD + " <= 5");
+        search(CLIP_VECTOR_FIELD, 2, 3);
+        search(DESC_VECTOR_FIELD, 1, 5);
+    }
+}

sdk-core/src/test/java/io/milvus/v2/client/MilvusClientV2DockerTest.java

@@ -1132,7 +1132,6 @@ void testStruct() {
         Assertions.assertEquals(IndexParam.MetricType.MAX_SIM, desc.getMetricType());
 
         // insert
-        Random RANDOM = new Random();
         List<JsonObject> rows = new ArrayList<>();
         int count = 20;
         for (int i = 0; i < count; i++) {