@zilliz/milvus2-sdk-node 1.0.18 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/README.md +19 -7
  2. package/dist/grpc-proto/common.proto +21 -1
  3. package/dist/grpc-proto/milvus.proto +138 -18
  4. package/dist/milvus/Client.d.ts +2 -0
  5. package/dist/milvus/Client.js +11 -0
  6. package/dist/milvus/Client.js.map +1 -1
  7. package/dist/milvus/Collection.d.ts +88 -3
  8. package/dist/milvus/Collection.js +213 -19
  9. package/dist/milvus/Collection.js.map +1 -1
  10. package/dist/milvus/Data.d.ts +118 -6
  11. package/dist/milvus/Data.js +253 -54
  12. package/dist/milvus/Data.js.map +1 -1
  13. package/dist/milvus/MilvusIndex.js +15 -3
  14. package/dist/milvus/MilvusIndex.js.map +1 -1
  15. package/dist/milvus/Partition.js +28 -7
  16. package/dist/milvus/Partition.js.map +1 -1
  17. package/dist/milvus/Utils.d.ts +1 -0
  18. package/dist/milvus/Utils.js +8 -0
  19. package/dist/milvus/Utils.js.map +1 -0
  20. package/dist/milvus/const/ErrorReason.d.ts +18 -3
  21. package/dist/milvus/const/ErrorReason.js +17 -2
  22. package/dist/milvus/const/ErrorReason.js.map +1 -1
  23. package/dist/milvus/index.d.ts +12 -1
  24. package/dist/milvus/index.js +77 -4
  25. package/dist/milvus/index.js.map +1 -1
  26. package/dist/milvus/types/Collection.d.ts +27 -10
  27. package/dist/milvus/types/Common.d.ts +5 -0
  28. package/dist/milvus/types/Common.js +7 -1
  29. package/dist/milvus/types/Common.js.map +1 -1
  30. package/dist/milvus/types/Data.d.ts +42 -0
  31. package/dist/milvus/types/{Insert.js → Data.js} +1 -1
  32. package/dist/milvus/types/Data.js.map +1 -0
  33. package/dist/milvus/types/Response.d.ts +46 -7
  34. package/dist/milvus/types/Response.js +1 -1
  35. package/dist/milvus/types/Response.js.map +1 -1
  36. package/dist/milvus/types/Search.d.ts +3 -3
  37. package/dist/milvus/types.d.ts +3 -3
  38. package/dist/milvus/utils/Format.d.ts +69 -0
  39. package/dist/milvus/utils/Format.js +107 -3
  40. package/dist/milvus/utils/Format.js.map +1 -1
  41. package/dist/milvus/utils/Validate.js +9 -1
  42. package/dist/milvus/utils/Validate.js.map +1 -1
  43. package/dist/milvus/utils/index.d.ts +1 -0
  44. package/dist/milvus/utils/index.js +5 -1
  45. package/dist/milvus/utils/index.js.map +1 -1
  46. package/dist/sdk.json +1 -1
  47. package/package.json +5 -3
  48. package/dist/milvus/types/Insert.d.ts +0 -18
  49. package/dist/milvus/types/Insert.js.map +0 -1
@@ -90,7 +90,7 @@ var Collection = /** @class */ (function (_super) {
90
90
  * @param data
91
91
  * | Property | Type | Description |
92
92
  * | :---------------------- | :---- | :------------------------------- |
93
- * | createCollection | String | Collection name |
93
+ * | collection_name | String | Collection name |
94
94
  * | description | String | Collection description |
95
95
  * | fields | <a href="https://github.com/milvus-io/milvus-sdk-node/blob/main/milvus/types/Collection.ts#L8" target="_blank">FieldType</a> | Field data |
96
96
  *
@@ -127,20 +127,18 @@ var Collection = /** @class */ (function (_super) {
127
127
  */
128
128
  Collection.prototype.createCollection = function (data) {
129
129
  return __awaiter(this, void 0, void 0, function () {
130
- var fields, collection_name, description, root, CollectionSchema, FieldSchema, payload, collectionParams, schemaBtyes, promise;
131
- return __generator(this, function (_a) {
132
- switch (_a.label) {
130
+ var _a, fields, collection_name, description, root, CollectionSchema, FieldSchema, payload, collectionParams, schemaBtyes, promise;
131
+ return __generator(this, function (_b) {
132
+ switch (_b.label) {
133
133
  case 0:
134
- fields = data.fields, collection_name = data.collection_name, description = data.description;
134
+ _a = data || {}, fields = _a.fields, collection_name = _a.collection_name, description = _a.description;
135
135
  if (!fields || !fields.length || !collection_name) {
136
- throw new Error(ErrorReason_1.ERROR_REASONS.CREATE_COLLECTION_CHECK_COLLECTION_NAME);
136
+ throw new Error(ErrorReason_1.ERROR_REASONS.CREATE_COLLECTION_CHECK_PARAMS);
137
137
  }
138
138
  Validate_1.checkCollectionFields(fields);
139
139
  return [4 /*yield*/, protobufjs_1.default.load(schemaPath)];
140
140
  case 1:
141
- root = _a.sent();
142
- if (!root)
143
- throw new Error("Missing proto file");
141
+ root = _b.sent();
144
142
  CollectionSchema = root.lookupType("milvus.proto.schema.CollectionSchema");
145
143
  FieldSchema = root.lookupType("milvus.proto.schema.FieldSchema");
146
144
  payload = {
@@ -157,7 +155,7 @@ var Collection = /** @class */ (function (_super) {
157
155
  schemaBtyes = CollectionSchema.encode(collectionParams).finish();
158
156
  return [4 /*yield*/, utils_1.promisify(this.client, "CreateCollection", __assign(__assign({}, data), { schema: schemaBtyes }))];
159
157
  case 2:
160
- promise = _a.sent();
158
+ promise = _b.sent();
161
159
  return [2 /*return*/, promise];
162
160
  }
163
161
  });
@@ -191,9 +189,7 @@ var Collection = /** @class */ (function (_super) {
191
189
  return __generator(this, function (_a) {
192
190
  switch (_a.label) {
193
191
  case 0:
194
- if (!data.collection_name) {
195
- throw new Error(ErrorReason_1.ERROR_REASONS.HAS_COLLECTION_CHECK);
196
- }
192
+ this.checkCollectionName(data);
197
193
  return [4 /*yield*/, utils_1.promisify(this.client, "HasCollection", data)];
198
194
  case 1:
199
195
  promise = _a.sent();
@@ -280,7 +276,9 @@ var Collection = /** @class */ (function (_super) {
280
276
  var promise;
281
277
  return __generator(this, function (_a) {
282
278
  switch (_a.label) {
283
- case 0: return [4 /*yield*/, utils_1.promisify(this.client, "DescribeCollection", data)];
279
+ case 0:
280
+ this.checkCollectionName(data);
281
+ return [4 /*yield*/, utils_1.promisify(this.client, "DescribeCollection", data)];
284
282
  case 1:
285
283
  promise = _a.sent();
286
284
  return [2 /*return*/, promise];
@@ -317,7 +315,9 @@ var Collection = /** @class */ (function (_super) {
317
315
  var promise;
318
316
  return __generator(this, function (_a) {
319
317
  switch (_a.label) {
320
- case 0: return [4 /*yield*/, utils_1.promisify(this.client, "GetCollectionStatistics", data)];
318
+ case 0:
319
+ this.checkCollectionName(data);
320
+ return [4 /*yield*/, utils_1.promisify(this.client, "GetCollectionStatistics", data)];
321
321
  case 1:
322
322
  promise = _a.sent();
323
323
  promise.data = Format_1.formatKeyValueData(promise.stats, ["row_count"]);
@@ -354,7 +354,9 @@ var Collection = /** @class */ (function (_super) {
354
354
  var promise;
355
355
  return __generator(this, function (_a) {
356
356
  switch (_a.label) {
357
- case 0: return [4 /*yield*/, utils_1.promisify(this.client, "LoadCollection", data)];
357
+ case 0:
358
+ this.checkCollectionName(data);
359
+ return [4 /*yield*/, utils_1.promisify(this.client, "LoadCollection", data)];
358
360
  case 1:
359
361
  promise = _a.sent();
360
362
  return [2 /*return*/, promise];
@@ -390,7 +392,9 @@ var Collection = /** @class */ (function (_super) {
390
392
  var promise, loadedPercentage, res;
391
393
  return __generator(this, function (_a) {
392
394
  switch (_a.label) {
393
- case 0: return [4 /*yield*/, utils_1.promisify(this.client, "LoadCollection", data)];
395
+ case 0:
396
+ this.checkCollectionName(data);
397
+ return [4 /*yield*/, utils_1.promisify(this.client, "LoadCollection", data)];
394
398
  case 1:
395
399
  promise = _a.sent();
396
400
  loadedPercentage = 0;
@@ -442,7 +446,9 @@ var Collection = /** @class */ (function (_super) {
442
446
  var promise;
443
447
  return __generator(this, function (_a) {
444
448
  switch (_a.label) {
445
- case 0: return [4 /*yield*/, utils_1.promisify(this.client, "ReleaseCollection", data)];
449
+ case 0:
450
+ this.checkCollectionName(data);
451
+ return [4 /*yield*/, utils_1.promisify(this.client, "ReleaseCollection", data)];
446
452
  case 1:
447
453
  promise = _a.sent();
448
454
  return [2 /*return*/, promise];
@@ -477,7 +483,9 @@ var Collection = /** @class */ (function (_super) {
477
483
  var promise;
478
484
  return __generator(this, function (_a) {
479
485
  switch (_a.label) {
480
- case 0: return [4 /*yield*/, utils_1.promisify(this.client, "DropCollection", data)];
486
+ case 0:
487
+ this.checkCollectionName(data);
488
+ return [4 /*yield*/, utils_1.promisify(this.client, "DropCollection", data)];
481
489
  case 1:
482
490
  promise = _a.sent();
483
491
  return [2 /*return*/, promise];
@@ -485,6 +493,192 @@ var Collection = /** @class */ (function (_super) {
485
493
  });
486
494
  });
487
495
  };
496
+ /**
497
+ * @ignore
498
+ * Create collection alias, then you can use alias instead of collection_name when you do vector search
499
+ * @param data
500
+ */
501
+ Collection.prototype.createAlias = function (data) {
502
+ return __awaiter(this, void 0, void 0, function () {
503
+ var promise;
504
+ return __generator(this, function (_a) {
505
+ switch (_a.label) {
506
+ case 0:
507
+ this.checkCollectionName(data);
508
+ if (!data.alias) {
509
+ throw new Error(ErrorReason_1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
510
+ }
511
+ return [4 /*yield*/, utils_1.promisify(this.client, "CreateAlias", data)];
512
+ case 1:
513
+ promise = _a.sent();
514
+ return [2 /*return*/, promise];
515
+ }
516
+ });
517
+ });
518
+ };
519
+ /**
520
+ * @ignore
521
+ * @param data
522
+ */
523
+ Collection.prototype.dropAlias = function (data) {
524
+ return __awaiter(this, void 0, void 0, function () {
525
+ var promise;
526
+ return __generator(this, function (_a) {
527
+ switch (_a.label) {
528
+ case 0:
529
+ if (!data.alias) {
530
+ throw new Error(ErrorReason_1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
531
+ }
532
+ return [4 /*yield*/, utils_1.promisify(this.client, "DropAlias", data)];
533
+ case 1:
534
+ promise = _a.sent();
535
+ return [2 /*return*/, promise];
536
+ }
537
+ });
538
+ });
539
+ };
540
+ /**
541
+ * @ignore
542
+ * @param data
543
+ */
544
+ Collection.prototype.alterAlias = function (data) {
545
+ return __awaiter(this, void 0, void 0, function () {
546
+ var promise;
547
+ return __generator(this, function (_a) {
548
+ switch (_a.label) {
549
+ case 0:
550
+ this.checkCollectionName(data);
551
+ if (!data.alias) {
552
+ throw new Error(ErrorReason_1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
553
+ }
554
+ return [4 /*yield*/, utils_1.promisify(this.client, "AlterAlias", data)];
555
+ case 1:
556
+ promise = _a.sent();
557
+ return [2 /*return*/, promise];
558
+ }
559
+ });
560
+ });
561
+ };
562
+ /**
563
+ * Do compaction for the collection.
564
+ *
565
+ * @param data
566
+ * | Property | Type | Description |
567
+ * | :----------------- | :---- | :------------------------------- |
568
+ * | collection_name | String | The collection name to compact |
569
+ *
570
+ * @return
571
+ * | Property | Description |
572
+ * | :-------------| :-------- |
573
+ * | status | { error_code: number, reason: string }|
574
+ * | compactionID | compaction ID |
575
+ *
576
+ * #### Example
577
+ *
578
+ * ```
579
+ * new milvusClient(MILUVS_ADDRESS).collectionManager.compact({
580
+ * collection_name: 'my_collection',
581
+ * });
582
+ * ```
583
+ */
584
+ Collection.prototype.compact = function (data) {
585
+ return __awaiter(this, void 0, void 0, function () {
586
+ var collectionInfo, res;
587
+ return __generator(this, function (_a) {
588
+ switch (_a.label) {
589
+ case 0:
590
+ this.checkCollectionName(data);
591
+ return [4 /*yield*/, this.describeCollection(data)];
592
+ case 1:
593
+ collectionInfo = _a.sent();
594
+ return [4 /*yield*/, utils_1.promisify(this.client, "ManualCompaction", {
595
+ collectionID: collectionInfo.collectionID,
596
+ })];
597
+ case 2:
598
+ res = _a.sent();
599
+ return [2 /*return*/, res];
600
+ }
601
+ });
602
+ });
603
+ };
604
+ /**
605
+ * Get compaction states of a targeted compaction id
606
+ *
607
+ * @param data
608
+ * | Property | Type | Description |
609
+ * | :----------------- | :---- | :------------------------------- |
610
+ * | compactionID | number or string | the id returned by compact |
611
+ *
612
+ * @return
613
+ * | Property | Description |
614
+ * | :-------------| :-------- |
615
+ * | status | { error_code: number, reason: string }|
616
+ * | state | the state of the compaction |
617
+ *
618
+ * #### Example
619
+ *
620
+ * ```
621
+ * new milvusClient(MILUVS_ADDRESS).collectionManager.getCompactionState({
622
+ * compactionID: compactionID,
623
+ * });
624
+ * ```
625
+ */
626
+ Collection.prototype.getCompactionState = function (data) {
627
+ return __awaiter(this, void 0, void 0, function () {
628
+ var res;
629
+ return __generator(this, function (_a) {
630
+ switch (_a.label) {
631
+ case 0:
632
+ if (!data || !data.compactionID) {
633
+ throw new Error(ErrorReason_1.ERROR_REASONS.COMPACTIONID_IS_REQUIRED);
634
+ }
635
+ return [4 /*yield*/, utils_1.promisify(this.client, "GetCompactionState", data)];
636
+ case 1:
637
+ res = _a.sent();
638
+ return [2 /*return*/, res];
639
+ }
640
+ });
641
+ });
642
+ };
643
+ /**
644
+ * Get compaction states of a targeted compaction id
645
+ *
646
+ * @param data
647
+ * | Property | Type | Description |
648
+ * | :----------------- | :---- | :------------------------------- |
649
+ * | compactionID | number or string | the id returned by compact |
650
+ *
651
+ * @return
652
+ * | Property | Description |
653
+ * | :-------------| :-------- |
654
+ * | status | { error_code: number, reason: string }|
655
+ * | state | the state of the compaction |
656
+ *
657
+ * #### Example
658
+ *
659
+ * ```
660
+ * new milvusClient(MILUVS_ADDRESS).collectionManager.getCompactionStateWithPlans({
661
+ * compactionID: compactionID,
662
+ * });
663
+ * ```
664
+ */
665
+ Collection.prototype.getCompactionStateWithPlans = function (data) {
666
+ return __awaiter(this, void 0, void 0, function () {
667
+ var res;
668
+ return __generator(this, function (_a) {
669
+ switch (_a.label) {
670
+ case 0:
671
+ if (!data || !data.compactionID) {
672
+ throw new Error(ErrorReason_1.ERROR_REASONS.COMPACTIONID_IS_REQUIRED);
673
+ }
674
+ return [4 /*yield*/, utils_1.promisify(this.client, "GetCompactionStateWithPlans", data)];
675
+ case 1:
676
+ res = _a.sent();
677
+ return [2 /*return*/, res];
678
+ }
679
+ });
680
+ });
681
+ };
488
682
  return Collection;
489
683
  }(Client_1.Client));
490
684
  exports.Collection = Collection;
@@ -1 +1 @@
1
- {"version":3,"file":"Collection.js","sourceRoot":"","sources":["../../milvus/Collection.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAAkC;AAClC,kCAAqC;AACrC,mDAAoD;AACpD,iDAU4B;AAC5B,6CAQ0B;AAC1B,6CAAyD;AACzD,8CAAwB;AACxB,yCAAqE;AACrE,mCAAkC;AAElC,IAAM,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC;AAEzE;;GAEG;AACH;IAAgC,8BAAM;IAAtC;;IAiWA,CAAC;IAhWC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,qCAAgB,GAAtB,UAAuB,IAAyB;;;;;;wBACtC,MAAM,GAAmC,IAAI,OAAvC,EAAE,eAAe,GAAkB,IAAI,gBAAtB,EAAE,WAAW,GAAK,IAAI,YAAT,CAAU;wBACtD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,eAAe,EAAE;4BACjD,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,uCAAuC,CAAC,CAAC;yBACxE;wBACD,gCAAqB,CAAC,MAAM,CAAC,CAAC;wBAEjB,qBAAM,oBAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAAtC,IAAI,GAAG,SAA+B;wBAC5C,IAAI,CAAC,IAAI;4BAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;wBAE3C,gBAAgB,GAAG,IAAI,CAAC,UAAU,CACtC,sCAAsC,CACvC,CAAC;wBAEI,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAC;wBAEnE,OAAO,GAAQ;4BACjB,IAAI,EAAE,eAAe;4BACrB,WAAW,EAAE,WAAW,IAAI,EAAE;4BAC9B,MAAM,EAAE,EAAE;yBACX,CAAC;wBACF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,UAAC,KAAK;4BACxB,IAAM,KAAK,yBACN,KAAK,KACR,UAAU,EAAE,wBAAe,CAAC,KAAK,CAAC,WAAW,CAAC,EAC9C,QAAQ,EAAE,KAAK,CAAC,SAAS,EACzB,YAAY,EAAE,KAAK,CAAC,cAAc,GACnC,CAAC;4BACF,IAAM,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;4BAE9C,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;wBACnC,CAAC,CAAC,CAAC;wBAEG,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;wBACpD,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,MAAM,EAAE,CAAC;wBACvD,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,kBAAkB,wBAC1D,IAAI,KACP,MAAM,EAAE,WAAW,IACnB,EAAA;;wBAHI,OAAO,GAAG,SAGd;wBAEF,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,kCAAa,GAAnB,UAAoB,IAAsB;;;;;;wBACxC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;4BACzB,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,oBAAoB,CAAC,CAAC;yBACrD;wBACe,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,EAAE,IAAI,CAAC,EAAA;;wBAA7D,OAAO,GAAG,SAAmD;wBACnE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,oCAAe,GAArB,UACE,IAAyB;;;;;4BAET,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE;4BAC9D,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,gCAAmB,CAAC,GAAG;4BAChD,gBAAgB,EAAE,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,KAAI,EAAE;yBAC/C,CAAC,EAAA;;wBAHI,OAAO,GAAG,SAGd;wBACI,MAAM,GAAqB,EAAE,CAAC;wBACpC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAC,IAAY,EAAE,KAAa;4BAC3D,MAAM,CAAC,IAAI,CAAC;gCACV,IAAI,MAAA;gCACJ,EAAE,EAAE,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC;gCACjC,SAAS,EAAE,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC;gCAChD,gBAAgB,EAAE,OAAO,CAAC,oBAAoB,CAAC,KAAK,CAAC;6BACtD,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;wBACH,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;wBAEtB,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,uCAAkB,GAAxB,UACE,IAA2B;;;;;4BAEX,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,IAAI,CAAC,EAAA;;wBAAlE,OAAO,GAAG,SAAwD;wBACxE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,4CAAuB,GAA7B,UACE,IAAgC;;;;;4BAEhB,qBAAM,iBAAS,CAC7B,IAAI,CAAC,MAAM,EACX,yBAAyB,EACzB,IAAI,CACL,EAAA;;wBAJK,OAAO,GAAG,SAIf;wBAED,OAAO,CAAC,IAAI,GAAG,2BAAkB,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;wBAEhE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,mCAAc,GAApB,UAAqB,IAAuB;;;;;4BAC1B,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAA;;wBAA9D,OAAO,GAAG,SAAoD;wBACpE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,uCAAkB,GAAxB,UAAyB,IAAuB;;;;;4BAC9B,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAA;;wBAA9D,OAAO,GAAG,SAAoD;wBAChE,gBAAgB,GAAG,CAAC,CAAC;;;6BAClB,CAAA,MAAM,CAAC,gBAAgB,CAAC,GAAG,GAAG,CAAA;wBACzB,qBAAM,IAAI,CAAC,eAAe,CAAC;gCACnC,gBAAgB,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC;gCACxC,IAAI,EAAE,gCAAmB,CAAC,MAAM;6BACjC,CAAC,EAAA;;wBAHE,GAAG,GAAG,SAGR;wBACF,IAAI,GAAG,CAAC,MAAM,CAAC,UAAU,KAAK,oBAAS,CAAC,OAAO,EAAE;4BAC/C,MAAM,IAAI,KAAK,CACb,gBAAc,GAAG,CAAC,MAAM,CAAC,UAAU,kBAAa,GAAG,CAAC,MAAM,CAAC,MAAQ,CACpE,CAAC;yBACH;wBACD,kGAAkG;wBAClG,gBAAgB,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;;4BAG1D,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,sCAAiB,GAAvB,UAAwB,IAA8B;;;;;4BACpC,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAA;;wBAAjE,OAAO,GAAG,SAAuD;wBACvE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,mCAAc,GAApB,UAAqB,IAAuB;;;;;4BAC1B,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAA;;wBAA9D,OAAO,GAAG,SAAoD;wBACpE,sBAAO,OAAO,EAAC;;;;KAChB;IACH,iBAAC;AAAD,CAAC,AAjWD,CAAgC,eAAM,GAiWrC;AAjWY,gCAAU"}
1
+ {"version":3,"file":"Collection.js","sourceRoot":"","sources":["../../milvus/Collection.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAAkC;AAClC,kCAAqC;AACrC,mDAAoD;AACpD,iDAgB4B;AAC5B,6CAW0B;AAC1B,6CAAyD;AACzD,8CAAwB;AACxB,yCAAqE;AACrE,mCAAkC;AAElC,IAAM,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC;AAEzE;;GAEG;AACH;IAAgC,8BAAM;IAAtC;;IAqfA,CAAC;IApfC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,qCAAgB,GAAtB,UAAuB,IAAyB;;;;;;wBACxC,KAA2C,IAAI,IAAI,EAAE,EAAnD,MAAM,YAAA,EAAE,eAAe,qBAAA,EAAE,WAAW,iBAAA,CAAgB;wBAC5D,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,eAAe,EAAE;4BACjD,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,8BAA8B,CAAC,CAAC;yBAC/D;wBACD,gCAAqB,CAAC,MAAM,CAAC,CAAC;wBAEjB,qBAAM,oBAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAAtC,IAAI,GAAG,SAA+B;wBAEtC,gBAAgB,GAAG,IAAI,CAAC,UAAU,CACtC,sCAAsC,CACvC,CAAC;wBAEI,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAC;wBAEnE,OAAO,GAAQ;4BACjB,IAAI,EAAE,eAAe;4BACrB,WAAW,EAAE,WAAW,IAAI,EAAE;4BAC9B,MAAM,EAAE,EAAE;yBACX,CAAC;wBACF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,UAAC,KAAK;4BACxB,IAAM,KAAK,yBACN,KAAK,KACR,UAAU,EAAE,wBAAe,CAAC,KAAK,CAAC,WAAW,CAAC,EAC9C,QAAQ,EAAE,KAAK,CAAC,SAAS,EACzB,YAAY,EAAE,KAAK,CAAC,cAAc,GACnC,CAAC;4BACF,IAAM,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;4BAE9C,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;wBACnC,CAAC,CAAC,CAAC;wBAEG,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;wBACpD,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,MAAM,EAAE,CAAC;wBACvD,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,kBAAkB,wBAC1D,IAAI,KACP,MAAM,EAAE,WAAW,IACnB,EAAA;;wBAHI,OAAO,GAAG,SAGd;wBAEF,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,kCAAa,GAAnB,UAAoB,IAAsB;;;;;;wBACxC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBAEf,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,EAAE,IAAI,CAAC,EAAA;;wBAA7D,OAAO,GAAG,SAAmD;wBACnE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,oCAAe,GAArB,UACE,IAAyB;;;;;4BAET,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE;4BAC9D,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,gCAAmB,CAAC,GAAG;4BAChD,gBAAgB,EAAE,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,KAAI,EAAE;yBAC/C,CAAC,EAAA;;wBAHI,OAAO,GAAG,SAGd;wBACI,MAAM,GAAqB,EAAE,CAAC;wBACpC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAC,IAAY,EAAE,KAAa;4BAC3D,MAAM,CAAC,IAAI,CAAC;gCACV,IAAI,MAAA;gCACJ,EAAE,EAAE,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC;gCACjC,SAAS,EAAE,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC;gCAChD,gBAAgB,EAAE,OAAO,CAAC,oBAAoB,CAAC,KAAK,CAAC;6BACtD,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;wBACH,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;wBAEtB,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,uCAAkB,GAAxB,UACE,IAA2B;;;;;;wBAE3B,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBAEf,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,IAAI,CAAC,EAAA;;wBAAlE,OAAO,GAAG,SAAwD;wBACxE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,4CAAuB,GAA7B,UACE,IAAgC;;;;;;wBAEhC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBAEf,qBAAM,iBAAS,CAC7B,IAAI,CAAC,MAAM,EACX,yBAAyB,EACzB,IAAI,CACL,EAAA;;wBAJK,OAAO,GAAG,SAIf;wBAED,OAAO,CAAC,IAAI,GAAG,2BAAkB,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;wBAEhE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,mCAAc,GAApB,UAAqB,IAAuB;;;;;;wBAC1C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBAEf,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAA;;wBAA9D,OAAO,GAAG,SAAoD;wBACpE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,uCAAkB,GAAxB,UAAyB,IAAuB;;;;;;wBAC9C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBAEf,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAA;;wBAA9D,OAAO,GAAG,SAAoD;wBAChE,gBAAgB,GAAG,CAAC,CAAC;;;6BAClB,CAAA,MAAM,CAAC,gBAAgB,CAAC,GAAG,GAAG,CAAA;wBACzB,qBAAM,IAAI,CAAC,eAAe,CAAC;gCACnC,gBAAgB,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC;gCACxC,IAAI,EAAE,gCAAmB,CAAC,MAAM;6BACjC,CAAC,EAAA;;wBAHE,GAAG,GAAG,SAGR;wBACF,IAAI,GAAG,CAAC,MAAM,CAAC,UAAU,KAAK,oBAAS,CAAC,OAAO,EAAE;4BAC/C,MAAM,IAAI,KAAK,CACb,gBAAc,GAAG,CAAC,MAAM,CAAC,UAAU,kBAAa,GAAG,CAAC,MAAM,CAAC,MAAQ,CACpE,CAAC;yBACH;wBACD,kGAAkG;wBAClG,gBAAgB,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;;4BAG1D,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,sCAAiB,GAAvB,UAAwB,IAA8B;;;;;;wBACpD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBAEf,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAA;;wBAAjE,OAAO,GAAG,SAAuD;wBACvE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,mCAAc,GAApB,UAAqB,IAAuB;;;;;;wBAC1C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBAEf,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAA;;wBAA9D,OAAO,GAAG,SAAoD;wBACpE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;OAIG;IACG,gCAAW,GAAjB,UAAkB,IAAoB;;;;;;wBACpC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBAC/B,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;4BACf,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,sBAAsB,CAAC,CAAC;yBACvD;wBACe,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,EAAA;;wBAA3D,OAAO,GAAG,SAAiD;wBACjE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;OAGG;IACG,8BAAS,GAAf,UAAgB,IAAkB;;;;;;wBAChC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;4BACf,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,sBAAsB,CAAC,CAAC;yBACvD;wBACe,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,EAAA;;wBAAzD,OAAO,GAAG,SAA+C;wBAC/D,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;OAGG;IACG,+BAAU,GAAhB,UAAiB,IAAmB;;;;;;wBAClC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBAC/B,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;4BACf,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,sBAAsB,CAAC,CAAC;yBACvD;wBACe,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,EAAA;;wBAA1D,OAAO,GAAG,SAAgD;wBAChE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,4BAAO,GAAb,UAAc,IAAgB;;;;;;wBAC5B,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBACR,qBAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAA;;wBAApD,cAAc,GAAG,SAAmC;wBAC9C,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,kBAAkB,EAAE;gCAC3D,YAAY,EAAE,cAAc,CAAC,YAAY;6BAC1C,CAAC,EAAA;;wBAFI,GAAG,GAAG,SAEV;wBACF,sBAAO,GAAG,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,uCAAkB,GAAxB,UACE,IAA2B;;;;;;wBAE3B,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;4BAC/B,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,wBAAwB,CAAC,CAAC;yBACzD;wBACW,qBAAM,iBAAS,CAAC,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,IAAI,CAAC,EAAA;;wBAA9D,GAAG,GAAG,SAAwD;wBACpE,sBAAO,GAAG,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,gDAA2B,GAAjC,UACE,IAA2B;;;;;;wBAE3B,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;4BAC/B,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,wBAAwB,CAAC,CAAC;yBACzD;wBACW,qBAAM,iBAAS,CACzB,IAAI,CAAC,MAAM,EACX,6BAA6B,EAC7B,IAAI,CACL,EAAA;;wBAJK,GAAG,GAAG,SAIX;wBACD,sBAAO,GAAG,EAAC;;;;KACZ;IACH,iBAAC;AAAD,CAAC,AArfD,CAAgC,eAAM,GAqfrC;AArfY,gCAAU"}
@@ -1,7 +1,7 @@
1
1
  import { Client } from "./Client";
2
2
  import { Collection } from "./Collection";
3
- import { FlushReq, InsertReq } from "./types/Insert";
4
- import { FlushResult, GetMetricsResponse, MutationResult, QueryResults, SearchResults } from "./types/Response";
3
+ import { CalcDistanceReq, DeleteEntitiesReq, FlushReq, GetFlushStateReq, GetQuerySegmentInfoReq, InsertReq, LoadBalanceReq } from "./types/Data";
4
+ import { CalcDistanceResponse, FlushResult, GetFlushStateResponse, GetMetricsResponse, GetQuerySegmentInfoResponse, MutationResult, QueryResults, ResStatus, SearchResults } from "./types/Response";
5
5
  import { GetMetricsRequest, QueryReq, SearchReq } from "./types/Search";
6
6
  export declare class Data extends Client {
7
7
  vectorTypes: number[];
@@ -40,6 +40,33 @@ export declare class Data extends Client {
40
40
  * ```
41
41
  */
42
42
  insert(data: InsertReq): Promise<MutationResult>;
43
+ /**
44
+ * Delete entities in Milvus
45
+ *
46
+ * @param data
47
+ * | Property | Type | Description |
48
+ * | :---------------------- | :-------------------- | :------------------------------- |
49
+ * | collection_name | String | Collection name |
50
+ * | partition_name(optional)| String | Partition name |
51
+ * | expr | String | Boolean expression used to filter attribute. |
52
+ *
53
+ * @return
54
+ * | Property | Description |
55
+ * | :-------------| :------------------------------- |
56
+ * | status | { error_code: number, reason: string }|
57
+ * | IDs | ID array of the successfully deleted data |
58
+ *
59
+ *
60
+ * #### Example
61
+ *
62
+ * ```
63
+ * new milvusClient(MILUVS_ADDRESS).dataManager.deleteEntities({
64
+ * collection_name: COLLECTION_NAME,
65
+ * expr: 'id in [1,2,3,4]'
66
+ * });
67
+ * ```
68
+ */
69
+ deleteEntities(data: DeleteEntitiesReq): Promise<MutationResult>;
43
70
  /**
44
71
  * Perform vector similarity search.
45
72
  *
@@ -53,14 +80,14 @@ export declare class Data extends Client {
53
80
  * | vectors | Number[][] | Original vector to search with |
54
81
  * | output_fields(optional) | String[] | Support scalar field |
55
82
  * | vector_type | enum | Binary field -> 100, Float field -> 101 |
83
+ * | travel_timestamp | number | We can get timestamp after insert success. Use this timestamp we can time travel in vector search.|
56
84
 
57
85
  * @return
58
86
  * | Property | Description |
59
87
  * | :-------------| :------------------------------- |
60
88
  * | status | { error_code: number, reason: string }|
61
- * | succ_index | Insert successful index array |
62
- * | err_index | Insert failed index array |
63
- * | IDs | Insert successful id array |
89
+ * | results | {score:number,id:string}[]; |
90
+ *
64
91
  *
65
92
  *
66
93
  * #### Example
@@ -126,7 +153,7 @@ export declare class Data extends Client {
126
153
  * });
127
154
  * ```
128
155
  */
129
- flushSync(data: FlushReq): Promise<FlushResult>;
156
+ flushSync(data: FlushReq): Promise<GetFlushStateResponse>;
130
157
  /**
131
158
  * Query vector data in Milvus. Current release of Milvus only supports expression as fieldname in [id1,id2,id3]
132
159
  *
@@ -166,4 +193,89 @@ export declare class Data extends Client {
166
193
  * | request | object | Only allow "system_info" for now |
167
194
  */
168
195
  getMetric(data: GetMetricsRequest): Promise<GetMetricsResponse>;
196
+ /**
197
+ * @ignore
198
+ * @param data
199
+ */
200
+ calcDistance(data: CalcDistanceReq): Promise<CalcDistanceResponse>;
201
+ /**
202
+ * Get flush state by segment ids
203
+ *
204
+ * @param data
205
+ * | Property | Type | Description |
206
+ * | :---------------------- | :---- | :------------------------------- |
207
+ * | segmentIDs | Array | The segment ids |
208
+ *
209
+ *
210
+ *
211
+ * @return
212
+ * | Property | Description |
213
+ * | :-----------| :------------------------------- |
214
+ * | status | { error_code: number,reason:string } |
215
+ * | flushed | segments flushed or not |
216
+ *
217
+ *
218
+ * #### Example
219
+ *
220
+ * ```
221
+ * const res = await milvusClient.dataManager.getFlushState({
222
+ * segmentIDs: segIds,
223
+ * });
224
+ * ```
225
+ */
226
+ getFlushState(data: GetFlushStateReq): Promise<GetFlushStateResponse>;
227
+ /**
228
+ * Do load balancing operation from source query node to destination query node.
229
+ * Only work in cluster milvus.
230
+ *
231
+ * @param data
232
+ * | Property | Type | Description |
233
+ * | :-------------------| :---- | :------------------------------- |
234
+ * | src_nodeID | number | The source query node id to balance. |
235
+ * | dst_nodeIDs | number[] | The destination query node ids to balance.(optional) |
236
+ * | sealed_segmentIDs | number[] | Sealed segment ids to balance.(optional) |
237
+ *
238
+ *
239
+ * @return
240
+ * | Property | Description |
241
+ * | :-----------| :------------------------------- |
242
+ * | status | { error_code: number,reason:string } |
243
+ * | infos | segments infomations |
244
+ *
245
+ *
246
+ * #### Example
247
+ *
248
+ * ```
249
+ * const res = await dataManager.loadBalance({
250
+ * src_nodeID: 31,
251
+ * });
252
+ * ```
253
+ */
254
+ loadBalance(data: LoadBalanceReq): Promise<ResStatus>;
255
+ /**
256
+ * Notifies Proxy to return segments information from query nodes.
257
+ *
258
+ * @param data
259
+ * | Property | Type | Description |
260
+ * | :---------------------- | :---- | :------------------------------- |
261
+ * | collectionName | String | The name of the collection to get segments info. |
262
+ *
263
+ *
264
+ *
265
+ * @return
266
+ * | Property | Description |
267
+ * | :-----------| :------------------------------- |
268
+ * | status | { error_code: number,reason:string } |
269
+ * | infos | QuerySegmentInfo is the growing segments's information in query cluster. |
270
+ *
271
+ *
272
+ * #### Example
273
+ *
274
+ * ```
275
+ * const res = await dataManager.getQuerySegmentInfo({
276
+ * collectionName: COLLECTION,
277
+ * });
278
+ * ```
279
+ */
280
+ getQuerySegmentInfo(data: GetQuerySegmentInfoReq): Promise<GetQuerySegmentInfoResponse>;
169
281
  }