@zilliz/milvus2-sdk-node 2.4.9 → 2.5.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 (43) hide show
  1. package/dist/milvus/MilvusClient.js +3 -0
  2. package/dist/milvus/MilvusClient.js.map +1 -1
  3. package/dist/milvus/const/client.d.ts +2 -1
  4. package/dist/milvus/const/client.js +1 -0
  5. package/dist/milvus/const/client.js.map +1 -1
  6. package/dist/milvus/const/limits.d.ts +1 -0
  7. package/dist/milvus/const/limits.js +2 -1
  8. package/dist/milvus/const/limits.js.map +1 -1
  9. package/dist/milvus/const/milvus.d.ts +8 -2
  10. package/dist/milvus/const/milvus.js +10 -1
  11. package/dist/milvus/const/milvus.js.map +1 -1
  12. package/dist/milvus/grpc/BaseClient.d.ts +2 -3
  13. package/dist/milvus/grpc/BaseClient.js +13 -7
  14. package/dist/milvus/grpc/BaseClient.js.map +1 -1
  15. package/dist/milvus/grpc/Collection.d.ts +2 -2
  16. package/dist/milvus/grpc/Collection.js +13 -7
  17. package/dist/milvus/grpc/Collection.js.map +1 -1
  18. package/dist/milvus/grpc/Data.js +54 -19
  19. package/dist/milvus/grpc/Data.js.map +1 -1
  20. package/dist/milvus/grpc/Database.js +4 -1
  21. package/dist/milvus/grpc/Database.js.map +1 -1
  22. package/dist/milvus/types/Client.d.ts +2 -0
  23. package/dist/milvus/types/Collection.d.ts +23 -3
  24. package/dist/milvus/types/Common.d.ts +1 -1
  25. package/dist/milvus/types/Data.d.ts +17 -5
  26. package/dist/milvus/types/Database.d.ts +1 -0
  27. package/dist/milvus/utils/Bytes.d.ts +3 -3
  28. package/dist/milvus/utils/Bytes.js +27 -20
  29. package/dist/milvus/utils/Bytes.js.map +1 -1
  30. package/dist/milvus/utils/Format.d.ts +12 -12
  31. package/dist/milvus/utils/Format.js +101 -57
  32. package/dist/milvus/utils/Format.js.map +1 -1
  33. package/dist/milvus/utils/Function.d.ts +2 -1
  34. package/dist/milvus/utils/Function.js +9 -1
  35. package/dist/milvus/utils/Function.js.map +1 -1
  36. package/dist/proto/proto/common.proto +27 -0
  37. package/dist/proto/proto/google/protobuf/descriptor.proto +45 -1
  38. package/dist/proto/proto/milvus.proto +131 -3
  39. package/dist/proto/proto/msg.proto +1 -0
  40. package/dist/proto/proto/rg.proto +7 -0
  41. package/dist/proto/proto/schema.proto +58 -0
  42. package/dist/sdk.json +1 -1
  43. package/package.json +3 -3
@@ -27,6 +27,7 @@ service MilvusService {
27
27
  rpc GetCollectionStatistics(GetCollectionStatisticsRequest) returns (GetCollectionStatisticsResponse) {}
28
28
  rpc ShowCollections(ShowCollectionsRequest) returns (ShowCollectionsResponse) {}
29
29
  rpc AlterCollection(AlterCollectionRequest) returns (common.Status) {}
30
+ rpc AlterCollectionField(AlterCollectionFieldRequest) returns (common.Status) {}
30
31
 
31
32
  rpc CreatePartition(CreatePartitionRequest) returns (common.Status) {}
32
33
  rpc DropPartition(DropPartitionRequest) returns (common.Status) {}
@@ -107,6 +108,7 @@ service MilvusService {
107
108
  rpc SelectRole(SelectRoleRequest) returns (SelectRoleResponse) {}
108
109
  rpc SelectUser(SelectUserRequest) returns (SelectUserResponse) {}
109
110
  rpc OperatePrivilege(OperatePrivilegeRequest) returns (common.Status) {}
111
+ rpc OperatePrivilegeV2(OperatePrivilegeV2Request) returns (common.Status) {}
110
112
  rpc SelectGrant(SelectGrantRequest) returns (SelectGrantResponse) {}
111
113
 
112
114
  rpc GetVersion(GetVersionRequest) returns (GetVersionResponse) {}
@@ -139,6 +141,11 @@ service MilvusService {
139
141
 
140
142
  rpc BackupRBAC(BackupRBACMetaRequest) returns (BackupRBACMetaResponse){}
141
143
  rpc RestoreRBAC(RestoreRBACMetaRequest) returns (common.Status){}
144
+
145
+ rpc CreatePrivilegeGroup(CreatePrivilegeGroupRequest) returns (common.Status) {}
146
+ rpc DropPrivilegeGroup(DropPrivilegeGroupRequest) returns (common.Status) {}
147
+ rpc ListPrivilegeGroups(ListPrivilegeGroupsRequest) returns (ListPrivilegeGroupsResponse) {}
148
+ rpc OperatePrivilegeGroup(OperatePrivilegeGroupRequest) returns (common.Status) {}
142
149
  }
143
150
 
144
151
  message CreateAliasRequest {
@@ -282,6 +289,22 @@ message AlterCollectionRequest {
282
289
  string collection_name = 3;
283
290
  int64 collectionID = 4;
284
291
  repeated common.KeyValuePair properties = 5;
292
+ repeated string delete_keys = 6;
293
+ }
294
+
295
+ message AlterCollectionFieldRequest {
296
+ option (common.privilege_ext_obj) = {
297
+ object_type: Global
298
+ object_privilege: PrivilegeCreateCollection
299
+ object_name_index: -1
300
+ };
301
+ // Not useful for now
302
+ common.MsgBase base = 1;
303
+ string db_name = 2;
304
+ // The unique collection name in milvus.(Required)
305
+ string collection_name = 3;
306
+ string field_name =4;
307
+ repeated common.KeyValuePair properties = 5;
285
308
  }
286
309
 
287
310
  /**
@@ -359,7 +382,7 @@ message DescribeCollectionResponse {
359
382
  repeated common.KeyValuePair properties = 13;
360
383
  string db_name = 14;
361
384
  int64 num_partitions = 15;
362
- int64 db_id = 16;
385
+ int64 db_id =16;
363
386
  }
364
387
 
365
388
  /**
@@ -736,6 +759,7 @@ message AlterIndexRequest {
736
759
  string collection_name = 3;
737
760
  string index_name = 4;
738
761
  repeated common.KeyValuePair extra_params = 5;
762
+ repeated string delete_keys = 6;
739
763
  }
740
764
 
741
765
  /*
@@ -905,6 +929,7 @@ message DeleteRequest {
905
929
  string expr = 5;
906
930
  repeated uint32 hash_keys = 6;
907
931
  common.ConsistencyLevel consistency_level = 7;
932
+ map<string, schema.TemplateValue> expr_template_values = 8;
908
933
  }
909
934
 
910
935
 
@@ -914,10 +939,10 @@ message SubSearchRequest {
914
939
  bytes placeholder_group = 2; // must
915
940
  common.DslType dsl_type = 3; // must
916
941
  repeated common.KeyValuePair search_params = 4; // must
917
- int64 nq = 5;
942
+ int64 nq = 5;
943
+ map<string, schema.TemplateValue> expr_template_values = 6;
918
944
  }
919
945
 
920
-
921
946
  message SearchRequest {
922
947
  option (common.privilege_ext_obj) = {
923
948
  object_type: Collection
@@ -942,6 +967,7 @@ message SearchRequest {
942
967
  bool use_default_consistency = 15;
943
968
  bool search_by_primary_keys = 16;
944
969
  repeated SubSearchRequest sub_reqs = 17;
970
+ map<string, schema.TemplateValue> expr_template_values = 18;
945
971
  }
946
972
 
947
973
  message Hits {
@@ -954,6 +980,7 @@ message SearchResults {
954
980
  common.Status status = 1;
955
981
  schema.SearchResultData results = 2;
956
982
  string collection_name = 3;
983
+ uint64 session_ts = 4; // for session-like operation like iterator
957
984
  }
958
985
 
959
986
  message HybridSearchRequest {
@@ -1015,6 +1042,7 @@ message QueryRequest {
1015
1042
  bool not_return_all_meta = 10;
1016
1043
  common.ConsistencyLevel consistency_level = 11;
1017
1044
  bool use_default_consistency = 12;
1045
+ map<string, schema.TemplateValue> expr_template_values = 13;
1018
1046
  }
1019
1047
 
1020
1048
  message QueryResults {
@@ -1022,6 +1050,7 @@ message QueryResults {
1022
1050
  repeated schema.FieldData fields_data = 2;
1023
1051
  string collection_name = 3;
1024
1052
  repeated string output_fields = 4;
1053
+ uint64 session_ts = 5; // for session-like operation like iterator
1025
1054
  }
1026
1055
 
1027
1056
  message VectorIDs {
@@ -1076,6 +1105,7 @@ message PersistentSegmentInfo {
1076
1105
  int64 num_rows = 4;
1077
1106
  common.SegmentState state = 5;
1078
1107
  common.SegmentLevel level = 6;
1108
+ bool is_sorted = 7;
1079
1109
  }
1080
1110
 
1081
1111
  message GetPersistentSegmentInfoRequest {
@@ -1102,6 +1132,7 @@ message QuerySegmentInfo {
1102
1132
  common.SegmentState state = 9;
1103
1133
  repeated int64 nodeIds = 10;
1104
1134
  common.SegmentLevel level = 11;
1135
+ bool is_sorted = 12;
1105
1136
  }
1106
1137
 
1107
1138
  message GetQuerySegmentInfoRequest {
@@ -1437,6 +1468,66 @@ message DropRoleRequest {
1437
1468
  bool force_drop = 3;
1438
1469
  }
1439
1470
 
1471
+ message CreatePrivilegeGroupRequest {
1472
+ option (common.privilege_ext_obj) = {
1473
+ object_type: Global
1474
+ object_privilege: PrivilegeCreatePrivilegeGroup
1475
+ object_name_index: -1
1476
+ };
1477
+ // Not useful for now
1478
+ common.MsgBase base = 1;
1479
+ // group name
1480
+ string group_name = 2;
1481
+ }
1482
+
1483
+ message DropPrivilegeGroupRequest {
1484
+ option (common.privilege_ext_obj) = {
1485
+ object_type: Global
1486
+ object_privilege: PrivilegeDropPrivilegeGroup
1487
+ object_name_index: -1
1488
+ };
1489
+ // Not useful for now
1490
+ common.MsgBase base = 1;
1491
+ // group name
1492
+ string group_name = 2;
1493
+ }
1494
+
1495
+ message ListPrivilegeGroupsRequest {
1496
+ option (common.privilege_ext_obj) = {
1497
+ object_type: Global
1498
+ object_privilege: PrivilegeListPrivilegeGroups
1499
+ object_name_index: -1
1500
+ };
1501
+ // Not useful for now
1502
+ common.MsgBase base = 1;
1503
+ }
1504
+
1505
+ message ListPrivilegeGroupsResponse {
1506
+ common.Status status = 1;
1507
+ repeated PrivilegeGroupInfo privilege_groups = 2;
1508
+ }
1509
+
1510
+ message OperatePrivilegeGroupRequest {
1511
+ option (common.privilege_ext_obj) = {
1512
+ object_type: Global
1513
+ object_privilege: PrivilegeOperatePrivilegeGroup
1514
+ object_name_index: -1
1515
+ };
1516
+ // Not useful for now
1517
+ common.MsgBase base = 1;
1518
+ // group name
1519
+ string group_name = 2;
1520
+ // privileges
1521
+ repeated PrivilegeEntity privileges = 3;
1522
+ // operation type
1523
+ OperatePrivilegeGroupType type = 4;
1524
+ }
1525
+
1526
+ enum OperatePrivilegeGroupType {
1527
+ AddPrivilegesToGroup = 0;
1528
+ RemovePrivilegesFromGroup = 1;
1529
+ }
1530
+
1440
1531
  enum OperateUserRoleType {
1441
1532
  AddUserToRole = 0;
1442
1533
  RemoveUserFromRole = 1;
@@ -1458,6 +1549,11 @@ message OperateUserRoleRequest {
1458
1549
  OperateUserRoleType type = 4;
1459
1550
  }
1460
1551
 
1552
+ message PrivilegeGroupInfo {
1553
+ string group_name = 1;
1554
+ repeated PrivilegeEntity privileges = 2;
1555
+ }
1556
+
1461
1557
  message SelectRoleRequest {
1462
1558
  option (common.privilege_ext_obj) = {
1463
1559
  object_type: Global
@@ -1540,6 +1636,12 @@ message GrantEntity {
1540
1636
  string db_name = 5;
1541
1637
  }
1542
1638
 
1639
+ enum PrivilegeLevel {
1640
+ Cluster = 0;
1641
+ Database = 1;
1642
+ Collection = 2;
1643
+ }
1644
+
1543
1645
  message SelectGrantRequest {
1544
1646
  option (common.privilege_ext_obj) = {
1545
1647
  object_type: Global
@@ -1576,6 +1678,29 @@ message OperatePrivilegeRequest {
1576
1678
  GrantEntity entity = 2;
1577
1679
  // operation type
1578
1680
  OperatePrivilegeType type = 3;
1681
+ // version
1682
+ string version = 4;
1683
+ }
1684
+
1685
+
1686
+ message OperatePrivilegeV2Request {
1687
+ option (common.privilege_ext_obj) = {
1688
+ object_type: Global
1689
+ object_privilege: PrivilegeManageOwnership
1690
+ object_name_index: -1
1691
+ };
1692
+ // Not useful for now
1693
+ common.MsgBase base = 1;
1694
+ // role
1695
+ RoleEntity role = 2;
1696
+ // privilege
1697
+ GrantorEntity grantor = 3;
1698
+ // operation type
1699
+ OperatePrivilegeType type = 4;
1700
+ // db name
1701
+ string db_name = 5;
1702
+ // collection name
1703
+ string collection_name = 6;
1579
1704
  }
1580
1705
 
1581
1706
  message UserInfo {
@@ -1591,6 +1716,8 @@ message RBACMeta {
1591
1716
  repeated milvus.RoleEntity roles = 2;
1592
1717
  // (role, object, previledge)
1593
1718
  repeated milvus.GrantEntity grants = 3;
1719
+ // privilege group info
1720
+ repeated milvus.PrivilegeGroupInfo privilege_groups = 4;
1594
1721
  }
1595
1722
 
1596
1723
  message BackupRBACMetaRequest {
@@ -1880,6 +2007,7 @@ message ListDatabasesResponse {
1880
2007
  common.Status status = 1;
1881
2008
  repeated string db_names = 2;
1882
2009
  repeated uint64 created_timestamp = 3;
2010
+ repeated int64 db_ids = 4;
1883
2011
  }
1884
2012
 
1885
2013
  message AlterDatabaseRequest {
@@ -43,6 +43,7 @@ message DeleteRequest {
43
43
  repeated uint64 timestamps = 10;
44
44
  int64 num_rows = 11;
45
45
  schema.IDs primary_keys = 12;
46
+ int64 segment_id = 13;
46
47
  }
47
48
 
48
49
  message MsgPosition {
@@ -10,6 +10,8 @@ option java_generate_equals_and_hash = true;
10
10
 
11
11
  option csharp_namespace = "Milvus.Client.Grpc";
12
12
 
13
+ import "common.proto";
14
+
13
15
  message ResourceGroupLimit {
14
16
  int32 node_num = 1;
15
17
  // preserve for other limit.
@@ -19,10 +21,15 @@ message ResourceGroupTransfer {
19
21
  string resource_group = 1; // resource groups can be transfered with current resource group.
20
22
  // preserve for other option, such as weight, priority or affinity setup.
21
23
  }
24
+
25
+ message ResourceGroupNodeFilter {
26
+ repeated common.KeyValuePair node_labels = 1; // node in resource group must match node labels requirements
27
+ }
22
28
 
23
29
  message ResourceGroupConfig {
24
30
  ResourceGroupLimit requests = 1; // requests node num in resource group, if node num is less than requests.nodeNum, it will be transfer from other resource group.
25
31
  ResourceGroupLimit limits = 2; // limited node num in resource group, if node num is more than limits.nodeNum, it will be transfer to other resource group.
26
32
  repeated ResourceGroupTransfer transfer_from = 3; // missing node should be transfer from given resource group at high priority in repeated list.
27
33
  repeated ResourceGroupTransfer transfer_to = 4; // redundant node should be transfer to given resource group at high priority in repeated list.
34
+ ResourceGroupNodeFilter node_filter = 5; // node in resource group must match node filters
28
35
  }
@@ -31,6 +31,7 @@ enum DataType {
31
31
  VarChar = 21; // variable-length strings with a specified maximum length
32
32
  Array = 22;
33
33
  JSON = 23;
34
+ Geometry = 24;
34
35
 
35
36
  BinaryVector = 100;
36
37
  FloatVector = 101;
@@ -39,6 +40,12 @@ enum DataType {
39
40
  SparseFloatVector = 104;
40
41
  }
41
42
 
43
+ enum FunctionType{
44
+ Unknown =0;
45
+ BM25 =1;
46
+ TextEmbedding =2;
47
+ }
48
+
42
49
  enum FieldState {
43
50
  FieldCreated = 0;
44
51
  FieldCreating = 1;
@@ -65,6 +72,20 @@ message FieldSchema {
65
72
  bool is_dynamic = 12; // mark whether this field is the dynamic field
66
73
  bool is_partition_key = 13; // enable logic partitions
67
74
  bool is_clustering_key = 14;
75
+ bool nullable = 15; // enable set null as field value
76
+ bool is_function_output =16;
77
+ }
78
+
79
+ message FunctionSchema {
80
+ string name = 1;
81
+ int64 id =2;
82
+ string description = 3;
83
+ FunctionType type = 4;
84
+ repeated string input_field_names = 5;
85
+ repeated int64 input_field_ids = 6;
86
+ repeated string output_field_names = 7;
87
+ repeated int64 output_field_ids = 8;
88
+ repeated common.KeyValuePair params = 9;
68
89
  }
69
90
 
70
91
  /**
@@ -77,6 +98,7 @@ message CollectionSchema {
77
98
  repeated FieldSchema fields = 4;
78
99
  bool enable_dynamic_field = 5; // mark whether this table has the dynamic field function enabled.
79
100
  repeated common.KeyValuePair properties = 6;
101
+ repeated FunctionSchema functions = 7;
80
102
  }
81
103
 
82
104
  message BoolArray { repeated bool data = 1; }
@@ -101,6 +123,8 @@ message ArrayArray {
101
123
 
102
124
  message JSONArray { repeated bytes data = 1; }
103
125
 
126
+ message GeometryArray { repeated bytes data = 1; }
127
+
104
128
  message ValueField {
105
129
  oneof data {
106
130
  bool bool_data = 1;
@@ -124,6 +148,7 @@ message ScalarField {
124
148
  BytesArray bytes_data = 7;
125
149
  ArrayArray array_data = 8;
126
150
  JSONArray json_data = 9;
151
+ GeometryArray geometry_data = 10;
127
152
  }
128
153
  }
129
154
 
@@ -155,6 +180,7 @@ message FieldData {
155
180
  }
156
181
  int64 field_id = 5;
157
182
  bool is_dynamic = 6;
183
+ repeated bool valid_data = 7;
158
184
  }
159
185
 
160
186
  message IDs {
@@ -164,6 +190,11 @@ message IDs {
164
190
  }
165
191
  }
166
192
 
193
+ message SearchIteratorV2Results {
194
+ string token = 1;
195
+ float last_bound = 2;
196
+ }
197
+
167
198
  message SearchResultData {
168
199
  int64 num_queries = 1;
169
200
  int64 top_k = 2;
@@ -175,6 +206,8 @@ message SearchResultData {
175
206
  FieldData group_by_field_value = 8;
176
207
  int64 all_search_count = 9;
177
208
  repeated float distances = 10;
209
+ optional SearchIteratorV2Results search_iterator_v2_results = 11;
210
+ repeated float recalls = 12;
178
211
  }
179
212
 
180
213
  // vector field clustering info
@@ -195,3 +228,28 @@ message ClusteringInfo {
195
228
  repeated VectorClusteringInfo vector_clustering_infos = 1;
196
229
  repeated ScalarClusteringInfo scalar_clustering_infos = 2;
197
230
  }
231
+
232
+ message TemplateValue {
233
+ oneof val {
234
+ bool bool_val = 1;
235
+ int64 int64_val = 2;
236
+ double float_val = 3;
237
+ string string_val = 4;
238
+ TemplateArrayValue array_val = 5;
239
+ };
240
+ }
241
+
242
+ message TemplateArrayValue {
243
+ oneof data {
244
+ BoolArray bool_data = 1;
245
+ LongArray long_data = 2;
246
+ DoubleArray double_data = 3;
247
+ StringArray string_data = 4;
248
+ TemplateArrayValueArray array_data = 5;
249
+ JSONArray json_data = 6;
250
+ }
251
+ }
252
+
253
+ message TemplateArrayValueArray {
254
+ repeated TemplateArrayValue data = 1;
255
+ }
package/dist/sdk.json CHANGED
@@ -1 +1 @@
1
- {"version":"2.4.9","milvusVersion":"v2.4.11"}
1
+ {"version":"2.5.0","milvusVersion":"v2.5.0-beta"}
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@zilliz/milvus2-sdk-node",
3
3
  "author": "ued@zilliz.com",
4
- "version": "2.4.9",
5
- "milvusVersion": "v2.4.11",
4
+ "milvusVersion": "v2.5.0-beta",
5
+ "version": "2.5.0",
6
6
  "main": "dist/milvus",
7
7
  "files": [
8
8
  "dist"
@@ -20,7 +20,7 @@
20
20
  "doc-json": "npx typedoc milvus --json"
21
21
  },
22
22
  "dependencies": {
23
- "@grpc/grpc-js": "^1.8.22",
23
+ "@grpc/grpc-js": "^1.12.1",
24
24
  "@grpc/proto-loader": "^0.7.10",
25
25
  "@petamoriken/float16": "^3.8.6",
26
26
  "dayjs": "^1.11.7",