@zilliz/milvus2-sdk-node 2.2.6 → 2.2.8
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.
- package/README.md +162 -14
- package/dist/milvus/BaseClient.d.ts +9 -8
- package/dist/milvus/BaseClient.js +47 -18
- package/dist/milvus/BaseClient.js.map +1 -1
- package/dist/milvus/Collection.d.ts +49 -49
- package/dist/milvus/Collection.js +105 -91
- package/dist/milvus/Collection.js.map +1 -1
- package/dist/milvus/Data.d.ts +12 -22
- package/dist/milvus/Data.js +100 -90
- package/dist/milvus/Data.js.map +1 -1
- package/dist/milvus/MilvusClient.js +2 -2
- package/dist/milvus/MilvusClient.js.map +1 -1
- package/dist/milvus/MilvusIndex.d.ts +46 -46
- package/dist/milvus/MilvusIndex.js +59 -51
- package/dist/milvus/MilvusIndex.js.map +1 -1
- package/dist/milvus/Partition.js +7 -7
- package/dist/milvus/Partition.js.map +1 -1
- package/dist/milvus/Resource.js +6 -6
- package/dist/milvus/Resource.js.map +1 -1
- package/dist/milvus/User.js +15 -15
- package/dist/milvus/User.js.map +1 -1
- package/dist/milvus/const/ErrorReason.d.ts +29 -32
- package/dist/milvus/const/ErrorReason.js +29 -32
- package/dist/milvus/const/ErrorReason.js.map +1 -1
- package/dist/milvus/const/Milvus.d.ts +2 -0
- package/dist/milvus/const/Milvus.js +7 -1
- package/dist/milvus/const/Milvus.js.map +1 -1
- package/dist/milvus/index.d.ts +1 -0
- package/dist/milvus/index.js +1 -0
- package/dist/milvus/index.js.map +1 -1
- package/dist/milvus/types/Client.d.ts +9 -0
- package/dist/milvus/types/Client.js +3 -0
- package/dist/milvus/types/Client.js.map +1 -0
- package/dist/milvus/types/Common.d.ts +3 -0
- package/dist/milvus/types/Data.d.ts +15 -2
- package/dist/milvus/types/Index.d.ts +9 -1
- package/dist/milvus/types.d.ts +1 -0
- package/dist/milvus/types.js +1 -0
- package/dist/milvus/types.js.map +1 -1
- package/dist/proto/proto/common.proto +1 -0
- package/dist/proto/proto/google/protobuf/descriptor.proto +19 -3
- package/dist/proto/proto/milvus.proto +24 -0
- package/dist/proto/proto/schema.proto +13 -1
- package/dist/sdk.json +1 -1
- package/dist/utils/Format.d.ts +8 -0
- package/dist/utils/Format.js +31 -1
- package/dist/utils/Format.js.map +1 -1
- package/dist/utils/Function.d.ts +9 -1
- package/dist/utils/Function.js +18 -5
- package/dist/utils/Function.js.map +1 -1
- package/dist/utils/Validate.d.ts +7 -1
- package/dist/utils/Validate.js +64 -18
- package/dist/utils/Validate.js.map +1 -1
- package/dist/utils/test.d.ts +8 -7
- package/dist/utils/test.js +48 -18
- package/dist/utils/test.js.map +1 -1
- package/package.json +5 -5
|
@@ -61,6 +61,17 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
61
61
|
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
62
62
|
}
|
|
63
63
|
};
|
|
64
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
65
|
+
var t = {};
|
|
66
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
67
|
+
t[p] = s[p];
|
|
68
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
69
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
70
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
71
|
+
t[p[i]] = s[p[i]];
|
|
72
|
+
}
|
|
73
|
+
return t;
|
|
74
|
+
};
|
|
64
75
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
65
76
|
exports.Collection = void 0;
|
|
66
77
|
var utils_1 = require("../utils");
|
|
@@ -119,37 +130,37 @@ var Collection = /** @class */ (function (_super) {
|
|
|
119
130
|
* ```
|
|
120
131
|
*/
|
|
121
132
|
Collection.prototype.createCollection = function (data) {
|
|
133
|
+
var _a;
|
|
122
134
|
return __awaiter(this, void 0, void 0, function () {
|
|
123
|
-
var
|
|
124
|
-
return __generator(this, function (
|
|
125
|
-
switch (
|
|
135
|
+
var _b, fields, collection_name, description, _c, consistency_level, CollectionSchema, FieldSchema, payload, collectionParams, schemaBytes, level, promise;
|
|
136
|
+
return __generator(this, function (_d) {
|
|
137
|
+
switch (_d.label) {
|
|
126
138
|
case 0:
|
|
127
|
-
|
|
128
|
-
|
|
139
|
+
_b = data || {}, fields = _b.fields, collection_name = _b.collection_name, description = _b.description, _c = _b.consistency_level, consistency_level = _c === void 0 ? 'Bounded' : _c;
|
|
140
|
+
// Check if fields and collection_name are present, otherwise throw an error.
|
|
141
|
+
if (!(fields === null || fields === void 0 ? void 0 : fields.length) || !collection_name) {
|
|
129
142
|
throw new Error(_1.ERROR_REASONS.CREATE_COLLECTION_CHECK_PARAMS);
|
|
130
143
|
}
|
|
144
|
+
// Check if the fields are valid.
|
|
131
145
|
(0, utils_1.checkCollectionFields)(fields);
|
|
132
146
|
CollectionSchema = this.schemaProto.lookupType('milvus.proto.schema.CollectionSchema');
|
|
133
147
|
FieldSchema = this.schemaProto.lookupType('milvus.proto.schema.FieldSchema');
|
|
134
148
|
payload = {
|
|
135
149
|
name: collection_name,
|
|
136
150
|
description: description || '',
|
|
137
|
-
fields:
|
|
151
|
+
fields: fields.map(function (field) {
|
|
152
|
+
// Assign the typeParams property to the result of parseToKeyValue(type_params).
|
|
153
|
+
var _a = (0, utils_2.assignTypeParams)(field), type_params = _a.type_params, rest = __rest(_a, ["type_params"]);
|
|
154
|
+
return FieldSchema.create(__assign(__assign({}, rest), { typeParams: (0, utils_1.parseToKeyValue)(type_params), dataType: field.data_type, isPrimaryKey: field.is_primary_key }));
|
|
155
|
+
}),
|
|
138
156
|
};
|
|
139
|
-
data.fields.forEach(function (field) {
|
|
140
|
-
field = (0, utils_2.assignTypeParams)(field);
|
|
141
|
-
var value = __assign(__assign({}, field), { typeParams: (0, utils_1.parseToKeyValue)(field.type_params), dataType: field.data_type, isPrimaryKey: field.is_primary_key });
|
|
142
|
-
var fieldParams = FieldSchema.create(value);
|
|
143
|
-
payload.fields.push(fieldParams);
|
|
144
|
-
});
|
|
145
157
|
collectionParams = CollectionSchema.create(payload);
|
|
146
158
|
schemaBytes = CollectionSchema.encode(collectionParams).finish();
|
|
147
|
-
level =
|
|
148
|
-
|
|
149
|
-
: _1.ConsistencyLevelEnum['Bounded'];
|
|
150
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'CreateCollection', __assign(__assign({}, data), { schema: schemaBytes, consistency_level: level }), data.timeout)];
|
|
159
|
+
level = (_a = _1.ConsistencyLevelEnum[consistency_level]) !== null && _a !== void 0 ? _a : _1.ConsistencyLevelEnum.Bounded;
|
|
160
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'CreateCollection', __assign(__assign({}, data), { schema: schemaBytes, consistency_level: level }), data.timeout || this.timeout)];
|
|
151
161
|
case 1:
|
|
152
|
-
promise =
|
|
162
|
+
promise = _d.sent();
|
|
163
|
+
// Return the promise.
|
|
153
164
|
return [2 /*return*/, promise];
|
|
154
165
|
}
|
|
155
166
|
});
|
|
@@ -186,7 +197,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
186
197
|
switch (_a.label) {
|
|
187
198
|
case 0:
|
|
188
199
|
(0, utils_1.checkCollectionName)(data);
|
|
189
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'HasCollection', data, data.timeout)];
|
|
200
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'HasCollection', data, data.timeout || this.timeout)];
|
|
190
201
|
case 1:
|
|
191
202
|
promise = _a.sent();
|
|
192
203
|
return [2 /*return*/, promise];
|
|
@@ -226,7 +237,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
226
237
|
case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'ShowCollections', {
|
|
227
238
|
type: data ? data.type : _1.ShowCollectionsType.All,
|
|
228
239
|
collection_names: (data === null || data === void 0 ? void 0 : data.collection_names) || [],
|
|
229
|
-
}, data === null || data === void 0 ? void 0 : data.timeout)];
|
|
240
|
+
}, (data === null || data === void 0 ? void 0 : data.timeout) || this.timeout)];
|
|
230
241
|
case 1:
|
|
231
242
|
promise = _a.sent();
|
|
232
243
|
result = [];
|
|
@@ -276,7 +287,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
276
287
|
switch (_a.label) {
|
|
277
288
|
case 0:
|
|
278
289
|
(0, utils_1.checkCollectionName)(data);
|
|
279
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'DescribeCollection', data, data.timeout)];
|
|
290
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'DescribeCollection', data, data.timeout || this.timeout)];
|
|
280
291
|
case 1:
|
|
281
292
|
promise = _a.sent();
|
|
282
293
|
return [2 /*return*/, promise];
|
|
@@ -316,7 +327,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
316
327
|
switch (_a.label) {
|
|
317
328
|
case 0:
|
|
318
329
|
(0, utils_1.checkCollectionName)(data);
|
|
319
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetCollectionStatistics', data, data.timeout)];
|
|
330
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetCollectionStatistics', data, data.timeout || this.timeout)];
|
|
320
331
|
case 1:
|
|
321
332
|
promise = _a.sent();
|
|
322
333
|
promise.data = (0, utils_1.formatKeyValueData)(promise.stats, ['row_count']);
|
|
@@ -358,7 +369,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
358
369
|
switch (_a.label) {
|
|
359
370
|
case 0:
|
|
360
371
|
(0, utils_1.checkCollectionName)(data);
|
|
361
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'LoadCollection', data, data.timeout)];
|
|
372
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'LoadCollection', data, data.timeout || this.timeout)];
|
|
362
373
|
case 1:
|
|
363
374
|
promise = _a.sent();
|
|
364
375
|
return [2 /*return*/, promise];
|
|
@@ -399,7 +410,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
399
410
|
switch (_a.label) {
|
|
400
411
|
case 0:
|
|
401
412
|
(0, utils_1.checkCollectionName)(data);
|
|
402
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'LoadCollection', data, data.timeout)];
|
|
413
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'LoadCollection', data, data.timeout || this.timeout)];
|
|
403
414
|
case 1:
|
|
404
415
|
promise = _a.sent();
|
|
405
416
|
if (promise.error_code !== _1.ErrorCode.SUCCESS) {
|
|
@@ -408,20 +419,23 @@ var Collection = /** @class */ (function (_super) {
|
|
|
408
419
|
loadedPercentage = 0;
|
|
409
420
|
_a.label = 2;
|
|
410
421
|
case 2:
|
|
411
|
-
if (!(Number(loadedPercentage) < 100)) return [3 /*break*/,
|
|
412
|
-
return [4 /*yield*/, this.
|
|
413
|
-
|
|
414
|
-
type: _1.ShowCollectionsType.Loaded,
|
|
422
|
+
if (!(Number(loadedPercentage) < 100)) return [3 /*break*/, 5];
|
|
423
|
+
return [4 /*yield*/, this.getLoadingProgress({
|
|
424
|
+
collection_name: data.collection_name,
|
|
415
425
|
})];
|
|
416
426
|
case 3:
|
|
417
427
|
res = _a.sent();
|
|
418
428
|
if (res.status.error_code !== _1.ErrorCode.SUCCESS) {
|
|
419
429
|
throw new Error("ErrorCode: ".concat(res.status.error_code, ". Reason: ").concat(res.status.reason));
|
|
420
430
|
}
|
|
421
|
-
|
|
422
|
-
|
|
431
|
+
loadedPercentage = Number(res.progress);
|
|
432
|
+
// sleep 400ms
|
|
433
|
+
return [4 /*yield*/, (0, utils_1.sleep)(400)];
|
|
434
|
+
case 4:
|
|
435
|
+
// sleep 400ms
|
|
436
|
+
_a.sent();
|
|
423
437
|
return [3 /*break*/, 2];
|
|
424
|
-
case
|
|
438
|
+
case 5: return [2 /*return*/, promise];
|
|
425
439
|
}
|
|
426
440
|
});
|
|
427
441
|
});
|
|
@@ -457,7 +471,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
457
471
|
switch (_a.label) {
|
|
458
472
|
case 0:
|
|
459
473
|
(0, utils_1.checkCollectionName)(data);
|
|
460
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'ReleaseCollection', data, data.timeout)];
|
|
474
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'ReleaseCollection', data, data.timeout || this.timeout)];
|
|
461
475
|
case 1:
|
|
462
476
|
promise = _a.sent();
|
|
463
477
|
return [2 /*return*/, promise];
|
|
@@ -498,7 +512,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
498
512
|
case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'RenameCollection', {
|
|
499
513
|
oldName: data.collection_name,
|
|
500
514
|
newName: data.new_collection_name,
|
|
501
|
-
}, data.timeout)];
|
|
515
|
+
}, data.timeout || this.timeout)];
|
|
502
516
|
case 1:
|
|
503
517
|
promise = _a.sent();
|
|
504
518
|
return [2 /*return*/, promise];
|
|
@@ -536,7 +550,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
536
550
|
switch (_a.label) {
|
|
537
551
|
case 0:
|
|
538
552
|
(0, utils_1.checkCollectionName)(data);
|
|
539
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'DropCollection', data, data.timeout)];
|
|
553
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'DropCollection', data, data.timeout || this.timeout)];
|
|
540
554
|
case 1:
|
|
541
555
|
promise = _a.sent();
|
|
542
556
|
return [2 /*return*/, promise];
|
|
@@ -580,7 +594,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
580
594
|
if (!data.alias) {
|
|
581
595
|
throw new Error(_1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
|
|
582
596
|
}
|
|
583
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'CreateAlias', data, data.timeout)];
|
|
597
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'CreateAlias', data, data.timeout || this.timeout)];
|
|
584
598
|
case 1:
|
|
585
599
|
promise = _a.sent();
|
|
586
600
|
return [2 /*return*/, promise];
|
|
@@ -623,7 +637,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
623
637
|
if (!data.alias) {
|
|
624
638
|
throw new Error(_1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
|
|
625
639
|
}
|
|
626
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'DropAlias', data, data.timeout)];
|
|
640
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'DropAlias', data, data.timeout || this.timeout)];
|
|
627
641
|
case 1:
|
|
628
642
|
promise = _a.sent();
|
|
629
643
|
return [2 /*return*/, promise];
|
|
@@ -667,7 +681,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
667
681
|
if (!data.alias) {
|
|
668
682
|
throw new Error(_1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
|
|
669
683
|
}
|
|
670
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'AlterAlias', data, data.timeout)];
|
|
684
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'AlterAlias', data, data.timeout || this.timeout)];
|
|
671
685
|
case 1:
|
|
672
686
|
promise = _a.sent();
|
|
673
687
|
return [2 /*return*/, promise];
|
|
@@ -710,7 +724,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
710
724
|
collectionInfo = _a.sent();
|
|
711
725
|
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'ManualCompaction', {
|
|
712
726
|
collectionID: collectionInfo.collectionID,
|
|
713
|
-
}, data.timeout)];
|
|
727
|
+
}, data.timeout || this.timeout)];
|
|
714
728
|
case 2:
|
|
715
729
|
res = _a.sent();
|
|
716
730
|
return [2 /*return*/, res];
|
|
@@ -750,7 +764,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
750
764
|
if (!data || !data.compactionID) {
|
|
751
765
|
throw new Error(_1.ERROR_REASONS.COMPACTIONID_IS_REQUIRED);
|
|
752
766
|
}
|
|
753
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetCompactionState', data, data.timeout)];
|
|
767
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetCompactionState', data, data.timeout || this.timeout)];
|
|
754
768
|
case 1:
|
|
755
769
|
res = _a.sent();
|
|
756
770
|
return [2 /*return*/, res];
|
|
@@ -790,7 +804,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
790
804
|
if (!data || !data.compactionID) {
|
|
791
805
|
throw new Error(_1.ERROR_REASONS.COMPACTIONID_IS_REQUIRED);
|
|
792
806
|
}
|
|
793
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetCompactionStateWithPlans', data, data.timeout)];
|
|
807
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetCompactionStateWithPlans', data, data.timeout || this.timeout)];
|
|
794
808
|
case 1:
|
|
795
809
|
res = _a.sent();
|
|
796
810
|
return [2 /*return*/, res];
|
|
@@ -847,7 +861,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
847
861
|
if (!data || !data.collectionID) {
|
|
848
862
|
throw new Error(_1.ERROR_REASONS.COLLECTION_ID_IS_REQUIRED);
|
|
849
863
|
}
|
|
850
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetReplicas', data, data.timeout)];
|
|
864
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetReplicas', data, data.timeout || this.timeout)];
|
|
851
865
|
case 1:
|
|
852
866
|
res = _a.sent();
|
|
853
867
|
return [2 /*return*/, res];
|
|
@@ -856,31 +870,31 @@ var Collection = /** @class */ (function (_super) {
|
|
|
856
870
|
});
|
|
857
871
|
};
|
|
858
872
|
/**
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
873
|
+
* Get loading progress of a collection
|
|
874
|
+
*
|
|
875
|
+
* @param data
|
|
876
|
+
* | Property | Type | Description |
|
|
877
|
+
* | :-- | :-- | :-- |
|
|
878
|
+
* | collection_name | string | the name of the collection |
|
|
879
|
+
* | 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 |
|
|
880
|
+
*
|
|
881
|
+
* @returns
|
|
882
|
+
* | Property | Description |
|
|
883
|
+
* | :-- | :-- |
|
|
884
|
+
* | status | { error_code: number, reason: string } |
|
|
885
|
+
* | total_row_num | the total number of rows in the collection |
|
|
886
|
+
* | total_loaded_row_num | the total number of loaded rows in the collection |
|
|
887
|
+
*
|
|
888
|
+
* @throws {Error} if `collection_name` property is not present in `data`
|
|
889
|
+
*
|
|
890
|
+
* #### Example
|
|
891
|
+
*
|
|
892
|
+
* ```
|
|
893
|
+
* new milvusClient(MILUVS_ADDRESS).getLoadingProgress({
|
|
894
|
+
* collection_name: 'my_collection',
|
|
895
|
+
* });
|
|
896
|
+
* ```
|
|
897
|
+
*/
|
|
884
898
|
Collection.prototype.getLoadingProgress = function (data) {
|
|
885
899
|
return __awaiter(this, void 0, void 0, function () {
|
|
886
900
|
var res;
|
|
@@ -890,7 +904,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
890
904
|
if (!data || !data.collection_name) {
|
|
891
905
|
throw new Error(_1.ERROR_REASONS.COLLECTION_NAME_IS_REQUIRED);
|
|
892
906
|
}
|
|
893
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetLoadingProgress', data, data.timeout)];
|
|
907
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetLoadingProgress', data, data.timeout || this.timeout)];
|
|
894
908
|
case 1:
|
|
895
909
|
res = _a.sent();
|
|
896
910
|
return [2 /*return*/, res];
|
|
@@ -899,30 +913,30 @@ var Collection = /** @class */ (function (_super) {
|
|
|
899
913
|
});
|
|
900
914
|
};
|
|
901
915
|
/**
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
916
|
+
* Get the loading state of a collection
|
|
917
|
+
*
|
|
918
|
+
* @param data
|
|
919
|
+
* | Property | Type | Description |
|
|
920
|
+
* | :-- | :-- | :-- |
|
|
921
|
+
* | collection_name | string | the name of the collection |
|
|
922
|
+
* | 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 |
|
|
923
|
+
*
|
|
924
|
+
* @returns
|
|
925
|
+
* | Property | Description |
|
|
926
|
+
* | :-- | :-- |
|
|
927
|
+
* | status | { error_code: number, reason: string } |
|
|
928
|
+
* | state | the loading state of the collection |
|
|
929
|
+
*
|
|
930
|
+
* @throws {Error} if `collection_name` property is not present in `data`
|
|
931
|
+
*
|
|
932
|
+
* #### Example
|
|
933
|
+
*
|
|
934
|
+
* ```
|
|
935
|
+
* new milvusClient(MILUVS_ADDRESS).getLoadState({
|
|
936
|
+
* collection_name: 'my_collection',
|
|
937
|
+
* });
|
|
938
|
+
* ```
|
|
939
|
+
*/
|
|
926
940
|
Collection.prototype.getLoadState = function (data) {
|
|
927
941
|
return __awaiter(this, void 0, void 0, function () {
|
|
928
942
|
var res;
|
|
@@ -932,7 +946,7 @@ var Collection = /** @class */ (function (_super) {
|
|
|
932
946
|
if (!data || !data.collection_name) {
|
|
933
947
|
throw new Error(_1.ERROR_REASONS.COLLECTION_NAME_IS_REQUIRED);
|
|
934
948
|
}
|
|
935
|
-
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetLoadState', data, data.timeout)];
|
|
949
|
+
return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'GetLoadState', data, data.timeout || this.timeout)];
|
|
936
950
|
case 1:
|
|
937
951
|
res = _a.sent();
|
|
938
952
|
return [2 /*return*/, res];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Collection.js","sourceRoot":"","sources":["../../milvus/Collection.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Collection.js","sourceRoot":"","sources":["../../milvus/Collection.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kCAOkB;AAClB,2CAA0C;AAC1C,sBAmCW;AACX,kCAA4C;AAE5C;;GAEG;AACH;IAAgC,8BAAU;IAA1C;;IAi1BA,CAAC;IAh1BC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,qCAAgB,GAAtB,UAAuB,IAAyB;;;;;;;wBAExC,KAKF,IAAI,IAAI,EAAE,EAJZ,MAAM,YAAA,EACN,eAAe,qBAAA,EACf,WAAW,iBAAA,EACX,yBAA6B,EAA7B,iBAAiB,mBAAG,SAAS,KAAA,CAChB;wBAEf,6EAA6E;wBAC7E,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAA,IAAI,CAAC,eAAe,EAAE;4BACvC,MAAM,IAAI,KAAK,CAAC,gBAAa,CAAC,8BAA8B,CAAC,CAAC;yBAC/D;wBAED,iCAAiC;wBACjC,IAAA,6BAAqB,EAAC,MAAM,CAAC,CAAC;wBAGxB,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAClD,sCAAsC,CACvC,CAAC;wBACI,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAC7C,iCAAiC,CAClC,CAAC;wBAGI,OAAO,GAAG;4BACd,IAAI,EAAE,eAAe;4BACrB,WAAW,EAAE,WAAW,IAAI,EAAE;4BAC9B,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,UAAA,KAAK;gCACtB,gFAAgF;gCAChF,IAAM,KAA2B,IAAA,wBAAgB,EAAC,KAAK,CAAC,EAAhD,WAAW,iBAAA,EAAK,IAAI,cAAtB,eAAwB,CAA0B,CAAC;gCACzD,OAAO,WAAW,CAAC,MAAM,uBACpB,IAAI,KACP,UAAU,EAAE,IAAA,uBAAe,EAAC,WAAW,CAAC,EACxC,QAAQ,EAAE,KAAK,CAAC,SAAS,EACzB,YAAY,EAAE,KAAK,CAAC,cAAc,IAClC,CAAC;4BACL,CAAC,CAAC;yBACH,CAAC;wBAGI,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;wBAGpD,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,MAAM,EAAE,CAAC;wBAGjE,KAAK,GACT,MAAA,uBAAoB,CAAC,iBAAiB,CAAC,mCAAI,uBAAoB,CAAC,OAAO,CAAC;wBAG1D,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,kBAAkB,wBAEb,IAAI,KACP,MAAM,EAAE,WAAW,EACnB,iBAAiB,EAAE,KAAK,KAE1B,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBATK,OAAO,GAAG,SASf;wBAED,sBAAsB;wBACtB,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;KAuBC;IACK,kCAAa,GAAnB,UAAoB,IAAsB;;;;;;wBACxC,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC;wBAEV,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,eAAe,EACf,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;KAuBC;IACK,oCAAe,GAArB,UACE,IAAyB;;;;;4BAET,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,iBAAiB,EACjB;4BACE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,sBAAmB,CAAC,GAAG;4BAChD,gBAAgB,EAAE,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,KAAI,EAAE;yBAC/C,EACD,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,KAAI,IAAI,CAAC,OAAO,CAC9B,EAAA;;wBARK,OAAO,GAAG,SAQf;wBACK,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;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,uCAAkB,GAAxB,UACE,IAA2B;;;;;;wBAE3B,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC;wBAEV,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,oBAAoB,EACpB,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,4CAAuB,GAA7B,UACE,IAAgC;;;;;;wBAEhC,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC;wBAEV,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,yBAAyB,EACzB,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,OAAO,GAAG,SAKf;wBAED,OAAO,CAAC,IAAI,GAAG,IAAA,0BAAkB,EAAC,OAAO,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;wBAEhE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,mCAAc,GAApB,UAAqB,IAAuB;;;;;;wBAC1C,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC;wBAEV,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,gBAAgB,EAChB,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,uCAAkB,GAAxB,UAAyB,IAAuB;;;;;;wBAC9C,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC;wBAEV,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,gBAAgB,EAChB,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,OAAO,GAAG,SAKf;wBAED,IAAI,OAAO,CAAC,UAAU,KAAK,YAAS,CAAC,OAAO,EAAE;4BAC5C,MAAM,IAAI,KAAK,CACb,qBAAc,OAAO,CAAC,UAAU,uBAAa,OAAO,CAAC,MAAM,CAAE,CAC9D,CAAC;yBACH;wBAEG,gBAAgB,GAAG,CAAC,CAAC;;;6BAClB,CAAA,MAAM,CAAC,gBAAgB,CAAC,GAAG,GAAG,CAAA;wBACzB,qBAAM,IAAI,CAAC,kBAAkB,CAAC;gCACtC,eAAe,EAAE,IAAI,CAAC,eAAe;6BACtC,CAAC,EAAA;;wBAFE,GAAG,GAAG,SAER;wBAEF,IAAI,GAAG,CAAC,MAAM,CAAC,UAAU,KAAK,YAAS,CAAC,OAAO,EAAE;4BAC/C,MAAM,IAAI,KAAK,CACb,qBAAc,GAAG,CAAC,MAAM,CAAC,UAAU,uBAAa,GAAG,CAAC,MAAM,CAAC,MAAM,CAAE,CACpE,CAAC;yBACH;wBACD,gBAAgB,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;wBACxC,cAAc;wBACd,qBAAM,IAAA,aAAK,EAAC,GAAG,CAAC,EAAA;;wBADhB,cAAc;wBACd,SAAgB,CAAC;;4BAGnB,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,sCAAiB,GAAvB,UAAwB,IAA8B;;;;;;wBACpD,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC;wBAEV,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,mBAAmB,EACnB,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,qCAAgB,GAAtB,UAAuB,IAAyB;;;;;4BAC9B,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,kBAAkB,EAClB;4BACE,OAAO,EAAE,IAAI,CAAC,eAAe;4BAC7B,OAAO,EAAE,IAAI,CAAC,mBAAmB;yBAClC,EACD,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBARK,OAAO,GAAG,SAQf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,mCAAc,GAApB,UAAqB,IAAuB;;;;;;wBAC1C,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC;wBAEV,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,gBAAgB,EAChB,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,gCAAW,GAAjB,UAAkB,IAAoB;;;;;;wBACpC,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC;wBAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;4BACf,MAAM,IAAI,KAAK,CAAC,gBAAa,CAAC,sBAAsB,CAAC,CAAC;yBACvD;wBACe,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,aAAa,EACb,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,8BAAS,GAAf,UAAgB,IAAkB;;;;;;wBAChC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;4BACf,MAAM,IAAI,KAAK,CAAC,gBAAa,CAAC,sBAAsB,CAAC,CAAC;yBACvD;wBACe,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,WAAW,EACX,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,+BAAU,GAAhB,UAAiB,IAAmB;;;;;;wBAClC,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC;wBAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;4BACf,MAAM,IAAI,KAAK,CAAC,gBAAa,CAAC,sBAAsB,CAAC,CAAC;yBACvD;wBACe,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,UAAU,EACf,YAAY,EACZ,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,4BAAO,GAAb,UAAc,IAAgB;;;;;;wBAC5B,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC;wBACH,qBAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAA;;wBAApD,cAAc,GAAG,SAAmC;wBAC9C,qBAAM,IAAA,iBAAS,EACzB,IAAI,CAAC,UAAU,EACf,kBAAkB,EAClB;gCACE,YAAY,EAAE,cAAc,CAAC,YAAY;6BAC1C,EACD,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBAPK,GAAG,GAAG,SAOX;wBACD,sBAAO,GAAG,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,uCAAkB,GAAxB,UACE,IAA2B;;;;;;wBAE3B,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;4BAC/B,MAAM,IAAI,KAAK,CAAC,gBAAa,CAAC,wBAAwB,CAAC,CAAC;yBACzD;wBACW,qBAAM,IAAA,iBAAS,EACzB,IAAI,CAAC,UAAU,EACf,oBAAoB,EACpB,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,GAAG,GAAG,SAKX;wBACD,sBAAO,GAAG,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,gDAA2B,GAAjC,UACE,IAA2B;;;;;;wBAE3B,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;4BAC/B,MAAM,IAAI,KAAK,CAAC,gBAAa,CAAC,wBAAwB,CAAC,CAAC;yBACzD;wBACW,qBAAM,IAAA,iBAAS,EACzB,IAAI,CAAC,UAAU,EACf,6BAA6B,EAC7B,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,GAAG,GAAG,SAKX;wBACD,sBAAO,GAAG,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACG,gCAAW,GAAjB,UAAkB,IAAmB;;;;;;wBACnC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;4BAC/B,MAAM,IAAI,KAAK,CAAC,gBAAa,CAAC,yBAAyB,CAAC,CAAC;yBAC1D;wBACW,qBAAM,IAAA,iBAAS,EACzB,IAAI,CAAC,UAAU,EACf,aAAa,EACb,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,GAAG,GAAG,SAKX;wBACD,sBAAO,GAAG,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,uCAAkB,GAAxB,UACE,IAA2B;;;;;;wBAE3B,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;4BAClC,MAAM,IAAI,KAAK,CAAC,gBAAa,CAAC,2BAA2B,CAAC,CAAC;yBAC5D;wBACW,qBAAM,IAAA,iBAAS,EACzB,IAAI,CAAC,UAAU,EACf,oBAAoB,EACpB,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,GAAG,GAAG,SAKX;wBACD,sBAAO,GAAG,EAAC;;;;KACZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,iCAAY,GAAlB,UAAmB,IAAqB;;;;;;wBACtC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;4BAClC,MAAM,IAAI,KAAK,CAAC,gBAAa,CAAC,2BAA2B,CAAC,CAAC;yBAC5D;wBACW,qBAAM,IAAA,iBAAS,EACzB,IAAI,CAAC,UAAU,EACf,cAAc,EACd,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,EAAA;;wBALK,GAAG,GAAG,SAKX;wBACD,sBAAO,GAAG,EAAC;;;;KACZ;IACH,iBAAC;AAAD,CAAC,AAj1BD,CAAgC,uBAAU,GAi1BzC;AAj1BY,gCAAU"}
|
package/dist/milvus/Data.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DataType, DeleteEntitiesReq, FlushReq, GetFlushStateReq, GetQuerySegmentInfoReq, InsertReq, LoadBalanceReq, ImportReq, ListImportTasksReq, FlushResult, GetFlushStateResponse, GetMetricsResponse, GetQuerySegmentInfoResponse, MutationResult, QueryResults, ResStatus, SearchResults, ImportResponse, ListImportTasksResponse, GetMetricsRequest, QueryReq, SearchReq } from '.';
|
|
1
|
+
import { DataType, DeleteEntitiesReq, FlushReq, GetFlushStateReq, GetQuerySegmentInfoReq, InsertReq, LoadBalanceReq, ImportReq, ListImportTasksReq, FlushResult, GetFlushStateResponse, GetMetricsResponse, GetQuerySegmentInfoResponse, MutationResult, QueryResults, ResStatus, SearchResults, ImportResponse, ListImportTasksResponse, GetMetricsRequest, QueryReq, SearchReq, SearchSimpleReq } from '.';
|
|
2
2
|
import { Collection } from './Collection';
|
|
3
3
|
export declare class Data extends Collection {
|
|
4
4
|
vectorTypes: DataType[];
|
|
@@ -73,15 +73,16 @@ export declare class Data extends Collection {
|
|
|
73
73
|
* | Property | Type | Description |
|
|
74
74
|
* | :--- | :-- | :-- |
|
|
75
75
|
* | collection_name | String | Collection name |
|
|
76
|
+
* | vectors or vector | Number[][] or Number[] | Original vector to search with |
|
|
76
77
|
* | partition_names(optional)| String[] | Array of partition names |
|
|
77
|
-
* |
|
|
78
|
-
* |
|
|
79
|
-
* |
|
|
80
|
-
* |
|
|
81
|
-
* |
|
|
82
|
-
* |
|
|
83
|
-
* |
|
|
84
|
-
|
|
78
|
+
* | limit(optional) | number | topk alias |
|
|
79
|
+
* | topk(optional) | number | topk |
|
|
80
|
+
* | offset(optional) | number | offset |
|
|
81
|
+
* | filter(optional) | String | Scalar field filter expression |
|
|
82
|
+
* | expr(optional) | String | filter alias |
|
|
83
|
+
* | output_fields(optional) | String[] | Support scalar field |
|
|
84
|
+
* | metric_type(optional) | String | similarity metric |
|
|
85
|
+
* | params(optional) | key value object | search params |
|
|
85
86
|
*
|
|
86
87
|
* @returns
|
|
87
88
|
* | Property | Description |
|
|
@@ -89,27 +90,16 @@ export declare class Data extends Collection {
|
|
|
89
90
|
* | status | { error_code: number, reason: string } |
|
|
90
91
|
* | results | {score:number,id:string}[]; |
|
|
91
92
|
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
93
|
* #### Example
|
|
95
94
|
*
|
|
96
95
|
* ```
|
|
97
96
|
* new milvusClient(MILUVS_ADDRESS).search({
|
|
98
97
|
* collection_name: COLLECTION_NAME,
|
|
99
|
-
*
|
|
100
|
-
* vectors: [[1, 2, 3, 4]],
|
|
101
|
-
* search_params: {
|
|
102
|
-
* anns_field: VECTOR_FIELD_NAME,
|
|
103
|
-
* topk: "4",
|
|
104
|
-
* metric_type: "L2",
|
|
105
|
-
* params: JSON.stringify({ nprobe: 1024 }),
|
|
106
|
-
* },
|
|
107
|
-
* output_fields: ["age", "time"],
|
|
108
|
-
* vector_type: 100,
|
|
98
|
+
* vector: [1, 2, 3, 4],
|
|
109
99
|
* });
|
|
110
100
|
* ```
|
|
111
101
|
*/
|
|
112
|
-
search(data: SearchReq): Promise<SearchResults>;
|
|
102
|
+
search(data: SearchReq | SearchSimpleReq): Promise<SearchResults>;
|
|
113
103
|
/**
|
|
114
104
|
* Milvus temporarily buffers the newly inserted vectors in the cache. Call `flush()` to persist them to the object storage.
|
|
115
105
|
* It's async function, so it's will take some times to excute.
|