@zilliz/milvus2-sdk-node 1.0.16 → 1.0.20

package/dist/milvus/Data.d.ts

@@ -1,8 +1,8 @@
 import { Client } from "./Client";
 import { Collection } from "./Collection";
-import { FlushReq, InsertReq } from "./types/Insert";
-import { FlushResult, MutationResult, QueryResults, SearchResults } from "./types/Response";
-import { QueryReq, SearchReq } from "./types/Search";
+import { CalcDistanceReq, DeleteEntitiesReq, FlushReq, GetFlushStateReq, GetQuerySegmentInfoReq, InsertReq, LoadBalanceReq } from "./types/Data";
+import { CalcDistanceResponse, FlushResult, GetFlushStateResponse, GetMetricsResponse, GetQuerySegmentInfoResponse, MutationResult, QueryResults, ResStatus, SearchResults } from "./types/Response";
+import { GetMetricsRequest, QueryReq, SearchReq } from "./types/Search";
 export declare class Data extends Client {
     vectorTypes: number[];
     collectionManager: Collection;
@@ -40,6 +40,33 @@ export declare class Data extends Client {
      * ```
      */
     insert(data: InsertReq): Promise<MutationResult>;
+    /**
+     * Delete entities in Milvus
+     *
+     * @param data
+     *  | Property                | Type                   |           Description              |
+     *  | :---------------------- | :--------------------  | :-------------------------------  |
+     *  | collection_name         | String                 |       Collection name       |
+     *  | partition_name(optional)| String                 |       Partition name       |
+     *  | expr    | String        |  Boolean expression used to filter attribute.    |
+     *
+     * @return
+     *  | Property    |           Description              |
+     *  | :-------------| :-------------------------------  |
+     *  | status        |  { error_code: number, reason: string }|
+     *  | IDs    |        ID array of the successfully deleted data      |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).dataManager.deleteEntities({
+     *    collection_name: COLLECTION_NAME,
+     *    expr: 'id in [1,2,3,4]'
+     *  });
+     * ```
+     */
+    deleteEntities(data: DeleteEntitiesReq): Promise<MutationResult>;
     /**
      * Perform vector similarity search.
      *
@@ -53,14 +80,14 @@ export declare class Data extends Client {
      *  | vectors                  | Number[][]            |  Original vector to search with  |
      *  | output_fields(optional)  | String[]              |  Support scalar field  |
      *  | vector_type              | enum                  |  Binary field -> 100, Float field -> 101  |
+     *  | travel_timestamp          | number                  |  We can get timestamp after insert success. Use this timestamp we can time travel in vector search.|
   
      * @return
      *  | Property    |           Description              |
      *  | :-------------| :-------------------------------  |
      *  | status        |  { error_code: number, reason: string }|
-     *  | succ_index    |        Insert successful index array      |
-     *  | err_index    |        Insert failed index array      |
-     *  | IDs    |        Insert successful id array      |
+     *  | results    |        {score:number,id:string}[];       |
+     *
      *
      *
      * #### Example
@@ -84,7 +111,7 @@ export declare class Data extends Client {
     search(data: SearchReq): 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 excute.
      * @param data
      *  | Property                | Type   |           Description              |
      *  | :---------------------- | :----  | :-------------------------------  |
@@ -104,6 +131,29 @@ export declare class Data extends Client {
      * ```
      */
     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.
+     *
+     * @param data
+     *  | Property                | Type   |           Description              |
+     *  | :---------------------- | :----  | :-------------------------------  |
+     *  | collection_names        | String[] |        Array of collection names      |
+     *
+     * @return
+     *  | Property    |           Description              |
+     *  | :-------------| :-------------------------------  |
+     *  | status        |  { error_code: number, reason: string }|
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).dataManager.flushSync({
+     *     collection_names: ['my_collection'],
+     *  });
+     * ```
+     */
+    flushSync(data: FlushReq): Promise<FlushResult>;
     /**
      * Query vector data in Milvus. Current release of Milvus only supports expression as fieldname in [id1,id2,id3]
      *
@@ -135,4 +185,97 @@ export declare class Data extends Client {
      * ```
      */
     query(data: QueryReq): Promise<QueryResults>;
+    /**
+     * @ignore
+     * @param data
+     *  | Property             | Type   |           Description                      |
+     *  | :------------------- | :----  | :----------------------------------------  |
+     *  | request              | object |        Only allow "system_info" for now    |
+     */
+    getMetric(data: GetMetricsRequest): Promise<GetMetricsResponse>;
+    /**
+     * @ignore
+     * @param data
+     */
+    calcDistance(data: CalcDistanceReq): Promise<CalcDistanceResponse>;
+    /**
+     * Get flush state by segment ids
+     *
+     * @param data
+     *  | Property                | Type   |           Description              |
+     *  | :---------------------- | :----  | :-------------------------------  |
+     *  | segmentIDs              | Array  |       The segment ids        |
+     *
+     *
+     *
+     * @return
+     *  | Property    |           Description              |
+     *  | :-----------| :-------------------------------  |
+     *  | status      |  { error_code: number,reason:string } |
+     *  | flushed     |  segments flushed or not  |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *   const res = await milvusClient.dataManager.getFlushState({
+     *    segmentIDs: segIds,
+     *   });
+     * ```
+     */
+    getFlushState(data: GetFlushStateReq): Promise<GetFlushStateResponse>;
+    /**
+     * Do load balancing operation from source query node to destination query node.
+     * Only work in cluster milvus.
+     *
+     * @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)       |
+     *
+     *
+     * @return
+     *  | Property    |           Description              |
+     *  | :-----------| :-------------------------------  |
+     *  | status      |  { error_code: number,reason:string } |
+     *  | infos       |  segments infomations  |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *   const res = await dataManager.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.       |
+     *
+     *
+     *
+     * @return
+     *  | Property    |           Description              |
+     *  | :-----------| :-------------------------------  |
+     *  | status      |  { error_code: number,reason:string } |
+     *  | infos       |  QuerySegmentInfo is the growing segments's information in query cluster.  |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *   const res = await dataManager.getQuerySegmentInfo({
+     *      collectionName: COLLECTION,
+     *    });
+     * ```
+     */
+    getQuerySegmentInfo(data: GetQuerySegmentInfoReq): Promise<GetQuerySegmentInfoResponse>;
 }