Merge pull request milvus-io#28 from youny626/branch-0.5.0

add examples

CHANGELOG.md

@@ -20,3 +20,4 @@
 - \#1: First implementation
 - \#21: Add javadoc
 - \#23: Format code with Google-java-style and add Apache 2.0 license header
+- \#28: add examples

examples/examples.iml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4" />

examples/pom.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ 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.
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>io.milvus</groupId>
+    <artifactId>milvus-sdk-java-examples</artifactId>
+    <version>0.1.1</version>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>8</source>
+                    <target>8</target>
+                </configuration>
+                <version>3.8.1</version>
+            </plugin>
+        </plugins>
+    </build>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.milvus</groupId>
+            <artifactId>milvus-sdk-java</artifactId>
+            <version>0.1.1</version>
+        </dependency>
+    </dependencies>
+
+</project>

examples/src/main/java/MilvusClientExample.java

@@ -0,0 +1,152 @@
+/*
+ * 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.
+ */
+
+import io.milvus.client.*;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Random;
+import java.util.concurrent.TimeUnit;
+import java.util.stream.Collectors;
+
+public class MilvusClientExample {
+
+  // Helper function that normalizes a vector if you are using IP (Inner product) as your metric
+  // type
+  static List<Float> normalize(List<Float> vector) {
+    float squareSum = vector.stream().map(x -> x * x).reduce((float) 0, Float::sum);
+    final float norm = (float) Math.sqrt(squareSum);
+    vector = vector.stream().map(x -> x / norm).collect(Collectors.toList());
+    return vector;
+  }
+
+  public static void main(String[] args) throws InterruptedException {
+
+    final String host = "localhost";
+    final String port = "19530";
+
+    // Create Milvus client
+    MilvusClient client = new MilvusGrpcClient();
+
+    // Connect to Milvus server
+    ConnectParam connectParam = new ConnectParam.Builder().withHost(host).withPort(port).build();
+    Response connectResponse = client.connect(connectParam);
+    System.out.println(connectResponse);
+
+    // Check whether we are connected
+    boolean connected = client.connected();
+    System.out.println("Connected = " + connected);
+
+    // Create a table with the following table schema
+    final String tableName = "example";
+    final long dimension = 128;
+    final long indexFileSize = 1024;
+    final MetricType metricType = MetricType.IP;
+    TableSchema tableSchema =
+        new TableSchema.Builder(tableName, dimension)
+            .withIndexFileSize(indexFileSize)
+            .withMetricType(metricType)
+            .build();
+    TableSchemaParam tableSchemaParam =
+        new TableSchemaParam.Builder(tableSchema).withTimeout(10).build();
+    Response createTableResponse = client.createTable(tableSchemaParam);
+    System.out.println(createTableResponse);
+
+    // Check whether the table exists
+    TableParam hasTableParam = new TableParam.Builder(tableName).withTimeout(1).build();
+    HasTableResponse hasTableResponse = client.hasTable(hasTableParam);
+    System.out.println(hasTableResponse);
+
+    // Describe the table
+    TableParam describeTableParam = new TableParam.Builder(tableName).withTimeout(1).build();
+    DescribeTableResponse describeTableResponse = client.describeTable(describeTableParam);
+    System.out.println(describeTableResponse);
+
+    // Insert randomly generated vectors to table
+    final int vectorCount = 1024;
+    Random random = new Random();
+    List<List<Float>> vectors = new ArrayList<>();
+    for (int i = 0; i < vectorCount; ++i) {
+      List<Float> vector = new ArrayList<>();
+      for (int j = 0; j < dimension; ++j) {
+        vector.add(random.nextFloat());
+      }
+      vector = normalize(vector);
+      vectors.add(vector);
+    }
+    InsertParam insertParam = new InsertParam.Builder(tableName, vectors).withTimeout(10).build();
+    InsertResponse insertResponse = client.insert(insertParam);
+    System.out.println(insertResponse);
+    // Insert returns a list of vector ids that you will be using (if you did not supply them
+    // yourself) to reference the vectors you just inserted
+    List<Long> vectorIds = insertResponse.getVectorIds();
+
+    // Sleep for 1 second
+    TimeUnit.SECONDS.sleep(1);
+
+    // Get current row count of table
+    TableParam getTableRowCountParam = new TableParam.Builder(tableName).withTimeout(1).build();
+    GetTableRowCountResponse getTableRowCountResponse =
+        client.getTableRowCount(getTableRowCountParam);
+    System.out.println(getTableRowCountResponse);
+
+    // Create index for the table
+    final IndexType indexType = IndexType.IVF_SQ8;
+    Index index = new Index.Builder().withIndexType(IndexType.IVF_SQ8).build();
+    CreateIndexParam createIndexParam =
+        new CreateIndexParam.Builder(tableName).withIndex(index).withTimeout(10).build();
+    Response createIndexResponse = client.createIndex(createIndexParam);
+    System.out.println(createIndexResponse);
+
+    // Describe the index for your table
+    TableParam describeIndexParam = new TableParam.Builder(tableName).withTimeout(1).build();
+    DescribeIndexResponse describeIndexResponse = client.describeIndex(describeIndexParam);
+    System.out.println(describeIndexResponse);
+
+    // Search vectors
+    final int searchSize = 5;
+    // Searching the first 5 vectors of the vectors we just inserted
+    List<List<Float>> vectorsToSearch = vectors.subList(0, searchSize);
+    final long topK = 10;
+    SearchParam searchParam =
+        new SearchParam.Builder(tableName, vectorsToSearch).withTopK(topK).withTimeout(10).build();
+    SearchResponse searchResponse = client.search(searchParam);
+    System.out.println(searchResponse);
+    List<List<SearchResponse.QueryResult>> queryResultsList = searchResponse.getQueryResultsList();
+    final double epsilon = 0.001;
+    for (int i = 0; i < searchSize; i++) {
+      // Since we are searching for vector that is already present in the table,
+      // the first result vector should be itself and the distance should be less than epsilon
+      assert queryResultsList.get(i).get(0).getVectorId() == vectorIds.get(0);
+      assert queryResultsList.get(i).get(0).getDistance() < epsilon;
+    }
+
+    // Drop index for the table
+    TableParam dropIndexParam = new TableParam.Builder(tableName).withTimeout(1).build();
+    Response dropIndexResponse = client.dropIndex(dropIndexParam);
+    System.out.println(dropIndexResponse);
+
+    // Drop table
+    TableParam dropTableParam = new TableParam.Builder(tableName).withTimeout(1).build();
+    Response dropTableResponse = client.dropTable(dropTableParam);
+    System.out.println(dropTableResponse);
+
+    // Disconnect from Milvus server
+    Response disconnectResponse = client.disconnect();
+    System.out.println(disconnectResponse);
+  }
+}