@zilliz/milvus2-sdk-node 2.3.4 → 2.4.0

package/dist/milvus/grpc/Data.d.ts

@@ -1,7 +1,6 @@
-import { DataType, DeleteEntitiesReq, FlushReq, GetFlushStateReq, GetQuerySegmentInfoReq, GePersistentSegmentInfoReq, InsertReq, LoadBalanceReq, ImportReq, ListImportTasksReq, FlushResult, GetFlushStateResponse, GetMetricsResponse, GetQuerySegmentInfoResponse, GePersistentSegmentInfoResponse, MutationResult, QueryResults, ResStatus, SearchResults, ImportResponse, ListImportTasksResponse, GetMetricsRequest, QueryReq, GetReq, DeleteReq, SearchReq, SearchSimpleReq, CountReq, CountResult } from '../';
+import { DeleteEntitiesReq, FlushReq, GetFlushStateReq, GetQuerySegmentInfoReq, GePersistentSegmentInfoReq, InsertReq, LoadBalanceReq, ImportReq, ListImportTasksReq, FlushResult, GetFlushStateResponse, GetMetricsResponse, GetQuerySegmentInfoResponse, GePersistentSegmentInfoResponse, MutationResult, QueryResults, ResStatus, SearchResults, ImportResponse, ListImportTasksResponse, GetMetricsRequest, QueryReq, GetReq, DeleteReq, SearchReq, SearchSimpleReq, HybridSearchReq, CountReq, CountResult } from '../';
 import { Collection } from './Collection';
 export declare class Data extends Collection {
-    vectorTypes: DataType[];
     /**
      * Upsert data into Milvus, view _insert for detail
      */
@@ -11,31 +10,27 @@ export declare class Data extends Collection {
      */
     insert(data: InsertReq): Promise<MutationResult>;
     /**
-     * Insert/upsert data into Milvus.
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | partition_name(optional)| String | Partition name |
-     *  | fields_data or data | { [x: string]: any }[] | If the field type is binary, the vector data length needs to be dimension / 8 |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-  
-     *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | succ_index |  Index array of the successfully inserted data |
-     *  | err_index | Index array of the unsuccessfully inserted data |
-     *  | IDs | ID array of the successfully inserted data |
-     *
-     *
-     * #### Example
-     *
+     * Insert or upsert data into a Milvus collection.
+     *
+     * @param {InsertReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} [data.partition_name] - The name of the partition (optional).
+     * @param {{ [x: string]: any }[]} data.data - The data to be inserted. If the field type is binary, the vector data length needs to be dimension / 8.
+     * @param {InsertTransformers} data.transformers - The transformers for bf16 or f16 data, it accept an f32 array, it should output f16 or bf16 bytes (optional)
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     *
+     * @returns {Promise<MutationResult>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {number[]} succ_index - Index array of the successfully inserted data.
+     * @returns {number[]} err_index - Index array of the unsuccessfully inserted data.
+     * @returns {number[]} IDs - ID array of the successfully inserted data.
+     *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).insert({
-     *    collection_name: COLLECTION_NAME,
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.insert({
+     *    collection_name: 'my_collection',
      *    fields_data: [{
      *      vector_field: [1,2,2,4],
      *      scalar_field: 1
@@ -45,173 +40,162 @@ export declare class Data extends Collection {
      */
     private _insert;
     /**
-     * Delete entities in Milvus
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | partition_name(optional)| String | Partition name |
-     *  | expr or filter | String | Boolean expression used to filter attribute. |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-  
+     * Delete entities in a Milvus collection.
      *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status |  { error_code: number, reason: string } |
-     *  | IDs | ID array of the successfully deleted data |
+     * @param {DeleteEntitiesReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} [data.partition_name] - The name of the partition (optional).
+     * @param {string} data.expr - Boolean expression used to filter entities for deletion.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
+     * @returns {Promise<MutationResult>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {number[]} IDs - ID array of the successfully deleted data.
      *
-     * #### Example
-     *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).deleteEntities({
-     *    collection_name: COLLECTION_NAME,
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.deleteEntities({
+     *    collection_name: 'my_collection',
      *    expr: 'id in [1,2,3,4]'
      *  });
      * ```
      */
     deleteEntities(data: DeleteEntitiesReq): Promise<MutationResult>;
     /**
-     * Delete entities in Milvus
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | partition_name(optional)| String | Partition name |
-     *  | ids | String[] or Number[] | ids to delete |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-  
-     *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status |  { error_code: number, reason: string } |
-     *  | IDs | ID array of the successfully deleted data |
-     *
-     *
-     * #### Example
+     * Delete entities in a Milvus collection.
+     *
+     * @param {DeleteReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} [data.partition_name] - The name of the partition (optional).
+     * @param {(string[] | number[])} [data.ids] - IDs of the entities to delete.
+     * @param {string} [data.filter] - Filter expression, takes precedence over ids.
+     * @param {string} [data.expr] - equals to data.filter.
+     * @param {number} [data.timeout] - Optional duration of time in milliseconds to allow for the RPC. If undefined, the client keeps waiting until the server responds or an error occurs. Default is undefined.
+     *
+     * @returns {Promise<MutationResult>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {number[]} IDs - Array of IDs of the successfully deleted entities.
+     *
+     * @example
+     * ```
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.delete({
+     *    collection_name: 'my_collection',
+     *    filter: 'id in [1,2,3,4]'
+     *  });
+     * ```
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).deleteEntities({
-     *    collection_name: COLLECTION_NAME,
-     *    expr: 'id in [1,2,3,4]'
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.delete({
+     *    collection_name: 'my_collection',
+     *    ids: [1,2,3,4]
      *  });
      * ```
      */
     delete(data: DeleteReq): Promise<MutationResult>;
     /**
-     * Perform vector similarity search.
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | vectors or data or (vector) | Number[][] or Number[] | Original vector to search with |
-     *  | partition_names(optional)| String[] | Array of partition names |
-     *  | limit(optional) | number | topk alias |
-     *  | topk(optional) | number | topk |
-     *  | offset(optional) | number | offset |
-     *  | filter(optional) | String | Scalar field filter expression |
-     *  | expr(optional) | String | filter alias |
-     *  | output_fields(optional) | String[] | Support scalar field |
-     *  | metric_type(optional) | String | similarity metric |
-     *  | params(optional) | key value object | search params |
-     *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |∂
-     *  | results | {score:number,id:string}[]; |
-     *
-     * #### Example
-     *
+     * Perform vector similarity search in a Milvus collection.
+     *
+     * @param {SearchReq | SearchSimpleReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {Number[]} data.vector - Original vector to search with.
+     * @param {string[]} [data.partition_names] - Array of partition names (optional).
+     * @param {number} [data.topk] - Topk (optional).
+     * @param {number} [data.limit] - Alias for topk (optional).
+     * @param {number} [data.offset] - Offset (optional).
+     * @param {string} [data.filter] - Scalar field filter expression (optional).
+     * @param {string[]} [data.output_fields] - Support scalar field (optional).
+     * @param {object} [data.params] - Search params (optional).
+     * @param {OutputTransformers} data.transformers - The transformers for bf16 or f16 data, it accept bytes or sparse dic vector, it can ouput f32 array or other format(optional)
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     *
+     * @returns {Promise<SearchResults>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {{score:number,id:string, [outputfield]: value}[]} results - Array of search results.
+     *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).search({
-     *   collection_name: COLLECTION_NAME,
-     *   vector: [1, 2, 3, 4],
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const searchResults = await milvusClient.search({
+     *    collection_name: 'my_collection',
+     *    vector: [1, 2, 3, 4],
      *  });
      * ```
      */
-    search(data: SearchReq | SearchSimpleReq): Promise<SearchResults>;
+    search(data: SearchReq | SearchSimpleReq | HybridSearchReq): Promise<SearchResults>;
+    hybridSearch: (data: SearchReq | SearchSimpleReq | HybridSearchReq) => Promise<SearchResults>;
     /**
-     * Milvus temporarily buffers the newly inserted vectors in the cache. Call `flush()` to persist them to the object storage.
-     * It's async function, so it's will take some times to execute.
-     * @param data
-     *  | Property | Type | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_names | String[] | Array of collection names |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-  
+     * Flushes the newly inserted vectors that are temporarily buffered in the cache to the object storage.
+     * This is an asynchronous function and may take some time to execute deponds on your data size.
      *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
+     * @param {FlushReq} data - The request parameters.
+     * @param {string[]} data.collection_names - Array of collection names.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * #### Example
+     * @returns {Promise<FlushResult>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).flush({
-     *     collection_names: ['my_collection'],
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const flushStatus = await milvusClient.flush({
+     *    collection_names: ['my_collection'],
      *  });
      * ```
      */
     flush(data: FlushReq): Promise<FlushResult>;
     /**
-     * It's same function as flush. But flushSync is sync function.
-     * So you can ensure it's flushed after function return the result.
+     * This function is similar to the `flush` function, but it is synchronous.
+     * This ensures that the flush operation is completed before the function returns.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_names | String[] | Array of collection names |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-  
+     * @param {FlushReq} data - The request parameters.
+     * @param {string[]} data.collection_names - Array of collection names.
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status |  { error_code: number, reason: string } |
-     *
-     * #### Example
+     * @returns {Promise<GetFlushStateResponse>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).flushSync({
-     *     collection_names: ['my_collection'],
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const flushSyncStatus = await milvusClient.flushSync({
+     *    collection_names: ['my_collection'],
      *  });
      * ```
      */
     flushSync(data: FlushReq): Promise<GetFlushStateResponse>;
     /**
-     * Query vector data in Milvus. Current release of Milvus only supports expression as fieldname in [id1,id2,id3]
-     *
-     * @param data
-     *  | Property | Type  | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | expr or filter | String | Scalar field filter expression |
-     *  | partitions_names(optional) | String[] | Array of partition names |
-     *  | output_fields | String[] | Vector or scalar field to be returned |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-  
-     *  | params | {key: value}[] | An optional key pair json array
-     *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number,reason:string } |
-     *  | data | Data of all fields that you defined in `output_fields`, {field_name: value}[] |
-     *
-     *
-     * #### Example
-     *
+     * Query vector data in Milvus. Current release of Milvus only supports expression as fieldname in [id1,id2,id3].
+     *
+     * @param {QueryReq} data - The request parameters.
+     * @param {string} data.collection_name - Collection name.
+     * @param {string[]} [data.ids] - IDs to get.
+     * @param {string} [data.expr] - Scalar field filter expression.
+     * @param {string} [data.filter] - Equals to data.expr.
+     * @param {string[]} [data.partitions_names] - Array of partition names (optional).
+     * @param {string[]} data.output_fields - Vector or scalar field to be returned.
+     * @param {number} [data.timeout] - An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     * @param {{key: value}[]} [data.params] - An optional key pair json array of search parameters.
+     * @param {OutputTransformers} data.transformers - The transformers for bf16 or f16 data, it accept bytes or sparse dic vector, it can ouput f32 array or other format(optional)
+     *
+     * @returns {Promise<QueryResults>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {{field_name: value}[]} data - Data of all fields that you defined in `output_fields`.
+     *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).query({
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const queryResults = await milvusClient.query({
      *    collection_name: 'my_collection',
-     *    expr: "age in [1,2,3,4,5,6,7,8]",
+     *    filter: "age in [1,2,3,4,5,6,7,8]",
      *    output_fields: ["age"],
      *  });
      * ```
@@ -219,32 +203,27 @@ export declare class Data extends Collection {
     query(data: QueryReq): Promise<QueryResults>;
     count(data: CountReq): Promise<CountResult>;
     /**
-     * get vector data by providing ids in Milvus
-     *
-     * @param data
-     *  | Property | Type  | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | ids | String[] | ids to get |
-     *  | partitions_names(optional) | String[] | Array of partition names |
-     *  | output_fields | String[] | Vector or scalar field to be returned |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-  
-     *  | params | {key: value}[] | An optional key pair json array
-     *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number,reason:string } |
-     *  | data | Data of all fields that you defined in `output_fields`, {field_name: value}[] |
-     *
-     *
-     * #### Example
-     *
+     * Retrieve vector data by providing IDs in Milvus.
+     *
+     * @param {GetReq} data - The request parameters.
+     * @param {string} data.collection_name - Collection name.
+     * @param {string[]} data.ids - IDs to get.
+     * @param {string[]} [data.partitions_names] - Array of partition names (optional).
+     * @param {string[]} data.output_fields - Vector or scalar field to be returned.
+     * @param {number} [data.timeout] - An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     * @param {{key: value}[]} [data.params] - An optional key pair json array.
+     *
+     * @returns {Promise<QueryResults>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {{field_name: value}[]} data - Data of all fields that you defined in `output_fields`.
+     *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).get({
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const getResults = await milvusClient.get({
      *    collection_name: 'my_collection',
-     *    ids: [1,2,3,4,5,6,7,8],
+     *    ids: ['1','2','3','4','5','6','7','8'],
      *    output_fields: ["age"],
      *  });
      * ```
@@ -259,164 +238,138 @@ export declare class Data extends Collection {
      */
     getMetric(data: GetMetricsRequest): Promise<GetMetricsResponse>;
     /**
-     * Get flush state by segment ids
+     * Get the flush state of specified segment IDs in Milvus.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :--- | :-- | :-- |
-     *  | segmentIDs | Array | The segment ids |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-     *
-     * @returns
-     * | Property | Description |
-     *  | :--- | :-- |
-     *  | status | { error_code: number,reason:string } |
-     *  | flushed | segments flushed or not |
+     * @param {GetFlushStateReq} data - The request parameters.
+     * @param {number[]} data.segmentIDs - The segment IDs.
+     * @param {number} [data.timeout] - An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
+     * @returns {Promise<GetFlushStateResponse>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {boolean[]} flushed - Array indicating whether each segment is flushed or not.
      *
-     * #### Example
-     *
+     * @example
      * ```
-     *   const res = await milvusClient.getFlushState({
-     *    segmentIDs: segIds,
-     *   });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const flushState = await milvusClient.getFlushState({
+     *    segmentIDs: [1,2,3,4],
+     *  });
      * ```
      */
     getFlushState(data: GetFlushStateReq): Promise<GetFlushStateResponse>;
     /**
-     * Do load balancing operation from source query node to destination query node.
-     * Only work in cluster milvus.
+     * Perform a load balancing operation from a source query node to destination query nodes.
+     * This function only works in a Milvus cluster.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :--- | :-- | :-- |
-     *  | src_nodeID | number | The source query node id to balance. |
-     *  | dst_nodeIDs | number[] | The destination query node ids to balance.(optional) |
-     *  | sealed_segmentIDs | number[] | Sealed segment ids to balance.(optional) |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-     *
-     * @returns
-     * | Property | Description |
-     *  | :--- | :-- |
-     *  | status | { error_code: number,reason:string } |
-     *  | infos | segments information |
+     * @param {LoadBalanceReq} data - The request parameters.
+     * @param {number} data.src_nodeID - The source query node id to balance.
+     * @param {number[]} [data.dst_nodeIDs] - The destination query node ids to balance (optional).
+     * @param {number[]} [data.sealed_segmentIDs] - Sealed segment ids to balance (optional).
+     * @param {number} [data.timeout] - An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
+     * @returns {Promise<ResStatus>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {SegmentInfo[]} infos - Information about the segments.
      *
-     * #### Example
-     *
+     * @example
      * ```
-     *   const res = await loadBalance({
-     *      src_nodeID: 31,
-     *   });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const loadBalanceStatus = await milvusClient.loadBalance({
+     *    src_nodeID: 31,
+     *  });
      * ```
      */
     loadBalance(data: LoadBalanceReq): Promise<ResStatus>;
     /**
      * Notifies Proxy to return segments information from query nodes.
      *
-     * @param data
-     *  | Property | Type  | Description |
-     *  | :--- | :-- | :-- |
-     *  | collectionName | String | The name of the collection to get segments info. |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-     *
-     *
-     * @returns
-     * | Property | Description |
-     *  | :--- | :-- |
-     *  | status | { error_code: number,reason:string } |
-     *  | infos | QuerySegmentInfo is the growing segments's information in query cluster. |
+     * @param {GetQuerySegmentInfoReq} data - The request parameters.
+     * @param {string} data.collectionName - The name of the collection to get segments info.
+     * @param {number} [data.timeout] - An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
+     * @returns {Promise<GetQuerySegmentInfoResponse>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {QuerySegmentInfo[]} infos - The growing segments' information in query cluster.
      *
-     * #### Example
-     *
+     * @example
      * ```
-     *   const res = await getQuerySegmentInfo({
-     *      collectionName: COLLECTION,
-     *    });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const querySegmentInfo = await milvusClient.getQuerySegmentInfo({
+     *    collectionName: 'my_collection',
+     *  });
      * ```
      */
     getQuerySegmentInfo(data: GetQuerySegmentInfoReq): Promise<GetQuerySegmentInfoResponse>;
-    /**data
+    /**
      * Notifies Proxy to return segments information from data nodes.
      *
-     * @param data
-     *  | Property | Type  | Description |
-     *  | :--- | :-- | :-- |
-     *  | collectionName | String | The name of the collection to get segments info. |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-     *
+     * @param {GetPersistentSegmentInfoReq} data - The request parameters.
+     * @param {string} data.collectionName - The name of the collection to get segments info.
+     * @param {number} [data.timeout] - An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * @returns
-     * | Property | Description |
-     *  | :--- | :-- |
-     *  | status | { error_code: number,reason:string } |
-     *  | infos | getPersistentSegmentInfo is the growing segments's information in query cluster. |
-     *
-     *
-     * #### Example
+     * @returns {Promise<GetPersistentSegmentInfoResponse>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {PersistentSegmentInfo[]} infos - The growing segments' information in data cluster.
      *
+     * @example
      * ```
-     *   const res = await getPersistentSegmentInfo({
-     *      collectionName: COLLECTION,
-     *    });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const persistentSegmentInfo = await milvusClient.getPersistentSegmentInfo({
+     *    collectionName: 'my_collection',
+     *  });
      * ```
      */
     getPersistentSegmentInfo(data: GePersistentSegmentInfoReq): Promise<GePersistentSegmentInfoResponse>;
     /**
-     * Import data from files
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_name | String | The name of the collection |
-     *  | files | string[] | File path array |
-     *
-     *
-     * @returns
-     * | Property | Description |
-     *  | :--- | :-- |
-     *  | status | { error_code: number,reason:string } |
-     *  | tasks | taskId array |
+     * Import data from files.
      *
+     * @param {ImportReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string[]} data.files - Array of file paths.
+     * @param {number} [data.timeout] - An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
      *
-     * #### Example
+     * @returns {Promise<ImportResponse>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {string[]} tasks - Array of task IDs.
      *
+     * @example
      * ```
-     *   const res = await bulkInsert({
-     *      collection_name: COLLECTION,
-     *      files: [`path-to-data-file.json`]
-     *    });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const importResponse = await milvusClient.bulkInsert({
+     *    collection_name: 'my_collection',
+     *    files: ['path-to-data-file.json'],
+     *  });
      * ```
      */
     bulkInsert(data: ImportReq): Promise<ImportResponse>;
     /**
-     * List import tasks
-     *
-     * @param data
-     *  | Property | Type  | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_name | String | The name of the collection |
-     *  | limit | number | optional, maximum number of tasks returned, list all tasks if the value is 0 |
-     *
-     *
-     * @returns
-     * | Property | Description |
-     *  | :--- | :-- |
-     *  | status | { error_code: number,reason:string } |
-     *  | state | import state |
-     *  | row_count | how many rows to import|
-     *  | id_list| id lists |
-     *  | collection_id | collection to be imported to |
-     *  | tasks | taskId array  |
-     *
-     *
-     * #### Example
-     *
+     * List import tasks.
+     *
+     * @param {ListImportTasksReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {number} [data.limit] - Optional, maximum number of tasks returned, list all tasks if the value is 0.
+     * @param {number} [data.timeout] - An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined.
+     *
+     * @returns {Promise<ListImportTasksResponse>} The result of the operation.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {string} state - Import state.
+     * @returns {number} row_count - How many rows to import.
+     * @returns {string[]} id_list - ID lists.
+     * @returns {string} collection_id - Collection to be imported to.
+     * @returns {string[]} tasks - TaskId array.
+     *
+     * @example
      * ```
-     *   const res = await listImportTasks({
-     *      collection_name: COLLECTION
-     *    });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const listImportTasksResponse = await milvusClient.listImportTasks({
+     *    collection_name: 'my_collection',
+     *  });
      * ```
      */
     listImportTasks(data: ListImportTasksReq): Promise<ListImportTasksResponse>;