@zilliz/milvus2-sdk-node 2.3.4 → 2.4.0

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

@@ -1,34 +1,30 @@
 import { Database } from './Database';
 import { LRUCache } from 'lru-cache';
-import { CreateCollectionReq, DescribeCollectionReq, DropCollectionReq, GetCollectionStatisticsReq, LoadCollectionReq, ReleaseLoadCollectionReq, ShowCollectionsReq, HasCollectionReq, CreateAliasReq, DropAliasReq, AlterAliasReq, CompactReq, GetCompactionStateReq, GetCompactionPlansReq, GetReplicaReq, RenameCollectionReq, GetLoadingProgressReq, GetLoadStateReq, BoolResponse, ResStatus, CompactionResponse, DescribeCollectionResponse, GetCompactionPlansResponse, GetCompactionStateResponse, ShowCollectionsResponse, StatisticsResponse, ReplicasResponse, GetLoadingProgressResponse, GetLoadStateResponse, AlterCollectionReq, DataType } from '../';
+import { CreateCollectionReq, DescribeCollectionReq, DropCollectionReq, GetCollectionStatisticsReq, LoadCollectionReq, ReleaseLoadCollectionReq, ShowCollectionsReq, HasCollectionReq, CreateAliasReq, DescribeAliasReq, ListAliasesReq, DropAliasReq, AlterAliasReq, CompactReq, GetCompactionStateReq, GetCompactionPlansReq, GetReplicaReq, RenameCollectionReq, GetLoadingProgressReq, GetLoadStateReq, BoolResponse, ResStatus, CompactionResponse, DescribeCollectionResponse, GetCompactionPlansResponse, GetCompactionStateResponse, ShowCollectionsResponse, StatisticsResponse, ReplicasResponse, GetLoadingProgressResponse, GetLoadStateResponse, DescribeAliasResponse, ListAliasesResponse, AlterCollectionReq, DataType } from '../';
 /**
  * @see [collection operation examples](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Collection.ts)
  */
 export declare class Collection extends Database {
     protected collectionInfoCache: LRUCache<string, DescribeCollectionResponse, unknown>;
     /**
-     * Create a collection in Milvus.
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | description | String | Collection description |
-     *  | num_partitions | number | number of partitions allowed |
-     *  | consistency_level | String | "Strong"(Milvus default) | "Session" | "Bounded"| "Eventually" | "Customized"; |
-     *  | fields | <a href="https://github.com/milvus-io/milvus-sdk-node/blob/main/milvus/types/Collection.ts#L8" target="_blank">FieldType</a> | Field data |
-     *  | 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 |
+     * Creates a new collection in Milvus.
      *
-     * @returns
-     *  | Property      | Description |
-     *  | :-- | :-- |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause          |
+     * @param {CreateCollectionReq} data - The data for the new collection.
+     * @param {string} data.collection_name - The name of the new collection.
+     * @param {string} [data.description] - The description of the new collection.
+     * @param {number} [data.num_partitions] - The number of partitions allowed in the new collection.
+     * @param {string} [data.consistency_level] - The consistency level of the new collection. Can be "Strong" (Milvus default), "Session", "Bounded", "Eventually", or "Customized".
+     * @param {FieldType[]} data.fields - The fields of the new collection. See [FieldType](https://github.com/milvus-io/milvus-sdk-node/blob/main/milvus/types/Collection.ts#L8) for more details.
+     * @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<ResStatus>} The response status 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).createCollection({
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.createCollection({
      *    collection_name: 'my_collection',
      *    fields: [
      *      {
@@ -46,189 +42,154 @@ export declare class Collection extends Database {
      *        is_primary_key: true,
      *        description: "",
      *      },
-     *  ],
+     *    ],
      *  });
      * ```
      */
     _createCollection(data: CreateCollectionReq): Promise<ResStatus>;
     /**
-   * Check if a collection exists.
-   *
-   * @param data
-   *  | Property | Type | Description |
-   *  | :-- | :-- | :-- |
-   *  | collection_name | String | Collection name |
-   *  | 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 } |
-   *  | value | `true` or `false` |
-  
-   *
-   * #### Example
-   *
-   * ```
-   *  new milvusClient(MILUVS_ADDRESS).hasCollection({
-   *     collection_name: 'my_collection',
-   *  });
-   * ```
-   */
+     * Checks if a collection exists.
+     *
+     * @param {HasCollectionReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection to check.
+     * @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<BoolResponse>} The response from the server.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {boolean} value - `true` if the collection exists, `false` otherwise.
+     *
+     * @example
+     * ```
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const res = await milvusClient.hasCollection({ collection_name: 'my_collection' });
+     * ```
+     */
     hasCollection(data: HasCollectionReq): Promise<BoolResponse>;
     /**
-   * List all collections or get collection loading status.
-   *
-   * @param data
-   *  | Property | Type | Description |
-   *  | :-- | :-- | :-- |
-   *  | type(optional) | enum | All -> 0, Loaded -> 1 |
-   *  | collection_names(optional) | String[] | If `type = Loaded`, Milvus will return `collection_names inMemory_percentages` |
-   *  | 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 } |
-   *  | data |  Contains collection name, ID , timestamp (UTC created time), and loadedPercentage (100 means loaded) |
-   *
-   *
-   * #### Example
-   *
-   * ```
-   *  new milvusClient(MILUVS_ADDRESS).showCollections();
-   * ```
-   */
+     * Lists all collections or gets the loading status of a collection.
+     *
+     * @param {ShowCollectionsReq} data - The request parameters.
+     * @param {ShowCollectionsType} [data.type] - The type of collections to show. Can be "All" (default) or "Loaded".
+     * @param {string[]} [data.collection_names] - If `type` is "Loaded", Milvus will return `collection_names` along with their in-memory percentages.
+     * @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<ShowCollectionsResponse>} The response from the server.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {CollectionData[]} data - An array containing information about each collection, including its name, ID, creation timestamp (UTC), and loaded percentage (100 means fully loaded).
+     *
+     * @example
+     * ```
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const res = await milvusClient.showCollections();
+     * ```
+     */
     showCollections(data?: ShowCollectionsReq): Promise<ShowCollectionsResponse>;
     /**
-     * Modify collection properties
+     * Modifies collection properties.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | 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 {AlterCollectionReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection to modify.
+     * @param {Object} data.properties - The properties to modify. For example, to change the TTL, use {"collection.ttl.seconds": 18000}.
+     * @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<ResStatus>} The response status 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).alterCollection({
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.alterCollection({
      *    collection_name: 'my-collection',
      *    properties: {"collection.ttl.seconds": 18000}
-     * });
+     *  });
      * ```
      */
     alterCollection(data: AlterCollectionReq): Promise<ResStatus>;
     list_collections: (data?: ShowCollectionsReq) => Promise<ShowCollectionsResponse>;
+    listCollections: (data?: ShowCollectionsReq) => Promise<ShowCollectionsResponse>;
     /**
-     * Show the details of a collection, e.g. name, schema.
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | 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       |
+     * Shows the details of a collection, such as its name and schema.
      *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | schema | Information of all fields in this collection |
-     *  | collectionID  | Collection ID |
+     * @param {DescribeCollectionReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection to describe.
+     * @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<DescribeCollectionResponse>} The response from the server.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {FieldSchema[]} schema - Information of all fields in this collection.
+     * @returns {string} collectionID - The ID of the collection.
      *
-     * #### Example
-     *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).describeCollection({
-     *    collection_name: 'my_collection',
-     *  });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const res = await milvusClient.describeCollection({ collection_name: 'my_collection' });
      * ```
      */
     describeCollection(data: DescribeCollectionReq): Promise<DescribeCollectionResponse>;
     /**
      * Show the statistics information of a collection.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | 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 } |
-     *  | stats | [{key: string, value: string}] |
-     *  | data | Transform **stats** to { row_count: 0 } |
-     *
+     * @param {GetCollectionStatisticsReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection to get statistics for.
+     * @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<StatisticsResponse>} The response from the server.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {Object[]} stats - An array of objects, each containing a key-value pair representing a statistic.
+     * @returns {Object} data - Transforms **stats** to an object with properties representing statistics (e.g., { row_count: 0 }).
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).getCollectionStatistics({
-     *    collection_name: 'my_collection',
-     *  });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const res = await milvusClient.getCollectionStatistics({ collection_name: 'my_collection' });
      * ```
      */
     getCollectionStatistics(data: GetCollectionStatisticsReq): Promise<StatisticsResponse>;
+    getCollectionStats: (data: GetCollectionStatisticsReq) => Promise<StatisticsResponse>;
     /**
      * Load collection data into query nodes, then you can do vector search on this collection.
-     * It's async function, but we can use showCollections to check loading status.
+     * It's an async function, but you can use showCollections to check loading status.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_name    | String | Collection name |
-     *  | replica_number? | number | replica number |
-     *  | resource_groups? | String[] | resource group 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 {LoadCollectionReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection to load.
+     * @param {number} [data.replica_number] - The number of replicas.
+     * @param {string[]} [data.resource_groups] - The names of the resource groups.
+     * @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 |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
-     *
-     * #### Example
+     * @returns {Promise<ResStatus>} The response status 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).loadCollection({
-     *    collection_name: 'my_collection',
-     *  });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.loadCollection({ collection_name: 'my_collection' });
      * ```
      */
     loadCollection(data: LoadCollectionReq): Promise<ResStatus>;
     /**
-     * Same function with loadCollection, but it's sync function.
-     * Help to ensure this collection is loaded.
+     * Same function as loadCollection, but it's a synchronous function.
+     * Helps to ensure this collection is loaded.
      *
-     * @param data
-     *  | Property | Type  | Description |
-     *  | :--- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | replica_number？ | number | replica number |
-     *  | resource_groups？ | String[] | resource group |
-     *  | 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 {LoadCollectionReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection to load.
+     * @param {number} [data.replica_number] - The number of replicas.
+     * @param {string[]} [data.resource_groups] - The names of the resource groups.
+     * @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 |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
-     *
-     * #### Example
+     * @returns {Promise<ResStatus>} The response status 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).loadCollectionSync({
-     *    collection_name: 'my_collection',
-     *  });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.loadCollectionSync({ collection_name: 'my_collection' });
      * ```
      */
     loadCollectionSync(data: LoadCollectionReq): Promise<ResStatus>;
@@ -236,47 +197,37 @@ export declare class Collection extends Database {
      * Release a collection from cache to reduce cache usage.
      * Note that you cannot search while the corresponding collection is unloaded.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | 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 |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
+     * @param {ReleaseLoadCollectionReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection to release.
+     * @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<ResStatus>} The response status 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).releaseCollection({
-     *    collection_name: 'my_collection',
-     *  });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.releaseCollection({ collection_name: 'my_collection' });
      * ```
      */
     releaseCollection(data: ReleaseLoadCollectionReq): Promise<ResStatus>;
     /**
-     * Rename a collection
+     * Rename a collection.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | old collection name |
-     *  | new_collection_name | String | new collection name |
-     *  | 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 {RenameCollectionReq} data - The request parameters.
+     * @param {string} data.collection_name - The current name of the collection.
+     * @param {string} data.new_collection_name - The new name for the collection.
+     * @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 |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
-     *
-     * #### Example
+     * @returns {Promise<ResStatus>} The response status 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).renameCollection({
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.renameCollection({
      *    collection_name: 'my_collection',
      *    new_collection_name: 'my_new_collection'
      *  });
@@ -286,206 +237,217 @@ export declare class Collection extends Database {
     /**
      * Drop a collection. Note that this drops all data in the collection.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | 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 |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
+     * @param {DropCollectionReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection to drop.
+     * @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<ResStatus>} The response status 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).dropCollection({
-     *    collection_name: 'my_collection',
-     *  });
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.dropCollection({ collection_name: 'my_collection' });
      * ```
      */
     dropCollection(data: DropCollectionReq): Promise<ResStatus>;
     drop_collection: (data: DropCollectionReq) => Promise<ResStatus>;
     /**
-     * Create collection alias, then you can use alias instead of collection_name when you do vector search
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | alias | String | alias name |
-     *  | collection_name | String | Collection name |
-     *  | 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 |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
+     * Create a collection alias, then you can use the alias instead of the collection_name when you perform a vector search.
      *
+     * @param {CreateAliasReq} data - The request parameters.
+     * @param {string} data.alias - The alias name.
+     * @param {string} data.collection_name - The name of the collection.
+     * @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<ResStatus>} The response status 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).createAlias({
-     *    alias: 'my_collection_alis',
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.createAlias({
+     *    alias: 'my_collection_alias',
      *    collection_name: 'my_collection',
      *  });
      * ```
      */
     createAlias(data: CreateAliasReq): Promise<ResStatus>;
     /**
-     * Drop a collection alias
+     * Describe a collection alias.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | alias | String | alias name |
-     *  | collection_name | String | Collection name |
-     *  | 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 {DescribeAliasReq} data - The request parameters.
+     * @param {string} data.alias - The alias name.
+     * @param {string} data.collection_name - The name of the collection.
+     * @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 |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
+     * @returns {Promise<DescribeAliasResponse>} The response from the server.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {string} collection - The name of the collection that the alias points to.
+     * @returns {string} alias - The alias of the collection.
+     *
+     * @example
+     * ```
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const res = await milvusClient.describeAlias({
+     *    alias: 'my_collection_alias',
+     *    collection_name: 'my_collection',
+     *  });
+     * ```
+     */
+    describeAlias(data: DescribeAliasReq): Promise<DescribeAliasResponse>;
+    /**
+     * List all aliases of a collection.
      *
+     * @param {ListAliasesReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection.
+     * @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<ListAliasesResponse>} The response from the server.
+     * @returns {string} status.error_code - The error code of the operation.
+     * @returns {string} status.reason - The reason for the error, if any.
+     * @returns {string[]} aliases - The list of aliases of the collection.
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).dropAlias({
-     *    alias: 'my_collection_alis',
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const res = await milvusClient.listAliases({
      *    collection_name: 'my_collection',
      *  });
      * ```
      */
-    dropAlias(data: DropAliasReq): Promise<ResStatus>;
+    listAliases(data: ListAliasesReq): Promise<ListAliasesResponse>;
     /**
-     * alter a collection alias
+     * Drop a collection alias.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | alias | String | alias name |
-     *  | collection_name | String | Collection name |
-     *  | 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 {DropAliasReq} data - The request parameters.
+     * @param {string} data.alias - The alias name.
+     * @param {string} data.collection_name - The name of the collection.
+     * @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 |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
+     * @returns {Promise<ResStatus>} The response status 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
+     * ```
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.dropAlias({
+     *    alias: 'my_collection_alias',
+     *    collection_name: 'my_collection',
+     *  });
+     * ```
+     */
+    dropAlias(data: DropAliasReq): Promise<ResStatus>;
+    /**
+     * Alter a collection alias.
+     *
+     * @param {AlterAliasReq} data - The request parameters.
+     * @param {string} data.alias - The alias name.
+     * @param {string} data.collection_name - The name of the collection.
+     * @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<ResStatus>} The response status 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).alterAlais({
-     *    alias: 'my_collection_alis',
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.alterAlias({
+     *    alias: 'my_collection_alias',
      *    collection_name: 'my_collection',
      *  });
      * ```
      */
     alterAlias(data: AlterAliasReq): Promise<ResStatus>;
     /**
-     * Do compaction for the collection.
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | The collection name to compact |
-     *  | 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 |
+     * Perform compaction on a collection. This operation reduces the storage space used by the collection by removing deleted data and optimizing the data layout.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | compactionID | compaction ID |
+     * @param {CompactReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection to compact.
+     * @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<CompactionResponse>} The response 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} compactionID - The ID of the compaction operation.
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).compact({
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.compact({
      *    collection_name: 'my_collection',
      *  });
      * ```
      */
     compact(data: CompactReq): Promise<CompactionResponse>;
     /**
-     * Get compaction states of a targeted compaction id
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | compactionID | number or string | the id returned by compact |
-     *  | 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       |
+     * Get the compaction state of a targeted compaction id.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | state | the state of the compaction |
+     * @param {GetCompactionStateReq} data - The request parameters.
+     * @param {number|string} data.compactionID - The ID of the compaction operation, returned by the compact method.
+     * @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<GetCompactionStateResponse>} The response 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 - The state of the compaction operation.
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).getCompactionState({
-     *    compactionID: compactionID,
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.getCompactionState({
+     *    compactionID: 'your_compaction_id',
      *  });
      * ```
      */
     getCompactionState(data: GetCompactionStateReq): Promise<GetCompactionStateResponse>;
     /**
-     * Get compaction states of a targeted compaction id
+     * Get the compaction states of a targeted compaction id.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | compactionID | number or string | the id returned by compact |
-     *  | 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 {GetCompactionPlansReq} data - The request parameters.
+     * @param {number|string} data.compactionID - The ID of the compaction operation, returned by the compact method.
+     * @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 } |
-     *  | state | the state of the compaction |
-     *
-     * #### Example
+     * @returns {Promise<GetCompactionPlansResponse>} The response 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 - The state of the compaction operation.
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).getCompactionStateWithPlans({
-     *    compactionID: compactionID,
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.getCompactionStateWithPlans({
+     *    compactionID: 'your_compaction_id',
      *  });
      * ```
      */
     getCompactionStateWithPlans(data: GetCompactionPlansReq): Promise<GetCompactionPlansResponse>;
     /**
-     * Get replicas
+     * Get replicas of a collection.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collectionID | number or string | the id returned by compact |
-     *  | 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 {GetReplicaReq} data - The request parameters.
+     * @param {number|string} data.collectionID - The ID of the collection, returned by the compact method.
+     * @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 } |
-     *  | ReplicaInfo[] | replica info array |
-     *
-     * #### Example
+     * @returns {Promise<ReplicasResponse>} The response 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 {ReplicaInfo[]} replicas - An array of replica information.
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).getReplicas({
-     *    collectionID: collectionID,
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.getReplicas({
+     *    collectionID: 'your_collection_id',
      *  });
-     *
      * ```
      *
-     * Return
+     * @returns
      * ```
      * {
      *  replicas: [
@@ -503,104 +465,87 @@ export declare class Collection extends Database {
      */
     getReplicas(data: GetReplicaReq): Promise<ReplicasResponse>;
     /**
-     * Get loading progress of a collection
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | string | the name of the collection |
-     *  | 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 |
+     * Get the loading progress of a collection.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | total_row_num | the total number of rows in the collection |
-     *  | total_loaded_row_num | the total number of loaded rows in the collection |
+     * @param {GetLoadingProgressReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection.
+     * @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.
      *
-     * @throws {Error} if `collection_name` property is not present in `data`
+     * @returns {Promise<GetLoadingProgressResponse>} The response 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} total_row_num - The total number of rows in the collection.
+     * @returns {number} total_loaded_row_num - The total number of loaded rows in the collection.
      *
-     * #### Example
+     * @throws {Error} if `collection_name` property is not present in `data`.
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).getLoadingProgress({
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.getLoadingProgress({
      *    collection_name: 'my_collection',
      *  });
      * ```
      */
     getLoadingProgress(data: GetLoadingProgressReq): Promise<GetLoadingProgressResponse>;
     /**
-     * Get the loading state of a collection
+     * Get the loading state of a collection.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | string | the name of the collection |
-     *  | timeout? | number | 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 an error occurs. Default is undefined |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | state | the loading state of the collection |
+     * @param {GetLoadStateReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection.
+     * @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.
      *
-     * @throws {Error} if `collection_name` property is not present in `data`
+     * @returns {Promise<GetLoadStateResponse>} The response 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 - The loading state of the collection.
      *
-     * #### Example
+     * @throws {Error} if `collection_name` property is not present in `data`.
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).getLoadState({
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const resStatus = await milvusClient.getLoadState({
      *    collection_name: 'my_collection',
      *  });
      * ```
      */
     getLoadState(data: GetLoadStateReq): Promise<GetLoadStateResponse>;
-    listCollections: (data?: ShowCollectionsReq) => Promise<ShowCollectionsResponse>;
     /**
-     * Get the primary key field name
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | string | the name of the collection |
-     *  | timeout? | number | 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 an error occurs. Default is undefined |
+     * Get the primary key field name of a collection.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | pkfield | the primary key field name |
+     * @param {DescribeCollectionReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection.
+     * @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.
      *
-     * @throws {Error} if `collection_name` property is not present in `data`
+     * @returns {Promise<string>} The primary key field name of the collection.
      *
-     * #### Example
+     * @throws {Error} if `collection_name` property is not present in `data`.
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).getPkFieldName({
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const pkFieldName = await milvusClient.getPkFieldName({
      *    collection_name: 'my_collection',
      *  });
      * ```
      */
     getPkFieldName(data: DescribeCollectionReq): Promise<string>;
     /**
-     * Get the primary key field type
+     * Get the primary key field type.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | string | the name of the collection |
-     *  | timeout? | number | 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 an error occurs. Default is undefined |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | pkFieldType | the primary key field type |
+     * @param {DescribeCollectionReq} data - The request parameters.
+     * @param {string} data.collection_name - The name of the collection.
+     * @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.
      *
-     * @throws {Error} if `collection_name` property is not present in `data`
+     * @returns {Promise<keyof typeof DataType>} The primary key field type.
      *
-     * #### Example
+     * @throws {Error} if `collection_name` property is not present in `data`.
      *
+     * @example
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).getPkFieldType({
+     *  const milvusClient = new milvusClient(MILUVS_ADDRESS);
+     *  const pkFieldType = await milvusClient.getPkFieldType({
      *    collection_name: 'my_collection',
      *  });
      * ```