Browse Source

Java API Reference Revision (#230)

Signed-off-by: LocoRichard <lichen.wang@zilliz.com>
LocoRichard 3 years ago
parent
commit
f51a130913
53 changed files with 308 additions and 300 deletions
  1. 4 4
      src/main/java/io/milvus/Response/FieldDataWrapper.java
  2. 2 2
      src/main/java/io/milvus/Response/GetCollStatResponseWrapper.java
  3. 8 8
      src/main/java/io/milvus/Response/InsertResultWrapper.java
  4. 2 2
      src/main/java/io/milvus/Response/QueryResultsWrapper.java
  5. 7 7
      src/main/java/io/milvus/Response/SearchResultsWrapper.java
  6. 2 2
      src/main/java/io/milvus/client/AbstractMilvusGrpcClient.java
  7. 49 41
      src/main/java/io/milvus/client/MilvusClient.java
  8. 1 1
      src/main/java/io/milvus/exception/ClientNotConnectedException.java
  9. 2 2
      src/main/java/io/milvus/exception/IllegalResponseException.java
  10. 1 1
      src/main/java/io/milvus/exception/ParamException.java
  11. 18 18
      src/main/java/io/milvus/param/ConnectParam.java
  12. 1 1
      src/main/java/io/milvus/param/IndexType.java
  13. 1 1
      src/main/java/io/milvus/param/MetricType.java
  14. 2 2
      src/main/java/io/milvus/param/ParamUtils.java
  15. 7 7
      src/main/java/io/milvus/param/R.java
  16. 2 2
      src/main/java/io/milvus/param/RpcStatus.java
  17. 4 4
      src/main/java/io/milvus/param/alias/AlterAliasParam.java
  18. 4 4
      src/main/java/io/milvus/param/alias/CreateAliasParam.java
  19. 3 3
      src/main/java/io/milvus/param/alias/DropAliasParam.java
  20. 7 7
      src/main/java/io/milvus/param/collection/CreateCollectionParam.java
  21. 3 3
      src/main/java/io/milvus/param/collection/DescribeCollectionParam.java
  22. 3 3
      src/main/java/io/milvus/param/collection/DropCollectionParam.java
  23. 12 12
      src/main/java/io/milvus/param/collection/FieldType.java
  24. 11 11
      src/main/java/io/milvus/param/collection/FlushParam.java
  25. 4 4
      src/main/java/io/milvus/param/collection/GetCollectionStatisticsParam.java
  26. 3 3
      src/main/java/io/milvus/param/collection/HasCollectionParam.java
  27. 10 10
      src/main/java/io/milvus/param/collection/LoadCollectionParam.java
  28. 3 3
      src/main/java/io/milvus/param/collection/ReleaseCollectionParam.java
  29. 4 4
      src/main/java/io/milvus/param/collection/ShowCollectionsParam.java
  30. 3 3
      src/main/java/io/milvus/param/control/GetCompactionPlansParam.java
  31. 3 3
      src/main/java/io/milvus/param/control/GetCompactionStateParam.java
  32. 3 3
      src/main/java/io/milvus/param/control/GetMetricsParam.java
  33. 3 3
      src/main/java/io/milvus/param/control/GetPersistentSegmentInfoParam.java
  34. 3 3
      src/main/java/io/milvus/param/control/GetQuerySegmentInfoParam.java
  35. 7 7
      src/main/java/io/milvus/param/control/LoadBalanceParam.java
  36. 3 3
      src/main/java/io/milvus/param/control/ManualCompactionParam.java
  37. 6 6
      src/main/java/io/milvus/param/dml/CalcDistanceParam.java
  38. 5 5
      src/main/java/io/milvus/param/dml/DeleteParam.java
  39. 5 5
      src/main/java/io/milvus/param/dml/InsertParam.java
  40. 6 6
      src/main/java/io/milvus/param/dml/QueryParam.java
  41. 13 13
      src/main/java/io/milvus/param/dml/SearchParam.java
  42. 15 15
      src/main/java/io/milvus/param/index/CreateIndexParam.java
  43. 4 4
      src/main/java/io/milvus/param/index/DescribeIndexParam.java
  44. 4 4
      src/main/java/io/milvus/param/index/DropIndexParam.java
  45. 3 3
      src/main/java/io/milvus/param/index/GetIndexBuildProgressParam.java
  46. 4 4
      src/main/java/io/milvus/param/index/GetIndexStateParam.java
  47. 4 4
      src/main/java/io/milvus/param/partition/CreatePartitionParam.java
  48. 4 4
      src/main/java/io/milvus/param/partition/DropPartitionParam.java
  49. 4 4
      src/main/java/io/milvus/param/partition/GetPartitionStatisticsParam.java
  50. 4 4
      src/main/java/io/milvus/param/partition/HasPartitionParam.java
  51. 12 12
      src/main/java/io/milvus/param/partition/LoadPartitionsParam.java
  52. 5 5
      src/main/java/io/milvus/param/partition/ReleasePartitionsParam.java
  53. 5 5
      src/main/java/io/milvus/param/partition/ShowPartitionsParam.java

+ 4 - 4
src/main/java/io/milvus/Response/FieldDataWrapper.java

@@ -13,7 +13,7 @@ import java.util.List;
 import com.google.protobuf.ByteString;
 
 /**
- * Util class to wrap response of <code>query/search</code> interface.
+ * Utility class to wrap response of <code>query/search</code> interface.
  */
 public class FieldDataWrapper {
     private final FieldData fieldData;
@@ -27,7 +27,7 @@ public class FieldDataWrapper {
     }
 
     /**
-     * Get dimension of a vector field.
+     * Gets the dimension value of a vector field.
      * Throw {@link IllegalResponseException} if the field is not a vector filed.
      *
      * @return <code>int</code> dimension of the vector field
@@ -40,7 +40,7 @@ public class FieldDataWrapper {
     }
 
     /**
-     * Get row count of a field.
+     * Gets the row count of a field.
      * * Throws {@link IllegalResponseException} if the field type is illegal.
      *
      * @return <code>long</code> row count of the field
@@ -87,7 +87,7 @@ public class FieldDataWrapper {
     }
 
     /**
-     * Return field data according to its type:
+     * Returns the field data according to its type:
      *      float vector field return List<List<Float>>
      *      binary vector field return List<ByteBuffer>
      *      int64 field return List<Long>

+ 2 - 2
src/main/java/io/milvus/Response/GetCollStatResponseWrapper.java

@@ -7,7 +7,7 @@ import lombok.NonNull;
 import java.util.List;
 
 /**
- * Util class to wrap response of <code>getCollectionStatistics</code> interface.
+ * Utility class to wrap response of <code>getCollectionStatistics</code> interface.
  */
 public class GetCollStatResponseWrapper {
     private final GetCollectionStatisticsResponse stat;
@@ -17,7 +17,7 @@ public class GetCollStatResponseWrapper {
     }
 
     /**
-     * Get row count of this field.
+     * Gets the row count of a field.
      * Throw {@link NumberFormatException} if the row count is not a number.
      *
      * @return <code>int</code> dimension of the vector field

+ 8 - 8
src/main/java/io/milvus/Response/InsertResultWrapper.java

@@ -8,7 +8,7 @@ import java.util.List;
 import lombok.NonNull;
 
 /**
- * Util class to wrap response of <code>insert</code> interface.
+ * Utility class to wrap response of <code>insert</code> interface.
  */
 public class InsertResultWrapper {
     private final MutationResult result;
@@ -18,19 +18,19 @@ public class InsertResultWrapper {
     }
 
     /**
-     * Get inserted count.
+     * Gets the row count of the inserted entities.
      *
-     * @return <code>int</code> inserted count
+     * @return <code>int</code> row count of the inserted entities
      */
     public long getInsertCount() {
         return result.getInsertCnt();
     }
 
     /**
-     * Get long id array returned by insert interface.
+     * Gets the long ID array returned by insert interface.
      * Throw {@link ParamException} if the primary key type is not int64 type.
      *
-     * @return <code>List<Long></code> id array returned by insert interface
+     * @return <code>List<Long></code> ID array returned by insert interface
      */
     public List<Long> getLongIDs() throws ParamException {
         if (result.getIDs().hasIntId()) {
@@ -41,11 +41,11 @@ public class InsertResultWrapper {
     }
 
     /**
-     * Get string id array returned by insert interface.
+     * Gets the string ID array returned by insert interface.
      * Throw {@link ParamException} if the primary key type is not string type.
-     * Note that currently Milvus doesn't support string type field, this method is reserved.
+     * Note that current release of Milvus doesn't support string type field, thus this method is reserved.
      *
-     * @return <code>List<String></code> id array returned by insert interface
+     * @return <code>List<String></code> ID array returned by insert interface
      */
     public List<String> getStringIDs() throws ParamException {
         if (result.getIDs().hasStrId()) {

+ 2 - 2
src/main/java/io/milvus/Response/QueryResultsWrapper.java

@@ -8,7 +8,7 @@ import lombok.NonNull;
 import java.util.List;
 
 /**
- * Util class to wrap response of <code>query</code> interface.
+ * Utility class to wrap response of <code>query</code> interface.
  */
 public class QueryResultsWrapper {
     private final QueryResults results;
@@ -18,7 +18,7 @@ public class QueryResultsWrapper {
     }
 
     /**
-     * Get {@link FieldDataWrapper} for a field.
+     * Gets {@link FieldDataWrapper} for a field.
      * Throws {@link ParamException} if the field doesn't exist.
      *
      * @return <code>FieldDataWrapper</code>

+ 7 - 7
src/main/java/io/milvus/Response/SearchResultsWrapper.java

@@ -10,7 +10,7 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
- * Util class to wrap response of <code>search</code> interface.
+ * Utility class to wrap response of <code>search</code> interface.
  */
 public class SearchResultsWrapper {
     private final SearchResultData results;
@@ -20,7 +20,7 @@ public class SearchResultsWrapper {
     }
 
     /**
-     * Get {@link FieldDataWrapper} for a field.
+     * Gets {@link FieldDataWrapper} for a field.
      * Throws {@link ParamException} if the field doesn't exist.
      *
      * @return <code>FieldDataWrapper</code>
@@ -37,11 +37,11 @@ public class SearchResultsWrapper {
     }
 
     /**
-     * Get id-score pairs returned by search interface.
-     * Throw {@link ParamException} if the indexOfTarget is illegal.
-     * Throw {@link IllegalResponseException} if the returned results is illegal.
+     * Gets ID-score pairs returned by search interface.
+     * Throws {@link ParamException} if the indexOfTarget is illegal.
+     * Throws {@link IllegalResponseException} if the returned results is illegal.
      *
-     * @return <code>List<IDScore></code> id-score pairs returned by search interface
+     * @return <code>List<IDScore></code> ID-score pairs returned by search interface
      */
     public List<IDScore> GetIDScore(int indexOfTarget) throws ParamException, IllegalResponseException {
         List<Long> kList = results.getTopksList();
@@ -97,7 +97,7 @@ public class SearchResultsWrapper {
     }
 
     /**
-     * Internal use class to wrap response of <code>search</code> interface.
+     * Internal-use class to wrap response of <code>search</code> interface.
      */
     @Getter
     public static final class IDScore {

+ 2 - 2
src/main/java/io/milvus/client/AbstractMilvusGrpcClient.java

@@ -690,8 +690,8 @@ public abstract class AbstractMilvusGrpcClient implements MilvusClient {
     }
 
     /**
-     * Currently we don't allow client call this method since server side has no compaction function
-     * Now this method is only internally used by getCollectionStatistics()
+     * Currently we do not support this method on client since compaction is not supported on server.
+     * Now it is only for internal use of getCollectionStatistics().
      */
 //    @Override
     private R<FlushResponse> flush(@NonNull FlushParam requestParam) {

+ 49 - 41
src/main/java/io/milvus/client/MilvusClient.java

@@ -36,7 +36,7 @@ import java.util.concurrent.TimeUnit;
 /** The Milvus Client Interface */
 public interface MilvusClient {
 
-    /** Close Milvus client channel, timeout: 1 minute */
+    /** Disconnects from a Milvus server with timeout of 1 minute */
     default void close() {
         try {
             close(TimeUnit.MINUTES.toSeconds(1));
@@ -46,14 +46,14 @@ public interface MilvusClient {
     }
 
     /**
-     * Close Milvus client channel.
+     * Disconnects from a Milvus server with configurable timeout.
      *
      * @param maxWaitSeconds timeout unit: second
      */
     void close(long maxWaitSeconds) throws InterruptedException;
 
     /**
-     * Check if a collection exists.
+     * Checks if a collection exists.
      *
      * @param requestParam {@link HasCollectionParam}
      * @return {status:result code, data: boolean, whether if has collection or not}
@@ -61,7 +61,7 @@ public interface MilvusClient {
     R<Boolean> hasCollection(HasCollectionParam requestParam);
 
     /**
-     * Create a collection in Milvus.
+     * Creates a collection in Milvus.
      *
      * @param requestParam {@link CreateCollectionParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -69,7 +69,7 @@ public interface MilvusClient {
     R<RpcStatus> createCollection(CreateCollectionParam requestParam);
 
     /**
-     * Drop a collection. Note that this drops all data in the collection.
+     * Drops a collection. Note that this method drops all data in the collection.
      *
      * @param requestParam {@link DropCollectionParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -77,7 +77,7 @@ public interface MilvusClient {
     R<RpcStatus> dropCollection(DropCollectionParam requestParam);
 
     /**
-     * Load collection to cache before search/query.
+     * Loads a collection to memory before search or query.
      *
      * @param requestParam {@link LoadCollectionParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -85,8 +85,8 @@ public interface MilvusClient {
     R<RpcStatus> loadCollection(LoadCollectionParam requestParam);
 
     /**
-     * Release a collection from cache to reduce cache usage. Note that you cannot
-     * search while the corresponding collection is unloaded.
+     * Releases a collection from memory to reduce memory usage. Note that you 
+     * cannot search while the corresponding collection is released from memory.
      *
      * @param requestParam {@link ReleaseCollectionParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -94,7 +94,7 @@ public interface MilvusClient {
     R<RpcStatus> releaseCollection(ReleaseCollectionParam requestParam);
 
     /**
-     * Show the details of a collection, e.g. name, schema.
+     * Shows the details of a collection, e.g. name, schema.
      *
      * @param requestParam {@link DescribeCollectionParam}
      * @return {status:result code, data:DescribeCollectionResponse{schema,collectionID}}
@@ -102,7 +102,7 @@ public interface MilvusClient {
     R<DescribeCollectionResponse> describeCollection(DescribeCollectionParam requestParam);
 
     /**
-     * Show the statistics information of a collection.
+     * Shows the statistics information of a collection.
      *
      * @param requestParam {@link GetCollectionStatisticsParam}
      * @return {status:result code, data: GetCollectionStatisticsResponse{status,stats}}
@@ -110,7 +110,7 @@ public interface MilvusClient {
     R<GetCollectionStatisticsResponse> getCollectionStatistics(GetCollectionStatisticsParam requestParam);
 
     /**
-     * List all collections or get collection loading status.
+     * Lists all collections or gets collection loading status.
      *
      * @param requestParam {@link ShowCollectionsParam}
      * @return {status:result code, data: ShowCollectionsResponse{status,collection_names,collection_ids,created_timestamps,created_utc_timestamps}}
@@ -118,8 +118,8 @@ public interface MilvusClient {
     R<ShowCollectionsResponse> showCollections(ShowCollectionsParam requestParam);
 
 //    /**
-//     * Flush collections.
-//     * Currently we don't allow client call this method since server side has no compaction function
+//     * Flushes collections.
+//     * Currently we do not support this method on client since compaction is not supported on server.
 //     *
 //     * @param requestParam {@link FlushParam}
 //     * @return {status:result code,data: FlushResponse{flush segment ids}}
@@ -127,7 +127,7 @@ public interface MilvusClient {
 //    R<FlushResponse> flush(FlushParam requestParam);
 
     /**
-     * Create a partition in a collection.
+     * Creates a partition in the specified collection.
      *
      * @param requestParam {@link CreatePartitionParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -135,7 +135,8 @@ public interface MilvusClient {
     R<RpcStatus> createPartition(CreatePartitionParam requestParam);
 
     /**
-     * To drop a partition will drop all data in this partition and the _default partition cannot be dropped.
+     * Drops a partition. Note that this method drops all data in this partition 
+     * and the _default partition cannot be dropped.
      *
      * @param requestParam {@link DropPartitionParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -143,7 +144,7 @@ public interface MilvusClient {
     R<RpcStatus> dropPartition(DropPartitionParam requestParam);
 
     /**
-     * Check if a partition exists in a collection.
+     * Checks if a partition exists in the specified collection.
      *
      * @param requestParam {@link HasPartitionParam}
      * @return {status:result code, data: boolean, whether if has collection or not}
@@ -151,7 +152,7 @@ public interface MilvusClient {
     R<Boolean> hasPartition(HasPartitionParam requestParam);
 
     /**
-     * Load a partition into cache.
+     * Loads a partition into memory.
      *
      * @param requestParam {@link LoadPartitionsParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -159,7 +160,7 @@ public interface MilvusClient {
     R<RpcStatus> loadPartitions(LoadPartitionsParam requestParam);
 
     /**
-     * Release a partition from cache.
+     * Releases a partition from memory.
      *
      * @param requestParam {@link ReleasePartitionsParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -167,7 +168,7 @@ public interface MilvusClient {
     R<RpcStatus> releasePartitions(ReleasePartitionsParam requestParam);
 
     /**
-     * Show the statistics information of a partition.
+     * Shows the statistics information of a partition.
      *
      * @param requestParam {@link GetPartitionStatisticsParam}
      * @return {status:result code,data:GetPartitionStatisticsResponse{status,stats}}
@@ -175,7 +176,7 @@ public interface MilvusClient {
     R<GetPartitionStatisticsResponse> getPartitionStatistics(GetPartitionStatisticsParam requestParam);
 
     /**
-     * Show all partitions in a collection.
+     * Shows all partitions in the specified collection.
      *
      * @param requestParam {@link ShowPartitionsParam}
      * @return {status:result code, data:ShowPartitionsResponse{partition_names,partitionIDs,created_timestamps,created_utc_timestamps}}
@@ -183,8 +184,8 @@ public interface MilvusClient {
     R<ShowPartitionsResponse> showPartitions(ShowPartitionsParam requestParam);
 
     /**
-     * Create an alias for a collection.
-     * Alias can be used in search/query to replace collection name
+     * Creates an alias for a collection.
+     * Alias can be used in search or query to replace the collection name
      *
      * @param requestParam {@link CreateAliasParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -192,7 +193,7 @@ public interface MilvusClient {
     R<RpcStatus> createAlias(CreateAliasParam requestParam);
 
     /**
-     * Drop an alias.
+     * Drops an alias for the specified collection.
      *
      * @param requestParam {@link DropAliasParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -200,7 +201,7 @@ public interface MilvusClient {
     R<RpcStatus> dropAlias(DropAliasParam requestParam);
 
     /**
-     * Alter alias from a collection to another.
+     * Alters alias from a collection to another.
      *
      * @param requestParam {@link AlterAliasParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -208,7 +209,8 @@ public interface MilvusClient {
     R<RpcStatus> alterAlias(AlterAliasParam requestParam);
 
     /**
-     * Create an index on a vector field. Note that index building is an async progress.
+     * Creates an index on a vector field in the specified collection.
+     * Note that index building is an async progress.
      *
      * @param requestParam {@link CreateIndexParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -216,7 +218,7 @@ public interface MilvusClient {
     R<RpcStatus> createIndex(CreateIndexParam requestParam);
 
     /**
-     * Drop an index.
+     * Drops the index on a vector field in the specified collection.
      *
      * @param requestParam {@link DropIndexParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -224,7 +226,8 @@ public interface MilvusClient {
     R<RpcStatus> dropIndex(DropIndexParam requestParam);
 
     /**
-     * Show index information. Current release of Milvus only supports showing latest built index.
+     * Shows the information of the specified index. Current release of Milvus 
+     * only supports showing latest built index.
      *
      * @param requestParam {@link DescribeIndexParam}
      * @return {status:result code, data:DescribeIndexResponse{status,index_descriptions}}
@@ -232,7 +235,7 @@ public interface MilvusClient {
     R<DescribeIndexResponse> describeIndex(DescribeIndexParam requestParam);
 
     /**
-     * Show index building state(in-progress/finished/failed), failed reason.
+     * Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).
      *
      * @param requestParam {@link GetIndexStateParam}
      * @return {status:result code, data:GetIndexStateResponse{status,state}}
@@ -240,7 +243,7 @@ public interface MilvusClient {
     R<GetIndexStateResponse> getIndexState(GetIndexStateParam requestParam);
 
     /**
-     * Show index building progress, such as how many rows are indexed.
+     * Shows the index building progress, such as how many rows are indexed.
      *
      * @param requestParam {@link GetIndexBuildProgressParam}
      * @return {status:result code, data:GetIndexBuildProgressResponse{status,indexed_rows}}
@@ -248,7 +251,8 @@ public interface MilvusClient {
     R<GetIndexBuildProgressResponse> getIndexBuildProgress(GetIndexBuildProgressParam requestParam);
 
     /**
-     * Insert entities into collection. Note that you don't need to input values for auto-id field.
+     * Inserts entities into a specified collection. Note that you don't need to 
+     * input primary key field if auto_id is enabled.
      *
      * @param requestParam {@link InsertParam}
      * @return {status:result code, data: MutationResult{insert results}}
@@ -256,7 +260,8 @@ public interface MilvusClient {
     R<MutationResult> insert(InsertParam requestParam);
 
     /**
-     * Delete entities by expression. Currently release of Milvus only support expression like "xxx in [1, 2, ...]"
+     * Deletes entity(s) based on primary key(s) filtered by boolean expression. Current release 
+     * of Milvus only supports expression in the format "pk_field in [1, 2, ...]"
      *
      * @param requestParam {@link DeleteParam}
      * @return {status:result code, data: MutationResult{delete results}}
@@ -264,7 +269,7 @@ public interface MilvusClient {
     R<MutationResult> delete(DeleteParam requestParam);
 
     /**
-     * Do ANN search base on a vector field. Use expression to do filtering before search.
+     * Conducts ANN search on a vector field. Use expression to do filtering before search.
      *
      * @param requestParam {@link SearchParam}
      * @return {status:result code, data: SearchResults{topK results}}
@@ -272,7 +277,8 @@ public interface MilvusClient {
     R<SearchResults> search(SearchParam requestParam);
 
     /**
-     * Query entities by expression. Note that the returned entities sequence cannot be guaranteed.
+     * Queries entity(s) based on scalar field(s) filtered by boolean expression. 
+     * Note that the order of the returned entities cannot be guaranteed.
      *
      * @param requestParam {@link QueryParam}
      * @return {status:result code,data: QueryResults{filter results}}
@@ -280,7 +286,7 @@ public interface MilvusClient {
     R<QueryResults> query(QueryParam requestParam);
 
     /**
-     * Calculate distance between specified vectors.
+     * Calculates the distance between the specified vectors.
      *
      * @param requestParam {@link CalcDistanceParam}
      * @return {status:result code, data: CalcDistanceResults{distances}}
@@ -288,7 +294,7 @@ public interface MilvusClient {
     R<CalcDistanceResults> calcDistance(CalcDistanceParam requestParam);
 
     /**
-     * Get runtime metrics information of Milvus, return in json format.
+     * Gets the runtime metrics information of Milvus, returns the result in .json format.
      *
      * @param requestParam {@link GetMetricsParam}
      * @return {status:result code, data:GetMetricsResponse{status,metrics}}
@@ -296,7 +302,8 @@ public interface MilvusClient {
     R<GetMetricsResponse> getMetrics(GetMetricsParam requestParam);
 
     /**
-     * Get information of persistent segments, including row count, persist state(growing or flushed), etc.
+     * Gets the information of persistent segments, including row count, 
+     * persistence state(growing or flushed), etc.
      *
      * @param requestParam {@link GetPersistentSegmentInfoParam}
      * @return {status:result code, data:GetPersistentSegmentInfoResponse{status,info}}
@@ -304,7 +311,8 @@ public interface MilvusClient {
     R<GetPersistentSegmentInfoResponse> getPersistentSegmentInfo(GetPersistentSegmentInfoParam requestParam);
 
     /**
-     * Get query information of segments in a collection, including row count, mem size, index name, etc.
+     * Gets the query information of segments in a collection, including row count, 
+     * memory usage size, index name, etc.
      *
      * @param requestParam {@link GetQuerySegmentInfoParam}
      * @return {status:result code, data:GetQuerySegmentInfoResponse{status,info}}
@@ -312,7 +320,7 @@ public interface MilvusClient {
     R<GetQuerySegmentInfoResponse> getQuerySegmentInfo(GetQuerySegmentInfoParam requestParam);
 
     /**
-     * Move segment from a query node to another, to keep load balance.
+     * Moves segment from a query node to another to keep the load balanced.
      *
      * @param requestParam {@link LoadBalanceParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
@@ -320,7 +328,7 @@ public interface MilvusClient {
     R<RpcStatus> loadBalance(LoadBalanceParam requestParam);
 
     /**
-     * Get compaction action state by id.
+     * Gets the compaction state by id.
      *
      * @param requestParam {@link GetCompactionStateParam}
      * @return {status:result code, data:GetCompactionStateResponse{status,info}}
@@ -328,7 +336,7 @@ public interface MilvusClient {
     R<GetCompactionStateResponse> getCompactionState(GetCompactionStateParam requestParam);
 
     /**
-     * Ask server to perform a compaction action.
+     * Performs a manual compaction.
      *
      * @param requestParam {@link ManualCompactionParam}
      * @return {status:result code, data:ManualCompactionResponse{status,info}}
@@ -336,7 +344,7 @@ public interface MilvusClient {
     R<ManualCompactionResponse> manualCompaction(ManualCompactionParam requestParam);
 
     /**
-     * Get compaction action state with its plan.
+     * Gets compaction state with its plan.
      *
      * @param requestParam {@link GetCompactionPlansParam}
      * @return {status:result code, data:GetCompactionPlansResponse{status,info}}

+ 1 - 1
src/main/java/io/milvus/exception/ClientNotConnectedException.java

@@ -22,7 +22,7 @@ package io.milvus.exception;
 import io.milvus.param.R;
 
 /**
- * Milvus client api throws this exception when client channel is closed.
+ * Milvus client API throws this exception when not connected to the Milvus server.
  */
 public class ClientNotConnectedException extends MilvusException {
     public ClientNotConnectedException(String msg) {

+ 2 - 2
src/main/java/io/milvus/exception/IllegalResponseException.java

@@ -23,8 +23,8 @@ package io.milvus.exception;
 import io.milvus.param.R;
 
 /**
- * Some interfaces including <code>search</code>/<code>search</code>/<code>loadCollection</code> can throw this exception
- * when server return illegal response, this may indicate a bug of server.
+ * Interfaces including <code>search</code>/<code>search</code>/<code>loadCollection</code> might 
+ * throw this exception when server return illegal response. It may indicate a bug in server.
  */
 public class IllegalResponseException extends MilvusException {
     public IllegalResponseException(String msg) {

+ 1 - 1
src/main/java/io/milvus/exception/ParamException.java

@@ -22,7 +22,7 @@ package io.milvus.exception;
 import io.milvus.param.R;
 
 /**
- * Exception for caller input illegal parameters.
+ * Exception for illegal parameters input.
  */
 public class ParamException extends MilvusException {
     public ParamException(String msg) {

+ 18 - 18
src/main/java/io/milvus/param/ConnectParam.java

@@ -94,7 +94,7 @@ public class ConnectParam {
         }
 
         /**
-         * Set host name/address.
+         * Sets the host name/address.
          *
          * @param host host name/address
          * @return <code>Builder</code>
@@ -105,7 +105,7 @@ public class ConnectParam {
         }
 
         /**
-         * Set connection port. Port value must be larger than zero and less than 65536.
+         * Sets the connection port. Port value must be greater than zero and less than 65536.
          *
          * @param port port value
          * @return <code>Builder</code>
@@ -116,10 +116,10 @@ public class ConnectParam {
         }
 
         /**
-         * Set connect time out value of client channel. The time out value must be larger than zero.
+         * Sets the connection timeout value of client channel. The timeout value must be greater than zero.
          *
-         * @param connectTimeout time out value
-         * @param timeUnit time out unit
+         * @param connectTimeout timeout value
+         * @param timeUnit timeout unit
          * @return <code>Builder</code>
          */
         public Builder withConnectTimeout(long connectTimeout, @NonNull TimeUnit timeUnit) {
@@ -128,10 +128,10 @@ public class ConnectParam {
         }
 
         /**
-         * Set keep alive time value of client channel. The time out value must be larger than zero.
+         * Sets the keep-alive time value of client channel. The keep-alive value must be greater than zero.
          *
-         * @param keepAliveTime time out value
-         * @param timeUnit time out unit
+         * @param keepAliveTime keep-alive value
+         * @param timeUnit keep-alive unit
          * @return <code>Builder</code>
          */
         public Builder withKeepAliveTime(long keepAliveTime, @NonNull TimeUnit timeUnit) {
@@ -140,10 +140,10 @@ public class ConnectParam {
         }
 
         /**
-         * Set keep alive time out value of client channel. The time out value must be larger than zero.
+         * Sets the keep-alive timeout value of client channel. The timeout value must be greater than zero.
          *
-         * @param keepAliveTimeout time out value
-         * @param timeUnit time out unit
+         * @param keepAliveTimeout timeout value
+         * @param timeUnit timeout unit
          * @return <code>Builder</code>
          */
         public Builder withKeepAliveTimeout(long keepAliveTimeout, @NonNull TimeUnit timeUnit) {
@@ -152,9 +152,9 @@ public class ConnectParam {
         }
 
         /**
-         * Set client channel keep alive.
+         * Enables the keep-alive function for client channel.
          *
-         * @param enable true keep alive
+         * @param enable true keep-alive
          * @return <code>Builder</code>
          */
         public Builder keepAliveWithoutCalls(boolean enable) {
@@ -163,10 +163,10 @@ public class ConnectParam {
         }
 
         /**
-         * Set idle time out value of client channel. The time out value must be larger than zero.
+         * Sets the idle timeout value of client channel. The timeout value must be larger than zero.
          *
-         * @param idleTimeout time out value
-         * @param timeUnit time out unit
+         * @param idleTimeout timeout value
+         * @param timeUnit timeout unit
          * @return <code>Builder</code>
          */
         public Builder withIdleTimeout(long idleTimeout, @NonNull TimeUnit timeUnit) {
@@ -175,7 +175,7 @@ public class ConnectParam {
         }
 
         /**
-         * Verify parameters and create a new <code>ConnectParam</code> instance.
+         * Verifies parameters and creates a new <code>ConnectParam</code> instance.
          *
          * @return <code>ShowCollectionsParam</code>
          */
@@ -207,7 +207,7 @@ public class ConnectParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>ConnectParam</code> instance.
+     * Constructs a <code>String</code> by <code>ConnectParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 1 - 1
src/main/java/io/milvus/param/IndexType.java

@@ -20,7 +20,7 @@
 package io.milvus.param;
 
 /**
- * Represents available index types.
+ * Represents the available index types.
  * For more information: @see <a href="https://milvus.io/docs/v2.0.0/index_selection.md">Index Types</a>
  */
 public enum IndexType {

+ 1 - 1
src/main/java/io/milvus/param/MetricType.java

@@ -20,7 +20,7 @@
 package io.milvus.param;
 
 /**
- * Represents available metric types.
+ * Represents the available metric types.
  * For more information: @see <a href="https://milvus.io/docs/v2.0.0/metric.md">Similarity Metrics</a>
  */
 public enum MetricType {

+ 2 - 2
src/main/java/io/milvus/param/ParamUtils.java

@@ -4,11 +4,11 @@ import io.milvus.exception.ParamException;
 import org.apache.commons.lang3.StringUtils;
 
 /**
- * Util functions for param classes
+ * Utility functions for param classes
  */
 public class ParamUtils {
     /**
-     * Check a string is empty or null.
+     * Checks if a string is empty or null.
      * Throws {@link ParamException} if the string is empty of null.
      *
      * @param target target string

+ 7 - 7
src/main/java/io/milvus/param/R.java

@@ -27,7 +27,7 @@ import java.util.Arrays;
 import java.util.Optional;
 
 /**
- * Util class to wrap gpc response and exceptions.
+ * Utility class to wrap gpc response and exceptions.
  */
 public class R<T> {
     private Exception exception;
@@ -61,7 +61,7 @@ public class R<T> {
     }
 
     /**
-     * Wrap an exception for failure.
+     * Wraps an exception for failure.
      *
      * @param exception exception object
      * @return <code>R</code>
@@ -80,7 +80,7 @@ public class R<T> {
     }
 
     /**
-     * Wrap an error code and error message for failure.
+     * Wraps an error code and error message for failure.
      *
      * @param errorCode rpc error code
      * @param msg error message
@@ -94,7 +94,7 @@ public class R<T> {
     }
 
     /**
-     * Wrap a status code and error message for failure.
+     * Wraps a status code and error message for failure.
      *
      * @param statusCode status code
      * @param msg error message
@@ -108,7 +108,7 @@ public class R<T> {
     }
 
     /**
-     * Direct return a succeed status.
+     * Returns a succeed status.
      *
      * @return <code>R</code>
      */
@@ -119,7 +119,7 @@ public class R<T> {
     }
 
     /**
-     * Wrap a succeed rpc response object.
+     * Wraps a succeed rpc response object.
      *
      * @param data rpc response object
      * @return <code>R</code>
@@ -192,7 +192,7 @@ public class R<T> {
     }
 
     /**
-     * Construct a <code>String</code> by <code>R</code> instance.
+     * Constructs a <code>String</code> by <code>R</code> instance.
      *
      * @return <code>String</code>
      */

+ 2 - 2
src/main/java/io/milvus/param/RpcStatus.java

@@ -20,7 +20,7 @@
 package io.milvus.param;
 
 /**
- * Util class to wrap a message.
+ * Utility class to wrap a message.
  */
 public class RpcStatus {
     public static final String SUCCESS_MSG = "Success";
@@ -36,7 +36,7 @@ public class RpcStatus {
     }
 
     /**
-     * Construct a <code>String</code> by <code>RpcStatus</code> instance.
+     * Constructs a <code>String</code> by <code>RpcStatus</code> instance.
      *
      * @return <code>String</code>
      */

+ 4 - 4
src/main/java/io/milvus/param/alias/AlterAliasParam.java

@@ -34,7 +34,7 @@ public class AlterAliasParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -45,7 +45,7 @@ public class AlterAliasParam {
         }
 
         /**
-         * Set alias, alias cannot be empty or null.
+         * Sets the collection alias. Collection alias cannot be empty or null.
          *
          * @param alias alias of the collection
          * @return <code>Builder</code>
@@ -56,7 +56,7 @@ public class AlterAliasParam {
         }
 
         /**
-         * Verify parameters and create a new <code>AlterAliasParam</code> instance.
+         * Verifies parameters and creates a new <code>AlterAliasParam</code> instance.
          *
          * @return <code>AlterAliasParam</code>
          */
@@ -69,7 +69,7 @@ public class AlterAliasParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>AlterAliasParam</code> instance.
+     * Constructs a <code>String</code> by <code>AlterAliasParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 4 - 4
src/main/java/io/milvus/param/alias/CreateAliasParam.java

@@ -34,7 +34,7 @@ public class CreateAliasParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -45,7 +45,7 @@ public class CreateAliasParam {
         }
 
         /**
-         * Set alias, alias cannot be empty or null.
+         * Sets the collection alias. Collection alias cannot be empty or null.
          *
          * @param alias alias of the collection
          * @return <code>Builder</code>
@@ -56,7 +56,7 @@ public class CreateAliasParam {
         }
 
         /**
-         * Verify parameters and create a new <code>CreateAliasParam</code> instance.
+         * Verifies parameters and creates a new <code>CreateAliasParam</code> instance.
          *
          * @return <code>CreateAliasParam</code>
          */
@@ -69,7 +69,7 @@ public class CreateAliasParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>CreateAliasParam</code> instance.
+     * Constructs a <code>String</code> by <code>CreateAliasParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 3 - 3
src/main/java/io/milvus/param/alias/DropAliasParam.java

@@ -31,7 +31,7 @@ public class DropAliasParam {
         }
 
         /**
-         * Set alias, alias cannot be empty or null.
+         * Sets collection alias. Collection alias cannot be empty or null.
          *
          * @param alias alias of the collection
          * @return <code>Builder</code>
@@ -42,7 +42,7 @@ public class DropAliasParam {
         }
 
         /**
-         * Verify parameters and create a new <code>DropAliasParam</code> instance.
+         * Verifies parameters and creates a new <code>DropAliasParam</code> instance.
          *
          * @return <code>DropAliasParam</code>
          */
@@ -54,7 +54,7 @@ public class DropAliasParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>DropAliasParam</code> instance.
+     * Constructs a <code>String</code> by <code>DropAliasParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 7 - 7
src/main/java/io/milvus/param/collection/CreateCollectionParam.java

@@ -61,7 +61,7 @@ public class CreateCollectionParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -72,7 +72,7 @@ public class CreateCollectionParam {
         }
 
         /**
-         * Set shards number, the number must be larger than zero, default value is 2.
+         * Sets the shards number. The number must be greater than zero. The default value is 2.
          *
          * @param shardsNum shards number to distribute insert data into multiple data nodes and query nodes.
          * @return <code>Builder</code>
@@ -83,7 +83,7 @@ public class CreateCollectionParam {
         }
 
         /**
-         * Set collection description, description can be empty, default is "".
+         * Sets the collection description. The description can be empty. The default is "".
          *
          * @param description description of the collection
          * @return <code>Builder</code>
@@ -94,7 +94,7 @@ public class CreateCollectionParam {
         }
 
         /**
-         * Set schema of the collection, schema cannot be empty or null.
+         * Sets the schema of the collection. The schema cannot be empty or null.
          * @see FieldType
          *
          * @param fieldTypes a <code>List</code> of <code>FieldType</code>
@@ -106,7 +106,7 @@ public class CreateCollectionParam {
         }
 
         /**
-         * Add a field schema.
+         * Adds a field schema.
          * @see FieldType
          *
          * @param fieldType a <code>FieldType</code> object
@@ -118,7 +118,7 @@ public class CreateCollectionParam {
         }
 
         /**
-         * Verify parameters and create a new <code>CreateCollectionParam</code> instance.
+         * Verifies parameters and creates a new <code>CreateCollectionParam</code> instance.
          *
          * @return <code>CreateCollectionParam</code>
          */
@@ -144,7 +144,7 @@ public class CreateCollectionParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>CreateCollectionParam</code> instance.
+     * Constructs a <code>String</code> by <code>CreateCollectionParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 3 - 3
src/main/java/io/milvus/param/collection/DescribeCollectionParam.java

@@ -50,7 +50,7 @@ public class DescribeCollectionParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -61,7 +61,7 @@ public class DescribeCollectionParam {
         }
 
         /**
-         * Verify parameters and create a new <code>DescribeCollectionParam</code> instance.
+         * Verifies parameters and creates a new <code>DescribeCollectionParam</code> instance.
          *
          * @return <code>DescribeCollectionParam</code>
          */
@@ -73,7 +73,7 @@ public class DescribeCollectionParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>DescribeCollectionParam</code> instance.
+     * Constructs a <code>String</code> by <code>DescribeCollectionParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 3 - 3
src/main/java/io/milvus/param/collection/DropCollectionParam.java

@@ -50,7 +50,7 @@ public class DropCollectionParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -61,7 +61,7 @@ public class DropCollectionParam {
         }
 
         /**
-         * Verify parameters and create a new <code>DropCollectionParam</code> instance.
+         * Verifies parameters and creates a new <code>DropCollectionParam</code> instance.
          *
          * @return <code>DropCollectionParam</code>
          */
@@ -73,7 +73,7 @@ public class DropCollectionParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>DropCollectionParam</code> instance.
+     * Constructs a <code>String</code> by <code>DropCollectionParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 12 - 12
src/main/java/io/milvus/param/collection/FieldType.java

@@ -75,8 +75,8 @@ public class FieldType {
         }
 
         /**
-         * Set field to be primary key.
-         * Note that currently Milvus version only support <code>Long</code> data type as primary key.
+         * Sets the field as the primary key field.
+         * Note that the current release of Milvus only support <code>Long</code> data type as primary key.
          *
          * @param primaryKey true is primary key, false is not
          * @return <code>Builder</code>
@@ -87,7 +87,7 @@ public class FieldType {
         }
 
         /**
-         * Set field description, description can be empty, default is "".
+         * Sets the field description. The description can be empty. The default is "".
          *
          * @param description description of the field
          * @return <code>Builder</code>
@@ -98,7 +98,7 @@ public class FieldType {
         }
 
         /**
-         * Set data type for field.
+         * Sets the data type for the field.
          *
          * @param dataType data type of the field
          * @return <code>Builder</code>
@@ -109,7 +109,7 @@ public class FieldType {
         }
 
         /**
-         * Add a parameter pair for field.
+         * Adds a parameter pair for the field.
          *
          * @param key parameter key
          * @param value parameter value
@@ -121,7 +121,7 @@ public class FieldType {
         }
 
         /**
-         * Set more parameters for field.
+         * Sets more parameters for the field.
          *
          * @param typeParams parameters of the field
          * @return <code>Builder</code>
@@ -132,7 +132,7 @@ public class FieldType {
         }
 
         /**
-         * Set dimension of a vector field. Dimension value must be larger than zero.
+         * Sets the dimension of a vector field. Dimension value must be greater than zero.
          *
          * @param dimension dimension of the field
          * @return <code>Builder</code>
@@ -143,11 +143,11 @@ public class FieldType {
         }
 
         /**
-         * Set the field to be auto-id. Note that only primary key field can be set as auto-id.
-         * If auto-id is enabled, Milvus will automatically generated unique id for each entities,
-         * user no need to provide values for this field during insert action.
+         * Enables auto-id function for the field. Note that the auto-id function can only be enabled on primary key field.
+         * If auto-id function is enabled, Milvus will automatically generate unique ID for each entity,
+         * thus you do not need to provide values for the primary key field when inserting.
          *
-         * If auto-id is disabled, user need to provide values for this field during insert action.
+         * If auto-id is disabled, you need to provide values for the primary key field when inserting.
          *
          * @param autoID true enable auto-id, false disable auto-id
          * @return <code>Builder</code>
@@ -158,7 +158,7 @@ public class FieldType {
         }
 
         /**
-         * Verify parameters and create a new <code>FieldType</code> instance.
+         * Verifies parameters and creates a new <code>FieldType</code> instance.
          *
          * @return <code>FieldType</code>
          */

+ 11 - 11
src/main/java/io/milvus/param/collection/FlushParam.java

@@ -55,7 +55,7 @@ public class FlushParam {
         }
 
         /**
-         * Set a list of collections to be flushed.
+         * Sets a list of collections to be flushed.
          *
          * @param collectionNames a list of collections
          * @return <code>Builder</code>
@@ -66,7 +66,7 @@ public class FlushParam {
         }
 
         /**
-         * Add a collections to be flushed.
+         * Adds a collection to be flushed.
          *
          * @param collectionName name of the collections
          * @return <code>Builder</code>
@@ -77,10 +77,10 @@ public class FlushParam {
         }
 
         /**
-         * Set flush action to sync mode.
-         * With sync mode, the client side will keep waiting until all segments of the collection successfully flushed.
+         * Sets the flush function to sync mode.
+         * With sync mode enabled, the client keeps waiting until all segments of the collection successfully flushed.
          *
-         * If not sync mode, client will return at once after the flush() is called.
+         * If sync mode disabled, client returns at once after the flush() is called.
          *
          * @param syncFlush <code>Boolean.TRUE</code> is sync mode, Bollean.FALSE is not
          * @return <code>Builder</code>
@@ -91,8 +91,8 @@ public class FlushParam {
         }
 
         /**
-         * Set waiting interval in sync mode. In sync mode, the client will constantly check segments state by interval.
-         * Interval must be larger than zero, and cannot be larger than Constant.MAX_WAITING_FLUSHING_INTERVAL.
+         * Sets waiting interval in sync mode. With sync mode enabled, the client will constantly check segments state by interval.
+         * Interval must be greater than zero, and cannot be greater than Constant.MAX_WAITING_FLUSHING_INTERVAL.
          * @see Constant
          *
          * @param milliseconds interval
@@ -104,8 +104,8 @@ public class FlushParam {
         }
 
         /**
-         * Set time out value for sync mode.
-         * Time out value must be larger than zero, and cannot be larger than Constant.MAX_WAITING_FLUSHING_TIMEOUT.
+         * Sets timeout value for sync mode.
+         * Timeout value must be greater than zero, and cannot be greater than Constant.MAX_WAITING_FLUSHING_TIMEOUT.
          * @see Constant
          *
          * @param seconds time out value for sync mode
@@ -117,7 +117,7 @@ public class FlushParam {
         }
 
         /**
-         * Verify parameters and create a new <code>FlushParam</code> instance.
+         * Verifies parameters and creates a new <code>FlushParam</code> instance.
          *
          * @return <code>FlushParam</code>
          */
@@ -151,7 +151,7 @@ public class FlushParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>FlushParam</code> instance.
+     * Constructs a <code>String</code> by <code>FlushParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 4 - 4
src/main/java/io/milvus/param/collection/GetCollectionStatisticsParam.java

@@ -56,7 +56,7 @@ public class GetCollectionStatisticsParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -67,7 +67,7 @@ public class GetCollectionStatisticsParam {
         }
 
         /**
-         * Require a flush action before retrieving collection statistics.
+         * Requires a flush action before retrieving collection statistics.
          *
          * @param flush <code>Boolean.TRUE</code> require a flush action
          * @return <code>Builder</code>
@@ -78,7 +78,7 @@ public class GetCollectionStatisticsParam {
         }
 
         /**
-         * Verify parameters and create a new <code>GetCollectionStatisticsParam</code> instance.
+         * Verifies parameters and creates a new <code>GetCollectionStatisticsParam</code> instance.
          *
          * @return <code>GetCollectionStatisticsParam</code>
          */
@@ -90,7 +90,7 @@ public class GetCollectionStatisticsParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>GetCollectionStatisticsParam</code> instance.
+     * Constructs a <code>String</code> by <code>GetCollectionStatisticsParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 3 - 3
src/main/java/io/milvus/param/collection/HasCollectionParam.java

@@ -50,7 +50,7 @@ public class HasCollectionParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -61,7 +61,7 @@ public class HasCollectionParam {
         }
 
         /**
-         * Verify parameters and create a new <code>HasCollectionParam</code> instance.
+         * Verifies parameters and creates a new <code>HasCollectionParam</code> instance.
          *
          * @return <code>HasCollectionParam</code>
          */
@@ -73,7 +73,7 @@ public class HasCollectionParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>HasCollectionParam</code> instance.
+     * Constructs a <code>String</code> by <code>HasCollectionParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 10 - 10
src/main/java/io/milvus/param/collection/LoadCollectionParam.java

@@ -71,7 +71,7 @@ public class LoadCollectionParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -82,10 +82,10 @@ public class LoadCollectionParam {
         }
 
         /**
-         * Set load action to sync mode.
-         * With sync mode, the client side will keep waiting until all segments of the collection successfully loaded.
+         * Enable sync mode for load action.
+         * With sync mode enabled, the client keeps waiting until all segments of the collection successfully loaded.
          *
-         * If not sync mode, client will return at once after the loadCollection() is called.
+         * If sync mode disabled, client returns at once after the loadCollection() is called.
          *
          * @param syncLoad <code>Boolean.TRUE</code> is sync mode, Boolean.FALSE is not
          * @return <code>Builder</code>
@@ -96,8 +96,8 @@ public class LoadCollectionParam {
         }
 
         /**
-         * Set waiting interval in sync mode. In sync mode, the client will constantly check collection load state by interval.
-         * Interval must be larger than zero, and cannot be larger than Constant.MAX_WAITING_LOADING_INTERVAL.
+         * Sets waiting interval in sync mode. With sync mode enabled, the client will constantly check collection load state by interval.
+         * Interval must be greater than zero, and cannot be larger than Constant.MAX_WAITING_LOADING_INTERVAL.
          * @see Constant
          *
          * @param milliseconds interval
@@ -109,8 +109,8 @@ public class LoadCollectionParam {
         }
 
         /**
-         * Set time out value for sync mode.
-         * Time out value must be larger than zero, and cannot be larger than Constant.MAX_WAITING_LOADING_TIMEOUT.
+         * Sets timeout value for the sync mode.
+         * Timeout value must be greater than zero, and cannot be greater than Constant.MAX_WAITING_LOADING_TIMEOUT.
          * @see Constant
          *
          * @param seconds time out value for sync mode
@@ -122,7 +122,7 @@ public class LoadCollectionParam {
         }
 
         /**
-         * Verify parameters and create a new <code>LoadCollectionParam</code> instance.
+         * Verifies parameters and creates a new <code>LoadCollectionParam</code> instance.
          *
          * @return <code>LoadCollectionParam</code>
          */
@@ -150,7 +150,7 @@ public class LoadCollectionParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>LoadCollectionParam</code> instance.
+     * Constructs a <code>String</code> by <code>LoadCollectionParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 3 - 3
src/main/java/io/milvus/param/collection/ReleaseCollectionParam.java

@@ -50,7 +50,7 @@ public class ReleaseCollectionParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -61,7 +61,7 @@ public class ReleaseCollectionParam {
         }
 
         /**
-         * Verify parameters and create a new <code>ReleaseCollectionParam</code> instance.
+         * Verifies parameters and creates a new <code>ReleaseCollectionParam</code> instance.
          *
          * @return <code>ReleaseCollectionParam</code>
          */
@@ -73,7 +73,7 @@ public class ReleaseCollectionParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>ReleaseCollectionParam</code> instance.
+     * Constructs a <code>String</code> by <code>ReleaseCollectionParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 4 - 4
src/main/java/io/milvus/param/collection/ShowCollectionsParam.java

@@ -59,7 +59,7 @@ public class ShowCollectionsParam {
         }
 
         /**
-         * Set a list of collection names, name cannot be empty or null.
+         * Sets a list of collection names. Collection name cannot be empty or null.
          *
          * @param collectionNames list of collection names
          * @return <code>Builder</code>
@@ -70,7 +70,7 @@ public class ShowCollectionsParam {
         }
 
         /**
-         * Add a collection name, name cannot be empty or null.
+         * Adds a collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -83,7 +83,7 @@ public class ShowCollectionsParam {
         }
 
         /**
-         * Verify parameters and create a new <code>ShowCollectionsParam</code> instance.
+         * Verifies parameters and creates a new <code>ShowCollectionsParam</code> instance.
          *
          * @return <code>ShowCollectionsParam</code>
          */
@@ -100,7 +100,7 @@ public class ShowCollectionsParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>ShowCollectionsParam</code> instance.
+     * Constructs a <code>String</code> by <code>ShowCollectionsParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 3 - 3
src/main/java/io/milvus/param/control/GetCompactionPlansParam.java

@@ -22,7 +22,7 @@ public class GetCompactionPlansParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>GetCompactionPlansParam</code> instance.
+     * Constructs a <code>String</code> by <code>GetCompactionPlansParam</code> instance.
      *
      * @return <code>String</code>
      */
@@ -43,7 +43,7 @@ public class GetCompactionPlansParam {
         }
 
         /**
-         * Set compaction action id to get plans.
+         * Sets compaction action id to get the plans.
          *
          * @param compactionID compaction action id
          * @return <code>Builder</code>
@@ -54,7 +54,7 @@ public class GetCompactionPlansParam {
         }
 
         /**
-         * Verify parameters and create a new <code>GetCompactionPlansParam</code> instance.
+         * Verifies parameters and creates a new <code>GetCompactionPlansParam</code> instance.
          *
          * @return <code>GetCompactionPlansParam</code>
          */

+ 3 - 3
src/main/java/io/milvus/param/control/GetCompactionStateParam.java

@@ -23,7 +23,7 @@ public class GetCompactionStateParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>GetCompactionStateParam</code> instance.
+     * Constructs a <code>String</code> by <code>GetCompactionStateParam</code> instance.
      *
      * @return <code>String</code>
      */
@@ -44,7 +44,7 @@ public class GetCompactionStateParam {
         }
 
         /**
-         * Set compaction action id to get state.
+         * Sets the compaction action id to get state.
          *
          * @param compactionID compaction action id
          * @return <code>Builder</code>
@@ -55,7 +55,7 @@ public class GetCompactionStateParam {
         }
 
         /**
-         * Verify parameters and create a new <code>GetCompactionStateParam</code> instance.
+         * Verifies parameters and creates a new <code>GetCompactionStateParam</code> instance.
          *
          * @return <code>GetCompactionStateParam</code>
          */

+ 3 - 3
src/main/java/io/milvus/param/control/GetMetricsParam.java

@@ -50,7 +50,7 @@ public class GetMetricsParam {
         }
 
         /**
-         * Set request in json format to retrieve metric information from server.
+         * Sets request in .json format to retrieve metric information from server.
          * @see <a href="https://wiki.lfaidata.foundation/display/MIL/MEP+8+--+Add+metrics+for+proxy">Metric function design</a>
          *
          * @param request request string in json format
@@ -62,7 +62,7 @@ public class GetMetricsParam {
         }
 
         /**
-         * Verify parameters and create a new <code>GetMetricsParam</code> instance.
+         * Verifies parameters and creates a new <code>GetMetricsParam</code> instance.
          *
          * @return <code>GetMetricsParam</code>
          */
@@ -76,7 +76,7 @@ public class GetMetricsParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>GetMetricsParam</code> instance.
+     * Constructs a <code>String</code> by <code>GetMetricsParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 3 - 3
src/main/java/io/milvus/param/control/GetPersistentSegmentInfoParam.java

@@ -50,7 +50,7 @@ public class GetPersistentSegmentInfoParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -61,7 +61,7 @@ public class GetPersistentSegmentInfoParam {
         }
 
         /**
-         * Verify parameters and create a new <code>GetPersistentSegmentInfoParam</code> instance.
+         * Verifies parameters and creates a new <code>GetPersistentSegmentInfoParam</code> instance.
          *
          * @return <code>GetPersistentSegmentInfoParam</code>
          */
@@ -73,7 +73,7 @@ public class GetPersistentSegmentInfoParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>GetPersistentSegmentInfoParam</code> instance.
+     * Constructs a <code>String</code> by <code>GetPersistentSegmentInfoParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 3 - 3
src/main/java/io/milvus/param/control/GetQuerySegmentInfoParam.java

@@ -50,7 +50,7 @@ public class GetQuerySegmentInfoParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -61,7 +61,7 @@ public class GetQuerySegmentInfoParam {
         }
 
         /**
-         * Verify parameters and create a new <code>GetQuerySegmentInfoParam</code> instance.
+         * Verifies parameters and creates a new <code>GetQuerySegmentInfoParam</code> instance.
          *
          * @return <code>GetQuerySegmentInfoParam</code>
          */
@@ -73,7 +73,7 @@ public class GetQuerySegmentInfoParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>GetQuerySegmentInfoParam</code> instance.
+     * Constructs a <code>String</code> by <code>GetQuerySegmentInfoParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 7 - 7
src/main/java/io/milvus/param/control/LoadBalanceParam.java

@@ -48,7 +48,7 @@ public class LoadBalanceParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>LoadBalanceParam</code> instance.
+     * Constructs a <code>String</code> by <code>LoadBalanceParam</code> instance.
      *
      * @return <code>String</code>
      */
@@ -73,7 +73,7 @@ public class LoadBalanceParam {
         }
 
         /**
-         * Set source query node id in which the sealed segments were loaded.
+         * Sets the source query node by ID in which the sealed segments were loaded.
          *
          * @param srcNodeID source query node id
          * @return <code>Builder</code>
@@ -84,7 +84,7 @@ public class LoadBalanceParam {
         }
 
         /**
-         * Add destination query node id to which the sealed segments will be balance.
+         * Adds the destination query node by ID to which the sealed segments will be balanced.
          *
          * @param destNodeID destination query node id
          * @return <code>Builder</code>
@@ -98,7 +98,7 @@ public class LoadBalanceParam {
         }
 
         /**
-         * Set destination query node id array to which the sealed segments will be balance.
+         * Sets the destination query node by ID array to which the sealed segments will be balance.
          *
          * @param destNodeIDs destination query node id array
          * @return <code>Builder</code>
@@ -109,7 +109,7 @@ public class LoadBalanceParam {
         }
 
         /**
-         * Add a sealed segments id to be balanced.
+         * Adds a sealed segments by ID to be balanced.
          *
          * @param segmentID sealed segment id
          * @return <code>Builder</code>
@@ -123,7 +123,7 @@ public class LoadBalanceParam {
         }
 
         /**
-         * Set sealed segments id array to be balanced.
+         * Sets a sealed segments by ID array to be balanced.
          *
          * @param segmentIDs sealed segments id array
          * @return <code>Builder</code>
@@ -134,7 +134,7 @@ public class LoadBalanceParam {
         }
 
         /**
-         * Verify parameters and create a new <code>LoadBalanceParam</code> instance.
+         * Verifies parameters and creates a new <code>LoadBalanceParam</code> instance.
          *
          * @return <code>LoadBalanceParam</code>
          */

+ 3 - 3
src/main/java/io/milvus/param/control/ManualCompactionParam.java

@@ -22,7 +22,7 @@ public class ManualCompactionParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>ManualCompactionParam</code> instance.
+     * Constructs a <code>String</code> by <code>ManualCompactionParam</code> instance.
      *
      * @return <code>String</code>
      */
@@ -43,7 +43,7 @@ public class ManualCompactionParam {
         }
 
         /**
-         * Ask server to compact a collection.
+         * Compacts a collection.
          *
          * @param collectionID target collection id
          * @return <code>Builder</code>
@@ -54,7 +54,7 @@ public class ManualCompactionParam {
         }
 
         /**
-         * Verify parameters and create a new <code>ManualCompactionParam</code> instance.
+         * Verifies parameters and creates a new <code>ManualCompactionParam</code> instance.
          *
          * @return <code>ManualCompactionParam</code>
          */

+ 6 - 6
src/main/java/io/milvus/param/dml/CalcDistanceParam.java

@@ -28,7 +28,7 @@ import java.util.List;
 
 /**
  * Parameters for <code>calcDistance</code> interface.
- * Note that currently only support float vectors calculation.
+ * Note that current release of Milvus only supports float vectors calculation.
  */
 @Getter
 public class CalcDistanceParam {
@@ -58,7 +58,7 @@ public class CalcDistanceParam {
         }
 
         /**
-         * Set a list of left side vectors. The list cannot be null or empty, each vector list cannot be null or empty.
+         * Sets a list of left side vectors. The list cannot be null or empty, and each vector cannot be null or empty.
          *
          * @param vectors a list of float list, each float list is a vector.
          * @return <code>Builder</code>
@@ -69,7 +69,7 @@ public class CalcDistanceParam {
         }
 
         /**
-         * Set a list of right side vectors. The list cannot be null or empty, each vector list cannot be null or empty.
+         * Sets a list of right side vectors. The list cannot be null or empty, and each vector cannot be null or empty.
          *
          * @param vectors a list of float list, each float list is a vector.
          * @return <code>Builder</code>
@@ -80,7 +80,7 @@ public class CalcDistanceParam {
         }
 
         /**
-         * Set metric type of calculation. Note that currently only support L2 and IP.
+         * Sets metric type of calculation. Note that the current release of Milvus only support L2 and IP.
          *
          * @param metricType metric type
          * @return <code>Builder</code>
@@ -91,7 +91,7 @@ public class CalcDistanceParam {
         }
 
         /**
-         * Verify parameters and create a new <code>CalcDistanceParam</code> instance.
+         * Verifies parameters and creates a new <code>CalcDistanceParam</code> instance.
          *
          * @return <code>CalcDistanceParam</code>
          */
@@ -131,7 +131,7 @@ public class CalcDistanceParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>CalcDistanceParam</code> instance.
+     * Constructs a <code>String</code> by <code>CalcDistanceParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 5 - 5
src/main/java/io/milvus/param/dml/DeleteParam.java

@@ -56,7 +56,7 @@ public class DeleteParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -67,7 +67,7 @@ public class DeleteParam {
         }
 
         /**
-         * Optional. Set partition name.
+         * Sets the partition name (Optional).
          *
          * @param partitionName partition name
          * @return <code>Builder</code>
@@ -78,7 +78,7 @@ public class DeleteParam {
         }
 
         /**
-         * Set expr to filter out entities to be deleted.
+         * Sets the expression to filter out entities to be deleted.
          * @see <a href="https://milvus.io/docs/v2.0.0/boolean.md">Boolean Expression Rules</a>
          *
          * @param expr filtering expression
@@ -90,7 +90,7 @@ public class DeleteParam {
         }
 
         /**
-         * Verify parameters and create a new <code>DeleteParam</code> instance.
+         * Verifies parameters and creates a new <code>DeleteParam</code> instance.
          *
          * @return <code>DeleteParam</code>
          */
@@ -103,7 +103,7 @@ public class DeleteParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>DeleteParam</code> instance.
+     * Constructs a <code>String</code> by <code>DeleteParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 5 - 5
src/main/java/io/milvus/param/dml/InsertParam.java

@@ -63,7 +63,7 @@ public class InsertParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -74,7 +74,7 @@ public class InsertParam {
         }
 
         /**
-         * Optional. Set partition name.
+         * Set partition name (Optional).
          *
          * @param partitionName partition name
          * @return <code>Builder</code>
@@ -85,7 +85,7 @@ public class InsertParam {
         }
 
         /**
-         * Set insert data. The fields list cannot be empty.
+         * Sets the data to insert. The field list cannot be empty.
          * @see InsertParam.Field
          *
          * @param fields insert data
@@ -97,7 +97,7 @@ public class InsertParam {
         }
 
         /**
-         * Verify parameters and create a new <code>InsertParam</code> instance.
+         * Verifies parameters and creates a new <code>InsertParam</code> instance.
          *
          * @return <code>InsertParam</code>
          */
@@ -221,7 +221,7 @@ public class InsertParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>InsertParam</code> instance.
+     * Constructs a <code>String</code> by <code>InsertParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 6 - 6
src/main/java/io/milvus/param/dml/QueryParam.java

@@ -62,7 +62,7 @@ public class QueryParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -73,7 +73,7 @@ public class QueryParam {
         }
 
         /**
-         * Optional. Set partition names list to specify query scope.
+         * Sets partition names list to specify query scope (Optional).
          *
          * @param partitionNames partition names list
          * @return <code>Builder</code>
@@ -84,7 +84,7 @@ public class QueryParam {
         }
 
         /**
-         * Optional. Specify output fields.
+         * Specifies output fields (Optional).
          *
          * @param outFields output fields
          * @return <code>Builder</code>
@@ -95,7 +95,7 @@ public class QueryParam {
         }
 
         /**
-         * Set expression to filter out entities to be queried.
+         * Sets the expression to query entities.
          * @see <a href="https://milvus.io/docs/v2.0.0/boolean.md">Boolean Expression Rules</a>
          *
          * @param expr filtering expression
@@ -107,7 +107,7 @@ public class QueryParam {
         }
 
         /**
-         * Verify parameters and create a new <code>QueryParam</code> instance.
+         * Verifies parameters and creates a new <code>QueryParam</code> instance.
          *
          * @return <code>QueryParam</code>
          */
@@ -120,7 +120,7 @@ public class QueryParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>QueryParam</code> instance.
+     * Constructs a <code>String</code> by <code>QueryParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 13 - 13
src/main/java/io/milvus/param/dml/SearchParam.java

@@ -82,7 +82,7 @@ public class SearchParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -93,7 +93,7 @@ public class SearchParam {
         }
 
         /**
-         * Optional. Set partition names list to specify search scope.
+         * Sets partition names list to specify search scope (Optional).
          *
          * @param partitionNames partition names list
          * @return <code>Builder</code>
@@ -104,7 +104,7 @@ public class SearchParam {
         }
 
         /**
-         * Set metric type of ANN searching.
+         * Sets metric type of ANN searching.
          *
          * @param metricType metric type
          * @return <code>Builder</code>
@@ -115,7 +115,7 @@ public class SearchParam {
         }
 
         /**
-         * Set target vector field name. Field name cannot be empty or null.
+         * Sets target vector field by name. Field name cannot be empty or null.
          *
          * @param vectorFieldName vector field name
          * @return <code>Builder</code>
@@ -126,7 +126,7 @@ public class SearchParam {
         }
 
         /**
-         * Set topK value of ANN search.
+         * Sets topK value of ANN search.
          *
          * @param topK topK value
          * @return <code>Builder</code>
@@ -137,7 +137,7 @@ public class SearchParam {
         }
 
         /**
-         * Optional. Set expression to filter out entities before searching.
+         * Sets expression to filter out entities before searching (Optional).
          * @see <a href="https://milvus.io/docs/v2.0.0/boolean.md">Boolean Expression Rules</a>
          *
          * @param expr filtering expression
@@ -149,7 +149,7 @@ public class SearchParam {
         }
 
         /**
-         * Optional. Specify output fields.
+         * Specifies output fields (Optional).
          *
          * @param outFields output fields
          * @return <code>Builder</code>
@@ -160,7 +160,7 @@ public class SearchParam {
         }
 
         /**
-         * Set target vectors.
+         * Sets the target vectors.
          *
          * @param vectors list of target vectors
          *                If vector type is FloatVector: vectors is List<List<Float>>
@@ -173,7 +173,7 @@ public class SearchParam {
         }
 
         /**
-         * Specify how many digits after the decimal point for returned results.
+         * Specifies the decimal place of the returned results.
          *
          * @param decimal how many digits after the decimal point
          * @return <code>Builder</code>
@@ -184,9 +184,9 @@ public class SearchParam {
         }
 
         /**
-         * Set extra search parameters according to index type.
+         * Sets the search parameters specific to the index type.
          *
-         * For example: IVF index, the extra parameters can be "{\"nprobe\":10}"
+         * For example: IVF index, the search parameters can be "{\"nprobe\":10}"
          * For more information: @see <a href="https://milvus.io/docs/v2.0.0/index_selection.md">Index Selection</a>
          *
          * @param params extra parameters in json format
@@ -198,7 +198,7 @@ public class SearchParam {
         }
 
         /**
-         * Verify parameters and create a new <code>SearchParam</code> instance.
+         * Verifies parameters and creates a new <code>SearchParam</code> instance.
          *
          * @return <code>SearchParam</code>
          */
@@ -247,7 +247,7 @@ public class SearchParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>SearchParam</code> instance.
+     * Constructs a <code>String</code> by <code>SearchParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 15 - 15
src/main/java/io/milvus/param/index/CreateIndexParam.java

@@ -85,7 +85,7 @@ public class CreateIndexParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Set the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -96,7 +96,7 @@ public class CreateIndexParam {
         }
 
         /**
-         * Set target field name. Field name cannot be empty or null.
+         * Sets the target field name. Field name cannot be empty or null.
          *
          * @param fieldName field name
          * @return <code>Builder</code>
@@ -107,7 +107,7 @@ public class CreateIndexParam {
         }
 
         /**
-         * Set index type of the index.
+         * Sets the index type.
          *
          * @param indexType index type
          * @return <code>Builder</code>
@@ -118,7 +118,7 @@ public class CreateIndexParam {
         }
 
         /**
-         * Set metric type of the index.
+         * Sets the metric type.
          *
          * @param metricType metric type
          * @return <code>Builder</code>
@@ -129,12 +129,12 @@ public class CreateIndexParam {
         }
 
         /**
-         * Set extra index parameters according to index type.
+         * Sets the specific index parameters according to index type.
          *
          * For example: IVF index, the extra parameters can be "{\"nlist\":1024}"
          * For more information: @see <a href="https://milvus.io/docs/v2.0.0/index_selection.md">Index Selection</a>
          *
-         * @param extraParam extra parameters in json format
+         * @param extraParam extra parameters in .json format
          * @return <code>Builder</code>
          */
         public Builder withExtraParam(@NonNull String extraParam) {
@@ -143,10 +143,10 @@ public class CreateIndexParam {
         }
 
         /**
-         * Set to sync mode.
-         * With sync mode, the client side will keep waiting until all segments of the collection successfully indexed.
+         * Enables to sync mode.
+         * With sync mode enabled, the client keeps waiting until all segments of the collection are successfully indexed.
          *
-         * If not sync mode, client will return at once after the createIndex() is called.
+         * With sync mode disabled, client returns at once after the createIndex() is called.
          *
          * @param syncMode <code>Boolean.TRUE</code> is sync mode, Boolean.FALSE is not
          * @return <code>Builder</code>
@@ -157,8 +157,8 @@ public class CreateIndexParam {
         }
 
         /**
-         * Set waiting interval in sync mode. In sync mode, the client will constantly check index state by interval.
-         * Interval must be larger than zero, and cannot be larger than Constant.MAX_WAITING_INDEX_INTERVAL.
+         * Sets the waiting interval in sync mode. With sync mode enabled, the client constantly checks index state by interval.
+         * Interval must be greater than zero, and cannot be greater than Constant.MAX_WAITING_INDEX_INTERVAL.
          * @see Constant
          *
          * @param milliseconds interval
@@ -170,8 +170,8 @@ public class CreateIndexParam {
         }
 
         /**
-         * Set time out value for sync mode.
-         * Time out value must be larger than zero. No upper limit. Default value is 600 seconds.
+         * Sets the timeout value for sync mode. 
+         * Timeout value must be greater than zero and with No upper limit. Default value is 600.
          * @see Constant
          *
          * @param seconds time out value for sync mode
@@ -183,7 +183,7 @@ public class CreateIndexParam {
         }
 
         /**
-         * Verify parameters and create a new <code>CreateIndexParam</code> instance.
+         * Verifies parameters and creates a new <code>CreateIndexParam</code> instance.
          *
          * @return <code>CreateIndexParam</code>
          */
@@ -219,7 +219,7 @@ public class CreateIndexParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>CreateIndexParam</code> instance.
+     * Constructs a <code>String</code> by <code>CreateIndexParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 4 - 4
src/main/java/io/milvus/param/index/DescribeIndexParam.java

@@ -53,7 +53,7 @@ public class DescribeIndexParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -64,7 +64,7 @@ public class DescribeIndexParam {
         }
 
         /**
-         * Set target field name. Field name cannot be empty or null.
+         * Sets the target field name. Field name cannot be empty or null.
          *
          * @param fieldName field name
          * @return <code>Builder</code>
@@ -75,7 +75,7 @@ public class DescribeIndexParam {
         }
 
         /**
-         * Verify parameters and create a new <code>DescribeIndexParam</code> instance.
+         * Verifies parameters and creates a new <code>DescribeIndexParam</code> instance.
          *
          * @return <code>DescribeIndexParam</code>
          */
@@ -88,7 +88,7 @@ public class DescribeIndexParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>DescribeIndexParam</code> instance.
+     * Constructs a <code>String</code> by <code>DescribeIndexParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 4 - 4
src/main/java/io/milvus/param/index/DropIndexParam.java

@@ -53,7 +53,7 @@ public class DropIndexParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -64,7 +64,7 @@ public class DropIndexParam {
         }
 
         /**
-         * Set target field name. Field name cannot be empty or null.
+         * Sets the target field name. Field name cannot be empty or null.
          *
          * @param fieldName field name
          * @return <code>Builder</code>
@@ -75,7 +75,7 @@ public class DropIndexParam {
         }
 
         /**
-         * Verify parameters and create a new <code>DropIndexParam</code> instance.
+         * Verifies parameters and creates a new <code>DropIndexParam</code> instance.
          *
          * @return <code>DropIndexParam</code>
          */
@@ -88,7 +88,7 @@ public class DropIndexParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>DropIndexParam</code> instance.
+     * Constructs a <code>String</code> by <code>DropIndexParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 3 - 3
src/main/java/io/milvus/param/index/GetIndexBuildProgressParam.java

@@ -50,7 +50,7 @@ public class GetIndexBuildProgressParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -61,7 +61,7 @@ public class GetIndexBuildProgressParam {
         }
 
         /**
-         * Verify parameters and create a new <code>GetIndexBuildProgressParam</code> instance.
+         * Verifies parameters and creates a new <code>GetIndexBuildProgressParam</code> instance.
          *
          * @return <code>GetIndexBuildProgressParam</code>
          */
@@ -73,7 +73,7 @@ public class GetIndexBuildProgressParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>GetIndexBuildProgressParam</code> instance.
+     * Constructs a <code>String</code> by <code>GetIndexBuildProgressParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 4 - 4
src/main/java/io/milvus/param/index/GetIndexStateParam.java

@@ -53,7 +53,7 @@ public class GetIndexStateParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -64,7 +64,7 @@ public class GetIndexStateParam {
         }
 
         /**
-         * Set target field name. Field name cannot be empty or null.
+         * Sets the target field name. Field name cannot be empty or null.
          *
          * @param fieldName field name
          * @return <code>Builder</code>
@@ -75,7 +75,7 @@ public class GetIndexStateParam {
         }
 
         /**
-         * Verify parameters and create a new <code>GetIndexStateParam</code> instance.
+         * Verifies parameters and creates a new <code>GetIndexStateParam</code> instance.
          *
          * @return <code>GetIndexStateParam</code>
          */
@@ -88,7 +88,7 @@ public class GetIndexStateParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>GetIndexStateParam</code> instance.
+     * Constructs a <code>String</code> by <code>GetIndexStateParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 4 - 4
src/main/java/io/milvus/param/partition/CreatePartitionParam.java

@@ -53,7 +53,7 @@ public class CreatePartitionParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -64,7 +64,7 @@ public class CreatePartitionParam {
         }
 
         /**
-         * Set partition name. Partition name cannot be empty or null.
+         * Sets the partition name. Partition name cannot be empty or null.
          *
          * @param partitionName partition name
          * @return <code>Builder</code>
@@ -75,7 +75,7 @@ public class CreatePartitionParam {
         }
 
         /**
-         * Verify parameters and create a new <code>CreatePartitionParam</code> instance.
+         * Verifies parameters and creates a new <code>CreatePartitionParam</code> instance.
          *
          * @return <code>CreatePartitionParam</code>
          */
@@ -88,7 +88,7 @@ public class CreatePartitionParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>CreatePartitionParam</code> instance.
+     * Constructs a <code>String</code> by <code>CreatePartitionParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 4 - 4
src/main/java/io/milvus/param/partition/DropPartitionParam.java

@@ -53,7 +53,7 @@ public class DropPartitionParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -64,7 +64,7 @@ public class DropPartitionParam {
         }
 
         /**
-         * Set partition name. Partition name cannot be empty or null.
+         * Sets the partition name. Partition name cannot be empty or null.
          *
          * @param partitionName partition name
          * @return <code>Builder</code>
@@ -75,7 +75,7 @@ public class DropPartitionParam {
         }
 
         /**
-         * Verify parameters and create a new <code>DropPartitionParam</code> instance.
+         * Verifies parameters and creates a new <code>DropPartitionParam</code> instance.
          *
          * @return <code>DropPartitionParam</code>
          */
@@ -88,7 +88,7 @@ public class DropPartitionParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>DropPartitionParam</code> instance.
+     * Constructs a <code>String</code> by <code>DropPartitionParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 4 - 4
src/main/java/io/milvus/param/partition/GetPartitionStatisticsParam.java

@@ -53,7 +53,7 @@ public class GetPartitionStatisticsParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -64,7 +64,7 @@ public class GetPartitionStatisticsParam {
         }
 
         /**
-         * Set partition name. Partition name cannot be empty or null.
+         * Sets thep artition name. Partition name cannot be empty or null.
          *
          * @param partitionName partition name
          * @return <code>Builder</code>
@@ -75,7 +75,7 @@ public class GetPartitionStatisticsParam {
         }
 
         /**
-         * Verify parameters and create a new <code>GetPartitionStatisticsParam</code> instance.
+         * Verifies parameters and creates a new <code>GetPartitionStatisticsParam</code> instance.
          *
          * @return <code>GetPartitionStatisticsParam</code>
          */
@@ -88,7 +88,7 @@ public class GetPartitionStatisticsParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>GetPartitionStatisticsParam</code> instance.
+     * Constructs a <code>String</code> by <code>GetPartitionStatisticsParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 4 - 4
src/main/java/io/milvus/param/partition/HasPartitionParam.java

@@ -53,7 +53,7 @@ public class HasPartitionParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -64,7 +64,7 @@ public class HasPartitionParam {
         }
 
         /**
-         * Set partition name. Partition name cannot be empty or null.
+         * Sets the partition name. Partition name cannot be empty or null.
          *
          * @param partitionName partition name
          * @return <code>Builder</code>
@@ -75,7 +75,7 @@ public class HasPartitionParam {
         }
 
         /**
-         * Verify parameters and create a new <code>HasPartitionParam</code> instance.
+         * Verifies parameters and creates a new <code>HasPartitionParam</code> instance.
          *
          * @return <code>HasPartitionParam</code>
          */
@@ -88,7 +88,7 @@ public class HasPartitionParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>HasPartitionParam</code> instance.
+     * Constructs a <code>String</code> by <code>HasPartitionParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 12 - 12
src/main/java/io/milvus/param/partition/LoadPartitionsParam.java

@@ -76,7 +76,7 @@ public class LoadPartitionsParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -87,7 +87,7 @@ public class LoadPartitionsParam {
         }
 
         /**
-         * Set partition names list. Partition names list cannot be null or empty.
+         * Sets the partition names list. Partition names list cannot be null or empty.
          *
          * @param partitionNames partition names list
          * @return <code>Builder</code>
@@ -98,7 +98,7 @@ public class LoadPartitionsParam {
         }
 
         /**
-         * Add a partition name. Partition name cannot be empty or null.
+         * Adds a partition by name. Partition name cannot be empty or null.
          *
          * @param partitionName partition name
          * @return <code>Builder</code>
@@ -111,10 +111,10 @@ public class LoadPartitionsParam {
         }
 
         /**
-         * Set load action to sync mode.
-         * With sync mode, the client side will keep waiting until all segments of the partition successfully loaded.
+         * Enables sync mode for load action.
+         * With sync mode enabled, the client keeps waiting until all segments of the partition are successfully loaded.
          *
-         * If not sync mode, client will return at once after the loadPartitions() is called.
+         * Without sync mode disabled, client returns at once after the loadPartitions() is called.
          *
          * @param syncLoad <code>Boolean.TRUE</code> is sync mode, Boolean.FALSE is not
          * @return <code>Builder</code>
@@ -125,8 +125,8 @@ public class LoadPartitionsParam {
         }
 
         /**
-         * Set waiting interval in sync mode. In sync mode, the client will constantly check partition load state by interval.
-         * Interval must be larger than zero, and cannot be larger than Constant.MAX_WAITING_LOADING_INTERVAL.
+         * Sets the waiting interval for sync mode. In sync mode, the client constantly checks partition load state by interval.
+         * Interval must be greater than zero, and cannot be greater than Constant.MAX_WAITING_LOADING_INTERVAL.
          * @see Constant
          *
          * @param milliseconds interval
@@ -138,8 +138,8 @@ public class LoadPartitionsParam {
         }
 
         /**
-         * Set time out value for sync mode.
-         * Time out value must be larger than zero, and cannot be larger than Constant.MAX_WAITING_LOADING_TIMEOUT.
+         * Sets the timeout value for sync mode.
+         * Timeout value must be greater than zero, and cannot be greater than Constant.MAX_WAITING_LOADING_TIMEOUT.
          * @see Constant
          *
          * @param seconds time out value for sync mode
@@ -151,7 +151,7 @@ public class LoadPartitionsParam {
         }
 
         /**
-         * Verify parameters and create a new <code>LoadPartitionsParam</code> instance.
+         * Verifies parameters and creates a new <code>LoadPartitionsParam</code> instance.
          *
          * @return <code>LoadPartitionsParam</code>
          */
@@ -187,7 +187,7 @@ public class LoadPartitionsParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>LoadPartitionsParam</code> instance.
+     * Constructs a <code>String</code> by <code>LoadPartitionsParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 5 - 5
src/main/java/io/milvus/param/partition/ReleasePartitionsParam.java

@@ -55,7 +55,7 @@ public class ReleasePartitionsParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -66,7 +66,7 @@ public class ReleasePartitionsParam {
         }
 
         /**
-         * Set partition names list. Partition names list cannot be null or empty.
+         * Sets the partition names list. Partition names list cannot be null or empty.
          *
          * @param partitionNames partition names list
          * @return <code>Builder</code>
@@ -77,7 +77,7 @@ public class ReleasePartitionsParam {
         }
 
         /**
-         * Add a partition name. Partition name cannot be empty or null.
+         * Adds a partition by name. Partition name cannot be empty or null.
          *
          * @param partitionName partition name
          * @return <code>Builder</code>
@@ -90,7 +90,7 @@ public class ReleasePartitionsParam {
         }
 
         /**
-         * Verify parameters and create a new <code>ReleasePartitionsParam</code> instance.
+         * Verifies parameters and creates a new <code>ReleasePartitionsParam</code> instance.
          *
          * @return <code>ReleasePartitionsParam</code>
          */
@@ -110,7 +110,7 @@ public class ReleasePartitionsParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>ReleasePartitionsParam</code> instance.
+     * Constructs a <code>String</code> by <code>ReleasePartitionsParam</code> instance.
      *
      * @return <code>String</code>
      */

+ 5 - 5
src/main/java/io/milvus/param/partition/ShowPartitionsParam.java

@@ -63,7 +63,7 @@ public class ShowPartitionsParam {
         }
 
         /**
-         * Set collection name. Collection name cannot be empty or null.
+         * Sets the collection name. Collection name cannot be empty or null.
          *
          * @param collectionName collection name
          * @return <code>Builder</code>
@@ -74,7 +74,7 @@ public class ShowPartitionsParam {
         }
 
         /**
-         * Set partition names list. Partition names list cannot be null or empty.
+         * Sets the partition names list. Partition names list cannot be null or empty.
          *
          * @param partitionNames partition names list
          * @return <code>Builder</code>
@@ -85,7 +85,7 @@ public class ShowPartitionsParam {
         }
 
         /**
-         * Add a partition name. Partition name cannot be empty or null.
+         * Adds a partition by name. Partition name cannot be empty or null.
          *
          * @param partitionName partition name
          * @return <code>Builder</code>
@@ -98,7 +98,7 @@ public class ShowPartitionsParam {
         }
 
         /**
-         * Verify parameters and create a new <code>ShowPartitionsParam</code> instance.
+         * Verifies parameters and creates a new <code>ShowPartitionsParam</code> instance.
          *
          * @return <code>ShowPartitionsParam</code>
          */
@@ -117,7 +117,7 @@ public class ShowPartitionsParam {
     }
 
     /**
-     * Construct a <code>String</code> by <code>ShowPartitionsParam</code> instance.
+     * Constructs a <code>String</code> by <code>ShowPartitionsParam</code> instance.
      *
      * @return <code>String</code>
      */