@zilliz/milvus2-sdk-node 2.2.9 → 2.2.11

package/README.md

@@ -78,7 +78,7 @@ Create a new app.js file and add the following code to try out some basic vector
 ```javascript
 import { MilvusClient, DataType } from '@zilliz/milvus2-sdk-node';
 
-const address = 'your-milvus-ip';
+const address = 'your-milvus-ip-with-port';
 const username = 'your-milvus-username'; // optional username
 const password = 'your-milvus-password'; // optional password
 const ssl = false; // secure or not
@@ -87,17 +87,20 @@ const ssl = false; // secure or not
 const client = new MilvusClient({ address, ssl, username, password });
 ```
 
-| Parameters  | Description                                                                       | Type    | Example             |
-| ----------- | --------------------------------------------------------------------------------- | ------- | ------------------- |
-| address     | The Milvus IP address                                                             | String  | '192.168.0.1:19530' |
-| ssl?        | SSL connection. It is false by default.                                           | Boolean | false               |
-| username?   | The username used to connect to Milvus                                            | String  | milvus              |
-| address?    | The password used to connect to Milvus                                            | String  | milvus              |
-| maxRetries? | The number of retries for the grpc method, by default: 3                          | Number  | 3                   |
-| retryDelay? | The delay between attempts at retrying a failed grpc method in ms, by default: 30 | Number  | 30                  |
+| Parameters      | Description                                                                                                              | Type    | Example             |
+| --------------- | ------------------------------------------------------------------------------------------------------------------------ | ------- | ------------------- |
+| address         | The Milvus IP address                                                                                                    | String  | '192.168.0.1:19530' |
+| ssl?            | SSL connection. It is false by default.                                                                                  | Boolean | false               |
+| username?       | The username used to connect to Milvus                                                                                   | String  | milvus              |
+| address?        | The password used to connect to Milvus                                                                                   | String  | milvus              |
+| maxRetries?     | The number of retries for the grpc method, by default: 3                                                                 | Number  | 3                   |
+| retryDelay?     | The delay between attempts at retrying a failed grpc method in ms, by default: 30                                        | Number  | 30                  |
+| channelOptions? | an optional configuration object that can be passed to a gRPC client when creating a channel to connect to a gRPC server | Object  |                     |
 
 ### define schema for collection
 
+The code shows an example of how to define a schema for a collection in Milvus using the Milvus Node SDK. A schema defines the properties of a collection, such as the names and data types of the fields that make up the vectors.
+
 ```javascript
 // define schema
 const collection_name = `book`;
@@ -124,6 +127,20 @@ const schema = [
 ];
 ```
 
+In the code, the schema variable is defined as an array of objects, where each object represents a field in the collection. The fields are defined using the following properties:
+
+`name`: The name of the field, which must be unique within the collection.
+
+`description`: A description of the field, which can be used to provide additional information about the field.
+
+`data_type`: The data type of the field, which can be one of several predefined data types such as Int64 or FloatVector.
+
+`is_primary_key`: A boolean flag that indicates whether the field is a primary key. Primary keys are unique identifiers for each vector in the collection, and can be used to efficiently retrieve specific vectors.
+
+`autoID`: A boolean flag that indicates whether the primary key is automatically generated by Milvus.
+
+`dim`: The dimensionality of the vector field. For fields of type FloatVector, this specifies the number of dimensions in each vector.
+
 ### create collection
 
 ```javascript
@@ -136,6 +153,8 @@ await client.createCollection({
 
 ### prepare data
 
+When using the Milvus Node SDK to insert data into a collection, it's important to ensure that the data format of the input matches the schema defined for the collection. The data format used by the Milvus Node SDK consists of an array of objects, where each object represents an entity. Typically, each object contains a unique identifier for the entity, which can be an integer or string, and a vector field that stores the feature values as an array of floating-point numbers.
+
 ```javascript
 // generate mock data
 const fields_data = [];
@@ -155,6 +174,8 @@ for (let i = 0; i < 1000; i++) {
 
 ### insert data into collection
 
+Once we have the data, you can insert data into the collection.
+
 ```javascript
 await client.insert({
   collection_name,
@@ -162,7 +183,9 @@ await client.insert({
 });
 ```
 
-### create index and load collection into memory
+### create index
+
+By creating an index and loading the collection into memory, you can improve the performance of search and retrieval operations in Milvus, making it faster and more efficient to work with large-scale datasets.
 
 ```javascript
 // create index
@@ -170,9 +193,31 @@ await client.createIndex({
   collection_name,
   field_name: 'book_intro',
   index_name: 'myindex',
-  index_type: 'IVF_FLAT',
+  index_type: 'HNSW',
+  params: { efConstruction: 10, M: 4 },
   metric_type: 'L2',
 });
+```
+
+Milvus supports [several different types of indexes](https://milvus.io/docs/index.md), each of which is optimized for different use cases and data distributions. Some of the most commonly used index types in Milvus include IVF_FLAT, IVF_SQ8, IVF_PQ, and HNSW. When creating an index in Milvus, you must choose an appropriate index type based on your specific use case and data distribution.
+
+`collection_name`: The name of the collection to create the index for.
+
+`field_name`: The name of the field to create the index on.
+
+`index_name`: The name of the index to create.
+
+`index_type`: The type of index to create.
+
+`param`: The index build parameters, please refer to the [index docs](https://milvus.io/docs/index.md).
+
+`metric_type`: The distance metric to use when computing the similarity between vectors. In this case, the metric type is set to L2, which is a commonly used metric for computing the Euclidean distance between vectors.
+
+### load collection
+
+When you create a collection in Milvus, the collection data is initially stored on disk, and it is not immediately available for search and retrieval. In order to search or retrieve data from the collection, you must first load the collection into memory using the loadCollectionSync method.
+
+```javascript
 // load collection
 await client.loadCollectionSync({
   collection_name,
@@ -181,6 +226,8 @@ await client.loadCollectionSync({
 
 ### vector search
 
+Now you can perform vector search on your collection.
+
 ```javascript
 // Generate a random search vector
 const searchVector = [...Array(dim)].map(() => Math.random());
@@ -188,7 +235,7 @@ const searchVector = [...Array(dim)].map(() => Math.random());
 // Perform a vector search on the collection
 const res = await client.search({
   collection_name, // required, the collection name
-  vectors: [0.1, 0.2, 0.3, 0.4], // required, vector used to compare other vectors in milvus
+  vector: [0.1, 0.2, 0.3, 0.4], // required, vector used to compare other vectors in milvus
   filter: 'word_count > 0', // optional, filter
   params: { nprobe: 64 }, // optional, specify the search parameters
   limit: 1, // specify the number of nearest neighbors to return
@@ -197,6 +244,23 @@ const res = await client.search({
 });
 ```
 
+The code snippet performs a vector search on the collection.
+
+First, a random search vector is generated. Then, the `client.search()` method is called with several parameters:
+`collection_name`: Required. Specifies the name of the Milvus collection to search.
+
+`vectors`: Required. Specifies the vector used to compare other vectors in Milvus. The example code passes an array of floating-point numbers as the vector.
+
+`filter` or `expr`: Optional. Specifies a filter to apply to the search query. The example code passes a filter that only includes vectors where the word_count field is greater than 0.
+
+`params`: Optional. Specifies additional search parameters. The example code sets nprobe to 64, which controls the number of clusters to search during the query. By default, nothing will be set.
+
+`limit` or `topk`: Optional. Specifies the number of nearest neighbors to return. The example code sets this to 1. By default, it will be `100`
+
+`metric_type`: Optional. Specifies the metric used to calculate the similarity of two vectors. The example code sets this to `"L2"`. By default, it will be `"L2"`.
+
+`output_fields`: Optional. Specifies which fields to include in the search results. The example code specifies the `book_id` and `word_count` fields, by default the node sdk will output all fields.
+
 ## Next Steps
 
 - [What is Milvus](https://milvus.io/)

package/dist/milvus/MilvusClient.d.ts

@@ -1,6 +1,25 @@
-import { GRPCClient, ClientConfig } from '.';
 import { ChannelOptions } from '@grpc/grpc-js';
+import { GRPCClient, ClientConfig } from '.';
+/**
+ * Milvus Client class that extends GRPCClient and handles communication with Milvus server.
+ */
 export declare class MilvusClient extends GRPCClient {
+    /**
+     * Returns the SDK information.
+     * SDK information will be generated on the building phase
+     * @returns Object containing SDK version and recommended Milvus version.
+     */
+    static get sdkInfo(): {
+        version: string;
+        recommandMilvus: string;
+    };
+    /**
+     * Creates a new instance of MilvusClient.
+     * @param configOrAddress The Milvus server's address or client configuration object.
+     * @param ssl Whether to use SSL or not.
+     * @param username The username for authentication.
+     * @param password The password for authentication.
+     * @param channelOptions Additional channel options for gRPC.
+     */
     constructor(configOrAddress: ClientConfig | string, ssl?: boolean, username?: string, password?: string, channelOptions?: ChannelOptions);
-    connect(): void;
 }

package/dist/milvus/MilvusClient.js

@@ -1,35 +1,41 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MilvusClient = void 0;
-var _1 = require(".");
-var MilvusClient = /** @class */ (function (_super) {
-    __extends(MilvusClient, _super);
-    function MilvusClient(configOrAddress, ssl, username, password, channelOptions) {
-        var _this = _super.call(this, configOrAddress, ssl, username, password, channelOptions) || this;
-        // connect
-        _this.connect();
-        return _this;
+const _1 = require(".");
+const sdk_json_1 = __importDefault(require("../sdk.json"));
+/**
+ * Milvus Client class that extends GRPCClient and handles communication with Milvus server.
+ */
+class MilvusClient extends _1.GRPCClient {
+    /**
+     * Returns the SDK information.
+     * SDK information will be generated on the building phase
+     * @returns Object containing SDK version and recommended Milvus version.
+     */
+    static get sdkInfo() {
+        return {
+            version: sdk_json_1.default.version,
+            recommandMilvus: sdk_json_1.default.milvusVersion,
+        };
     }
-    // overload
-    MilvusClient.prototype.connect = function () {
-        _super.prototype.connect.call(this);
-    };
-    return MilvusClient;
-}(_1.GRPCClient));
+    /**
+     * Creates a new instance of MilvusClient.
+     * @param configOrAddress The Milvus server's address or client configuration object.
+     * @param ssl Whether to use SSL or not.
+     * @param username The username for authentication.
+     * @param password The password for authentication.
+     * @param channelOptions Additional channel options for gRPC.
+     */
+    constructor(configOrAddress, ssl, username, password, channelOptions) {
+        // setup the configuration
+        super(configOrAddress, ssl, username, password, channelOptions);
+        _1.logger.debug(`new client initialized, version: ${MilvusClient.sdkInfo.version} `);
+        // connect();
+        this.connect(MilvusClient.sdkInfo.version);
+    }
+}
 exports.MilvusClient = MilvusClient;
 //# sourceMappingURL=MilvusClient.js.map

package/dist/milvus/MilvusClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"MilvusClient.js","sourceRoot":"","sources":["../../milvus/MilvusClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,sBAA6C;AAG7C;IAAkC,gCAAU;IAC1C,sBACE,eAAsC,EACtC,GAAa,EACb,QAAiB,EACjB,QAAiB,EACjB,cAA+B;QALjC,YAOE,kBAAM,eAAe,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,CAAC,SAIhE;QAFC,UAAU;QACV,KAAI,CAAC,OAAO,EAAE,CAAC;;IACjB,CAAC;IAED,WAAW;IACX,8BAAO,GAAP;QACE,iBAAM,OAAO,WAAE,CAAC;IAClB,CAAC;IACH,mBAAC;AAAD,CAAC,AAlBD,CAAkC,aAAU,GAkB3C;AAlBY,oCAAY"}
+{"version":3,"file":"MilvusClient.js","sourceRoot":"","sources":["../../milvus/MilvusClient.ts"],"names":[],"mappings":";;;;;;AACA,wBAAqD;AACrD,2DAAkC;AAElC;;GAEG;AACH,MAAa,YAAa,SAAQ,aAAU;IAC1C;;;;OAIG;IACH,MAAM,KAAK,OAAO;QAChB,OAAO;YACL,OAAO,EAAE,kBAAO,CAAC,OAAO;YACxB,eAAe,EAAE,kBAAO,CAAC,aAAa;SACvC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,YACE,eAAsC,EACtC,GAAa,EACb,QAAiB,EACjB,QAAiB,EACjB,cAA+B;QAE/B,0BAA0B;QAC1B,KAAK,CAAC,eAAe,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;QAChE,SAAM,CAAC,KAAK,CACV,oCAAoC,YAAY,CAAC,OAAO,CAAC,OAAO,GAAG,CACpE,CAAC;QACF,aAAa;QACb,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;CACF;AApCD,oCAoCC"}

package/dist/milvus/OrmClient.d.ts

@@ -0,0 +1,19 @@
+import { ShowCollectionsReq, CreateColReq, MilvusClient } from './';
+import { Collection } from './orm';
+/**
+ * ORM client that extends Milvus client
+ */
+export declare class OrmClient extends MilvusClient {
+    /**
+     * Creates a new collection with the given name and schema, or returns an existing one with the same name.
+     * @param data An object containing the collection name, dimension, schema (optional), enable_dynamic_field (optional), and description (optional).
+     * @returns A Collection object representing the newly created or existing collection, and it is indexed and loaded
+     */
+    collection(data: CreateColReq): Promise<Collection>;
+    /**
+     * Retrieves a list of collections from the Milvus server.
+     * @param data An optional object containing parameters for filtering the list of collections.
+     * @returns An array of Collection objects representing the collections returned by the server.
+     */
+    collections(data?: ShowCollectionsReq): Promise<Collection[]>;
+}

package/dist/milvus/OrmClient.js

@@ -0,0 +1,77 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrmClient = void 0;
+const _1 = require("./");
+const orm_1 = require("./orm");
+/**
+ * ORM client that extends Milvus client
+ */
+class OrmClient extends _1.MilvusClient {
+    // ORM-like APIs
+    /**
+     * Creates a new collection with the given name and schema, or returns an existing one with the same name.
+     * @param data An object containing the collection name, dimension, schema (optional), enable_dynamic_field (optional), and description (optional).
+     * @returns A Collection object representing the newly created or existing collection, and it is indexed and loaded
+     */
+    collection(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // get params
+            const { collection_name, dimension, primary_field_name = 'id', id_type = _1.DataType.Int64, vector_field_name = 'vector', enableDynamicField = true, loadOnInit = true, } = data;
+            // check exist
+            const exist = yield this.hasCollection({ collection_name });
+            // build schema
+            const schema = (0, orm_1.buildSchema)({
+                primary_field_name,
+                id_type,
+                vector_field_name,
+                dimension,
+            });
+            // not exist, create a new one
+            if (!exist.value) {
+                // create a new collection with fixed schema
+                yield this.createCollection({
+                    collection_name,
+                    enable_dynamic_field: enableDynamicField,
+                    fields: schema,
+                });
+            }
+            // return collection object
+            const col = new orm_1.Collection({
+                name: collection_name,
+                client: this,
+            });
+            try {
+                // init
+                yield col.init(loadOnInit);
+            }
+            catch (error) {
+                console.log('creation error ', error);
+            }
+            return col;
+        });
+    }
+    /**
+     * Retrieves a list of collections from the Milvus server.
+     * @param data An optional object containing parameters for filtering the list of collections.
+     * @returns An array of Collection objects representing the collections returned by the server.
+     */
+    collections(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cols = yield this.showCollections(data);
+            return cols.data.map(col => {
+                return new orm_1.Collection({ name: col.name, client: this });
+            });
+        });
+    }
+}
+exports.OrmClient = OrmClient;
+//# sourceMappingURL=OrmClient.js.map

package/dist/milvus/OrmClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrmClient.js","sourceRoot":"","sources":["../../milvus/OrmClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yBAA8E;AAC9E,+BAAgD;AAEhD;;GAEG;AACH,MAAa,SAAU,SAAQ,eAAY;IACzC,gBAAgB;IAChB;;;;OAIG;IACG,UAAU,CAAC,IAAkB;;YACjC,aAAa;YACb,MAAM,EACJ,eAAe,EACf,SAAS,EACT,kBAAkB,GAAG,IAAI,EACzB,OAAO,GAAG,WAAQ,CAAC,KAAK,EACxB,iBAAiB,GAAG,QAAQ,EAC5B,kBAAkB,GAAG,IAAI,EACzB,UAAU,GAAG,IAAI,GAClB,GAAG,IAAI,CAAC;YAET,cAAc;YACd,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,eAAe,EAAE,CAAC,CAAC;YAE5D,eAAe;YACf,MAAM,MAAM,GAAG,IAAA,iBAAW,EAAC;gBACzB,kBAAkB;gBAClB,OAAO;gBACP,iBAAiB;gBACjB,SAAS;aACV,CAAC,CAAC;YAEH,8BAA8B;YAC9B,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;gBAChB,4CAA4C;gBAC5C,MAAM,IAAI,CAAC,gBAAgB,CAAC;oBAC1B,eAAe;oBACf,oBAAoB,EAAE,kBAAkB;oBACxC,MAAM,EAAE,MAAM;iBACf,CAAC,CAAC;aACJ;YAED,2BAA2B;YAC3B,MAAM,GAAG,GAAG,IAAI,gBAAU,CAAC;gBACzB,IAAI,EAAE,eAAe;gBACrB,MAAM,EAAE,IAAI;aACb,CAAC,CAAC;YAEH,IAAI;gBACF,OAAO;gBACP,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAC5B;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;aACvC;YAED,OAAO,GAAG,CAAC;QACb,CAAC;KAAA;IAED;;;;OAIG;IACG,WAAW,CAAC,IAAyB;;YACzC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAE9C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBACzB,OAAO,IAAI,gBAAU,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AApED,8BAoEC"}

package/dist/milvus/const/ErrorReason.d.ts

@@ -1,31 +1,36 @@
-export declare enum ERROR_REASONS {
-    MILVUS_ADDRESS_IS_REQUIRED = "The `address` property is missing.",
-    CREATE_COLLECTION_MISS_DATA_TYPE = "The `data_type` property is missing in the `field` object.",
-    CREATE_COLLECTION_CHECK_PARAMS = "The `fields` or `collection_name` property is missing.",
-    CREATE_COLLECTION_CHECK_PRIMARY_KEY = "The `data_type` for the primary key field must be DataType.Int64.",
-    CREATE_COLLECTION_CHECK_VECTOR_FIELD_EXIST = "The `data_type` of a vector field  must be either DataType.FloatVector or DataType.BinaryVector.",
-    CREATE_COLLECTION_CHECK_MISS_DIM = "The `dim` property is missing.",
-    CREATE_COLLECTION_CHECK_MISS_MAXLENGTH = "The `max_length` property is missing",
-    CREATE_COLLECTION_CHECK_BINARY_DIM = "The `dim` property of the Binary vector should be value mutiples of 8.",
-    COLLECTION_NAME_IS_REQUIRED = "The `collection_name` property is missing.",
-    COLLECTION_ID_IS_REQUIRED = "The `collectionID` property is missing.",
-    COLLECTION_PARTITION_NAME_ARE_REQUIRED = "The `collection_name` or the `partition_name` property is missing.",
-    INSERT_CHECK_FILEDS_DATA_IS_REQUIRED = "The type of the `fields_data` should be an array.",
-    INSERT_CHECK_WRONG_FIELD = "Insert fail: some field does not exist for this collection in line.",
-    INSERT_CHECK_WRONG_DIM = "Insert fail: the length of the binary vector should be (dimension / 8).",
-    INSERT_CHECK_WRONG_DATA_TYPE = "The value of the `data_type` property is not supported:",
-    DELETE_PARAMS_CHECK = "The `collection_name` or the `expr` property is missing.",
-    GET_METRIC_CHECK_PARAMS = "The `metric_type` property is missing.",
-    GET_FLUSH_STATE_CHECK_PARAMS = "The type of the `segmentIDs` property should be an array.",
-    LOAD_BALANCE_CHECK_PARAMS = "The `src_nodeID` property is missing.",
-    PARTITION_NAMES_IS_REQUIRED = "The `partition_names` property is missing.",
-    ALIAS_NAME_IS_REQUIRED = "The `alias` property is missing.",
-    COMPACTIONID_IS_REQUIRED = "The `compactionID` property is missing.",
-    USERNAME_PWD_ARE_REQUIRED = "The `username` or `password` property is missing.",
-    USERNAME_IS_REQUIRED = "The `username` property is missing.",
-    TIMESTAMP_PARAM_CHECK = "The type of the `hybridts` property should be string (only contains number) or bigint.",
-    DATE_TYPE_CHECK = "The type of the `datetime` property should be Date.",
-    IMPORT_FILE_CHECK = "The `files` property is missing.",
-    SEARCH_PARAMS_IS_NOT_MATCH = "Some of the search parameters are not match.",
-    VECTORS_OR_VECTOR_IS_MISSING = "The `vector` or `vectors` property is missing."
-}
+export declare const ERROR_REASONS: {
+    MILVUS_ADDRESS_IS_REQUIRED: string;
+    CREATE_COLLECTION_MISS_DATA_TYPE: string;
+    CREATE_COLLECTION_CHECK_PARAMS: string;
+    CREATE_COLLECTION_CHECK_PRIMARY_KEY: string;
+    CREATE_COLLECTION_CHECK_VECTOR_FIELD_EXIST: string;
+    CREATE_COLLECTION_CHECK_MISS_DIM: string;
+    CREATE_COLLECTION_CHECK_MISS_MAX_LENGTH: string;
+    CREATE_COLLECTION_CHECK_BINARY_DIM: string;
+    COLLECTION_NAME_IS_REQUIRED: string;
+    COLLECTION_ID_IS_REQUIRED: string;
+    COLLECTION_PARTITION_NAME_ARE_REQUIRED: string;
+    INSERT_CHECK_FIELD_DATA_IS_REQUIRED: string;
+    INSERT_CHECK_WRONG_FIELD: string;
+    INSERT_CHECK_WRONG_DIM: string;
+    INSERT_CHECK_WRONG_DATA_TYPE: string;
+    GET_METRIC_CHECK_PARAMS: string;
+    GET_FLUSH_STATE_CHECK_PARAMS: string;
+    LOAD_BALANCE_CHECK_PARAMS: string;
+    PARTITION_NAMES_IS_REQUIRED: string;
+    ALIAS_NAME_IS_REQUIRED: string;
+    COMPACTION_ID_IS_REQUIRED: string;
+    USERNAME_PWD_ARE_REQUIRED: string;
+    USERNAME_IS_REQUIRED: string;
+    FILTER_EXPR_REQUIRED: string;
+    TIMESTAMP_PARAM_CHECK: string;
+    DATE_TYPE_CHECK: string;
+    IMPORT_FILE_CHECK: string;
+    SEARCH_PARAMS_IS_NOT_MATCH: string;
+    VECTORS_OR_VECTOR_IS_MISSING: string;
+    FIELD_TYPE_IS_NOT_SUPPORT: string;
+    INVALID_PARTITION_NUM: string;
+    INVALID_PARTITION_KEY_FIELD_TYPE: string;
+    PARTITION_KEY_FIELD_MAXED_OUT: string;
+    IDS_REQUIRED: string;
+};

package/dist/milvus/const/ErrorReason.js

@@ -1,36 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ERROR_REASONS = void 0;
-var ERROR_REASONS;
-(function (ERROR_REASONS) {
-    ERROR_REASONS["MILVUS_ADDRESS_IS_REQUIRED"] = "The `address` property is missing.";
-    ERROR_REASONS["CREATE_COLLECTION_MISS_DATA_TYPE"] = "The `data_type` property is missing in the `field` object.";
-    ERROR_REASONS["CREATE_COLLECTION_CHECK_PARAMS"] = "The `fields` or `collection_name` property is missing.";
-    ERROR_REASONS["CREATE_COLLECTION_CHECK_PRIMARY_KEY"] = "The `data_type` for the primary key field must be DataType.Int64.";
-    ERROR_REASONS["CREATE_COLLECTION_CHECK_VECTOR_FIELD_EXIST"] = "The `data_type` of a vector field  must be either DataType.FloatVector or DataType.BinaryVector.";
-    ERROR_REASONS["CREATE_COLLECTION_CHECK_MISS_DIM"] = "The `dim` property is missing.";
-    ERROR_REASONS["CREATE_COLLECTION_CHECK_MISS_MAXLENGTH"] = "The `max_length` property is missing";
-    ERROR_REASONS["CREATE_COLLECTION_CHECK_BINARY_DIM"] = "The `dim` property of the Binary vector should be value mutiples of 8.";
-    ERROR_REASONS["COLLECTION_NAME_IS_REQUIRED"] = "The `collection_name` property is missing.";
-    ERROR_REASONS["COLLECTION_ID_IS_REQUIRED"] = "The `collectionID` property is missing.";
-    ERROR_REASONS["COLLECTION_PARTITION_NAME_ARE_REQUIRED"] = "The `collection_name` or the `partition_name` property is missing.";
-    ERROR_REASONS["INSERT_CHECK_FILEDS_DATA_IS_REQUIRED"] = "The type of the `fields_data` should be an array.";
-    ERROR_REASONS["INSERT_CHECK_WRONG_FIELD"] = "Insert fail: some field does not exist for this collection in line.";
-    ERROR_REASONS["INSERT_CHECK_WRONG_DIM"] = "Insert fail: the length of the binary vector should be (dimension / 8).";
-    ERROR_REASONS["INSERT_CHECK_WRONG_DATA_TYPE"] = "The value of the `data_type` property is not supported:";
-    ERROR_REASONS["DELETE_PARAMS_CHECK"] = "The `collection_name` or the `expr` property is missing.";
-    ERROR_REASONS["GET_METRIC_CHECK_PARAMS"] = "The `metric_type` property is missing.";
-    ERROR_REASONS["GET_FLUSH_STATE_CHECK_PARAMS"] = "The type of the `segmentIDs` property should be an array.";
-    ERROR_REASONS["LOAD_BALANCE_CHECK_PARAMS"] = "The `src_nodeID` property is missing.";
-    ERROR_REASONS["PARTITION_NAMES_IS_REQUIRED"] = "The `partition_names` property is missing.";
-    ERROR_REASONS["ALIAS_NAME_IS_REQUIRED"] = "The `alias` property is missing.";
-    ERROR_REASONS["COMPACTIONID_IS_REQUIRED"] = "The `compactionID` property is missing.";
-    ERROR_REASONS["USERNAME_PWD_ARE_REQUIRED"] = "The `username` or `password` property is missing.";
-    ERROR_REASONS["USERNAME_IS_REQUIRED"] = "The `username` property is missing.";
-    ERROR_REASONS["TIMESTAMP_PARAM_CHECK"] = "The type of the `hybridts` property should be string (only contains number) or bigint.";
-    ERROR_REASONS["DATE_TYPE_CHECK"] = "The type of the `datetime` property should be Date.";
-    ERROR_REASONS["IMPORT_FILE_CHECK"] = "The `files` property is missing.";
-    ERROR_REASONS["SEARCH_PARAMS_IS_NOT_MATCH"] = "Some of the search parameters are not match.";
-    ERROR_REASONS["VECTORS_OR_VECTOR_IS_MISSING"] = "The `vector` or `vectors` property is missing.";
-})(ERROR_REASONS = exports.ERROR_REASONS || (exports.ERROR_REASONS = {}));
+const _1 = require("./");
+exports.ERROR_REASONS = {
+    MILVUS_ADDRESS_IS_REQUIRED: 'The `address` property is missing.',
+    CREATE_COLLECTION_MISS_DATA_TYPE: 'The `data_type` property is missing in the `field` object.',
+    CREATE_COLLECTION_CHECK_PARAMS: 'The `fields` or `collection_name` property is missing.',
+    CREATE_COLLECTION_CHECK_PRIMARY_KEY: 'The `data_type` for the primary key field must be DataType.Int64.',
+    CREATE_COLLECTION_CHECK_VECTOR_FIELD_EXIST: 'The `data_type` of a vector field  must be either DataType.FloatVector or DataType.BinaryVector.',
+    CREATE_COLLECTION_CHECK_MISS_DIM: 'The `dim` property is missing.',
+    CREATE_COLLECTION_CHECK_MISS_MAX_LENGTH: 'The `max_length` property is missing',
+    CREATE_COLLECTION_CHECK_BINARY_DIM: 'The `dim` property of the Binary vector should be value multiples of 8.',
+    COLLECTION_NAME_IS_REQUIRED: 'The `collection_name` property is missing.',
+    COLLECTION_ID_IS_REQUIRED: 'The `collectionID` property is missing.',
+    COLLECTION_PARTITION_NAME_ARE_REQUIRED: 'The `collection_name` or the `partition_name` property is missing.',
+    INSERT_CHECK_FIELD_DATA_IS_REQUIRED: 'The type of the `fields_data` should be an array.',
+    INSERT_CHECK_WRONG_FIELD: 'Insert fail: some field does not exist for this collection in line.',
+    INSERT_CHECK_WRONG_DIM: 'Insert fail: the length of the binary vector should be (dimension / 8).',
+    INSERT_CHECK_WRONG_DATA_TYPE: 'The value of the `data_type` property is not supported:',
+    GET_METRIC_CHECK_PARAMS: 'The `metric_type` property is missing.',
+    GET_FLUSH_STATE_CHECK_PARAMS: 'The type of the `segmentIDs` property should be an array.',
+    LOAD_BALANCE_CHECK_PARAMS: 'The `src_nodeID` property is missing.',
+    PARTITION_NAMES_IS_REQUIRED: 'The `partition_names` property is missing.',
+    ALIAS_NAME_IS_REQUIRED: 'The `alias` property is missing.',
+    COMPACTION_ID_IS_REQUIRED: 'The `compactionID` property is missing.',
+    USERNAME_PWD_ARE_REQUIRED: 'The `username` or `password` property is missing.',
+    USERNAME_IS_REQUIRED: 'The `username` property is missing.',
+    FILTER_EXPR_REQUIRED: 'The `filter` or the `expr` property is missing.',
+    TIMESTAMP_PARAM_CHECK: 'The type of the `hybridts` property should be string (only contains number) or bigint.',
+    DATE_TYPE_CHECK: 'The type of the `datetime` property should be Date.',
+    IMPORT_FILE_CHECK: 'The `files` property is missing.',
+    SEARCH_PARAMS_IS_NOT_MATCH: 'Some of the search parameters are not match.',
+    VECTORS_OR_VECTOR_IS_MISSING: 'The `vector` or `vectors` property is missing.',
+    FIELD_TYPE_IS_NOT_SUPPORT: `The data_type is not supported, please use one of ${Object.keys(_1.DataTypeMap)
+        .filter((d) => d !== 'None' && d !== 'String')
+        .join(', ')}.`,
+    INVALID_PARTITION_NUM: `The partition numbers should between 1 and ${_1.MAX_PARTITIONS_NUMBER}`,
+    INVALID_PARTITION_KEY_FIELD_TYPE: 'Only non-primary key Int64 or VarChar field support partition key.',
+    PARTITION_KEY_FIELD_MAXED_OUT: `Only ${_1.MAX_PARTITION_KEY_FIELD_COUNT} field supports partition key. `,
+    IDS_REQUIRED: 'The `ids` is missing or empty.',
+};
 //# sourceMappingURL=ErrorReason.js.map

package/dist/milvus/const/ErrorReason.js.map

@@ -1 +1 @@
-{"version":3,"file":"ErrorReason.js","sourceRoot":"","sources":["../../../milvus/const/ErrorReason.ts"],"names":[],"mappings":";;;AAAA,IAAY,aAiCX;AAjCD,WAAY,aAAa;IACvB,kFAAiE,CAAA;IAEjE,gHAA+F,CAAA;IAC/F,0GAAyF,CAAA;IACzF,0HAAyG,CAAA;IACzG,gKAA+I,CAAA;IAC/I,oFAAmE,CAAA;IACnE,gGAA+E,CAAA;IAC/E,8HAA6G,CAAA;IAC7G,2FAA0E,CAAA;IAC1E,sFAAqE,CAAA;IACrE,8HAA6G,CAAA;IAE7G,2GAA0F,CAAA;IAC1F,iHAAgG,CAAA;IAChG,mHAAkG,CAAA;IAClG,yGAAwF,CAAA;IAExF,iGAAgF,CAAA;IAChF,mFAAkE,CAAA;IAClE,2GAA0F,CAAA;IAC1F,oFAAmE,CAAA;IACnE,2FAA0E,CAAA;IAC1E,4EAA2D,CAAA;IAC3D,qFAAoE,CAAA;IACpE,gGAA+E,CAAA;IAC/E,6EAA4D,CAAA;IAC5D,iIAAgH,CAAA;IAChH,wFAAuE,CAAA;IACvE,uEAAsD,CAAA;IACtD,4FAA2E,CAAA;IAC3E,gGAA+E,CAAA;AACjF,CAAC,EAjCW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAiCxB"}
+{"version":3,"file":"ErrorReason.js","sourceRoot":"","sources":["../../../milvus/const/ErrorReason.ts"],"names":[],"mappings":";;;AAAA,yBAIY;AAEC,QAAA,aAAa,GAAG;IAC3B,0BAA0B,EAAE,oCAAoC;IAChE,gCAAgC,EAC9B,4DAA4D;IAC9D,8BAA8B,EAC5B,wDAAwD;IAC1D,mCAAmC,EACjC,mEAAmE;IACrE,0CAA0C,EACxC,kGAAkG;IACpG,gCAAgC,EAAE,gCAAgC;IAClE,uCAAuC,EACrC,sCAAsC;IACxC,kCAAkC,EAChC,yEAAyE;IAC3E,2BAA2B,EAAE,4CAA4C;IACzE,yBAAyB,EAAE,yCAAyC;IACpE,sCAAsC,EACpC,oEAAoE;IACtE,mCAAmC,EACjC,mDAAmD;IACrD,wBAAwB,EACtB,qEAAqE;IACvE,sBAAsB,EACpB,yEAAyE;IAC3E,4BAA4B,EAC1B,yDAAyD;IAC3D,uBAAuB,EAAE,wCAAwC;IACjE,4BAA4B,EAC1B,2DAA2D;IAC7D,yBAAyB,EAAE,uCAAuC;IAClE,2BAA2B,EAAE,4CAA4C;IACzE,sBAAsB,EAAE,kCAAkC;IAC1D,yBAAyB,EAAE,yCAAyC;IACpE,yBAAyB,EACvB,mDAAmD;IACrD,oBAAoB,EAAE,qCAAqC;IAC3D,oBAAoB,EAAE,iDAAiD;IACvE,qBAAqB,EACnB,wFAAwF;IAC1F,eAAe,EAAE,qDAAqD;IACtE,iBAAiB,EAAE,kCAAkC;IACrD,0BAA0B,EAAE,8CAA8C;IAC1E,4BAA4B,EAC1B,gDAAgD;IAClD,yBAAyB,EAAE,qDAAqD,MAAM,CAAC,IAAI,CACzF,cAAW,CACZ;SACE,MAAM,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,KAAK,MAAM,IAAI,CAAC,KAAK,QAAQ,CAAC;SACrD,IAAI,CAAC,IAAI,CAAC,GAAG;IAEhB,qBAAqB,EAAE,8CAA8C,wBAAqB,EAAE;IAC5F,gCAAgC,EAC9B,oEAAoE;IACtE,6BAA6B,EAAE,QAAQ,gCAA6B,iCAAiC;IACrG,YAAY,EAAE,gCAAgC;CAC/C,CAAC"}

package/dist/milvus/const/Milvus.d.ts

@@ -1,10 +1,3 @@
-export declare const DEFAULT_MILVUS_PORT = 19530;
-export declare const DEFAULT_CONNECT_TIMEOUT: number;
-export declare const DEFAULT_TOPK = 100;
-export declare const DEFAULT_METRIC_TYPE = "L2";
-export declare const DEFAULT_MAX_RETRIES = 3;
-export declare const DEFAULT_RETRY_DELAY = 30;
-export declare const DEFAULT_DEBUG = false;
 export declare enum ConsistencyLevelEnum {
     Strong = 0,
     Session = 1,
@@ -189,11 +182,12 @@ export declare enum DataType {
     Double = 11,
     String = 20,
     VarChar = 21,
+    JSON = 23,
     BinaryVector = 100,
     FloatVector = 101
 }
 export declare const DataTypeMap: {
-    [x: string]: number;
+    [key in keyof typeof DataType]: number;
 };
 export declare enum OperateUserRoleType {
     AddUserToRole = 0,
@@ -272,7 +266,6 @@ export declare const Privileges: {
     Import: CollectionPrivileges.Import;
     LoadBalance: CollectionPrivileges.LoadBalance;
 };
-export declare const DEFAULT_RESOURCE_GROUP = "__default_resource_group";
 export declare enum LoadState {
     LoadStateNotExist = "LoadStateNotExist",
     LoadStateNotLoad = "LoadStateNotLoad",