@zilliz/milvus2-sdk-node 2.3.5 → 2.4.0

package/dist/milvus/utils/Bytes.js

@@ -0,0 +1,261 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildPlaceholderGroupBytes = exports.bytesToSparseRow = exports.sparseRowsToBytes = exports.sparseToBytes = exports.getSparseFloatVectorType = exports.bf16BytesToF32Array = exports.f32ArrayToBf16Bytes = exports.f16BytesToF32Array = exports.f32ArrayToF16Bytes = exports.f32ArrayToBinaryBytes = exports.f32ArrayToF32Bytes = void 0;
+const float16_1 = require("@petamoriken/float16");
+const __1 = require("..");
+/**
+ * Converts a float vector into bytes format.
+ *
+ * @param {FloatVector} array - The float vector to convert.
+ * @returns {Buffer} Bytes representing the float vector.
+ */
+const f32ArrayToF32Bytes = (array) => {
+    // create array buffer
+    const a = new Float32Array(array);
+    // need return bytes to milvus proto
+    return Buffer.from(a.buffer);
+};
+exports.f32ArrayToF32Bytes = f32ArrayToF32Bytes;
+/**
+ * Converts a binary vector into bytes format.
+ *
+ * @param {BinaryVector} array - The binary vector to convert.
+ * @returns {Buffer} Bytes representing the binary vector.
+ */
+const f32ArrayToBinaryBytes = (array) => {
+    const a = new Uint8Array(array);
+    // need return bytes to milvus proto
+    return Buffer.from(a.buffer);
+};
+exports.f32ArrayToBinaryBytes = f32ArrayToBinaryBytes;
+/**
+ * Converts a float16 vector into bytes format.
+ *
+ * @param {Float16Vector} array - The float16 vector(f32 format) to convert.
+ * @returns {Buffer} Bytes representing the float16 vector.
+ */
+const f32ArrayToF16Bytes = (array) => {
+    const float16Bytes = new float16_1.Float16Array(array);
+    return Buffer.from(float16Bytes.buffer);
+};
+exports.f32ArrayToF16Bytes = f32ArrayToF16Bytes;
+/**
+ * Convert float16 bytes to float32 array.
+ * @param {Uint8Array} f16Bytes - The float16 bytes to convert.
+ * @returns {Array} The float32 array.
+ */
+const f16BytesToF32Array = (f16Bytes) => {
+    const buffer = new ArrayBuffer(f16Bytes.length);
+    const view = new Uint8Array(buffer);
+    view.set(f16Bytes);
+    const f16Array = new float16_1.Float16Array(buffer);
+    return Array.from(f16Array);
+};
+exports.f16BytesToF32Array = f16BytesToF32Array;
+/**
+ *  Convert float32 array to BFloat16 bytes, not a real conversion, just take the last 2 bytes of float32.
+ * @param {BFloat16Vector} array - The float32 array to convert.
+ * @returns {Buffer} The BFloat16 bytes.
+ */
+const f32ArrayToBf16Bytes = (array) => {
+    const totalBytesNeeded = array.length * 2; // 2 bytes per float32
+    const buffer = new ArrayBuffer(totalBytesNeeded);
+    const bfloatView = new Uint8Array(buffer);
+    let byteIndex = 0;
+    array.forEach(float32 => {
+        const floatBuffer = new ArrayBuffer(4);
+        const floatView = new Float32Array(floatBuffer);
+        const bfloatViewSingle = new Uint8Array(floatBuffer);
+        floatView[0] = float32;
+        bfloatView.set(bfloatViewSingle.subarray(2, 4), byteIndex);
+        byteIndex += 2;
+    });
+    return Buffer.from(bfloatView);
+};
+exports.f32ArrayToBf16Bytes = f32ArrayToBf16Bytes;
+/**
+ * Convert BFloat16 bytes to Float32 array.
+ * @param {Uint8Array} bf16Bytes - The BFloat16 bytes to convert.
+ * @returns {Array} The Float32 array.
+ */
+const bf16BytesToF32Array = (bf16Bytes) => {
+    const float32Array = [];
+    const totalFloats = bf16Bytes.length / 2;
+    for (let i = 0; i < totalFloats; i++) {
+        const floatBuffer = new ArrayBuffer(4);
+        const floatView = new Float32Array(floatBuffer);
+        const bfloatView = new Uint8Array(floatBuffer);
+        bfloatView.set(bf16Bytes.subarray(i * 2, i * 2 + 2), 2);
+        float32Array.push(floatView[0]);
+    }
+    return float32Array;
+};
+exports.bf16BytesToF32Array = bf16BytesToF32Array;
+/**
+ * Get SparseVector type.
+ * @param {SparseFloatVector} vector - The sparse float vector to convert.
+ *
+ * @returns string, 'array' | 'coo' | 'csr' | 'dict'
+ */
+const getSparseFloatVectorType = (vector) => {
+    if (Array.isArray(vector)) {
+        if (vector.length === 0) {
+            return 'array';
+        }
+        if (typeof vector[0] === 'number' || typeof vector[0] === 'undefined') {
+            return 'array';
+        }
+        else if (vector.every(item => typeof item === 'object' && 'index' in item && 'value' in item)) {
+            return 'coo';
+        }
+        else {
+            return 'unknown';
+        }
+    }
+    else if (typeof vector === 'object' &&
+        'indices' in vector &&
+        'values' in vector) {
+        return 'csr';
+    }
+    else if (typeof vector === 'object' &&
+        Object.keys(vector).every(key => typeof vector[key] === 'number')) {
+        return 'dict';
+    }
+    else {
+        return 'unknown';
+    }
+};
+exports.getSparseFloatVectorType = getSparseFloatVectorType;
+/**
+ * Converts a sparse float vector into bytes format.
+ *
+ * @param {SparseFloatVector} data - The sparse float vector to convert, support 'array' | 'coo' | 'csr' | 'dict'.
+ *
+ * @returns {Uint8Array} Bytes representing the sparse float vector.
+ * @throws {Error} If the length of indices and values is not the same, or if the index is not within the valid range, or if the value is NaN.
+ */
+const sparseToBytes = (data) => {
+    // detect the format of the sparse vector
+    const type = (0, exports.getSparseFloatVectorType)(data);
+    let indices = [];
+    let values = [];
+    switch (type) {
+        case 'array':
+            for (let i = 0; i < data.length; i++) {
+                const element = data[i];
+                if (element !== undefined && !isNaN(element)) {
+                    indices.push(i);
+                    values.push(element);
+                }
+            }
+            break;
+        case 'coo':
+            indices = Object.values(data.map((item) => item.index));
+            values = Object.values(data.map((item) => item.value));
+            break;
+        case 'csr':
+            indices = data.indices;
+            values = data.values;
+            break;
+        case 'dict':
+            indices = Object.keys(data).map(Number);
+            values = Object.values(data);
+            break;
+    }
+    // create a buffer to store the bytes
+    const bytes = new Uint8Array(8 * indices.length);
+    // loop through the indices and values and add them to the buffer
+    for (let i = 0; i < indices.length; i++) {
+        const index = indices[i];
+        const value = values[i];
+        if (!(index >= 0 && index < Math.pow(2, 32) - 1)) {
+            throw new Error(`Sparse vector index must be positive and less than 2^32-1: ${index}`);
+        }
+        const indexBytes = new Uint32Array([index]);
+        const valueBytes = new Float32Array([value]);
+        bytes.set(new Uint8Array(indexBytes.buffer), i * 8);
+        bytes.set(new Uint8Array(valueBytes.buffer), i * 8 + 4);
+    }
+    return bytes;
+};
+exports.sparseToBytes = sparseToBytes;
+/**
+ * Converts an array of sparse float vectors into an array of bytes format.
+ *
+ * @param {SparseFloatVector[]} data - The array of sparse float vectors to convert.
+ *
+ * @returns {Uint8Array[]} An array of bytes representing the sparse float vectors.
+ */
+const sparseRowsToBytes = (data) => {
+    const result = [];
+    for (const row of data) {
+        result.push((0, exports.sparseToBytes)(row));
+    }
+    return result;
+};
+exports.sparseRowsToBytes = sparseRowsToBytes;
+/**
+ * Parses the provided buffer data into a sparse row representation.
+ *
+ * @param {Buffer} bufferData - The buffer data to parse.
+ *
+ * @returns {SparseFloatVector} The parsed sparse float vectors.
+ */
+const bytesToSparseRow = (bufferData) => {
+    const result = {};
+    for (let i = 0; i < bufferData.length; i += 8) {
+        const key = bufferData.readUInt32LE(i).toString();
+        const value = bufferData.readFloatLE(i + 4);
+        if (value) {
+            result[key] = value;
+        }
+    }
+    return result;
+};
+exports.bytesToSparseRow = bytesToSparseRow;
+/**
+ * This function builds a placeholder group in bytes format for Milvus.
+ *
+ * @param {Root} milvusProto - The root object of the Milvus protocol.
+ * @param {VectorTypes[]} vectors - An array of search vectors.
+ * @param {DataType} vectorDataType - The data type of the vectors.
+ *
+ * @returns {Uint8Array} The placeholder group in bytes format.
+ */
+const buildPlaceholderGroupBytes = (milvusProto, vectors, vectorDataType) => {
+    // create placeholder_group value
+    let bytes;
+    // parse vectors to bytes
+    switch (vectorDataType) {
+        case __1.DataType.FloatVector:
+            bytes = vectors.map(v => (0, exports.f32ArrayToF32Bytes)(v));
+            break;
+        case __1.DataType.BinaryVector:
+            bytes = vectors.map(v => (0, exports.f32ArrayToBinaryBytes)(v));
+            break;
+        case __1.DataType.BFloat16Vector:
+            bytes = vectors.map(v => Array.isArray(v) ? (0, exports.f32ArrayToBf16Bytes)(v) : v);
+            break;
+        case __1.DataType.Float16Vector:
+            bytes = vectors.map(v => Array.isArray(v) ? (0, exports.f32ArrayToF16Bytes)(v) : v);
+            break;
+        case __1.DataType.SparseFloatVector:
+            bytes = vectors.map(v => (0, exports.sparseToBytes)(v));
+            break;
+    }
+    // create placeholder_group
+    const PlaceholderGroup = milvusProto.lookupType('milvus.proto.common.PlaceholderGroup');
+    // tag $0 is hard code in milvus, when dsltype is expr
+    const placeholderGroupBytes = PlaceholderGroup.encode(PlaceholderGroup.create({
+        placeholders: [
+            {
+                tag: '$0',
+                type: vectorDataType,
+                values: bytes,
+            },
+        ],
+    })).finish();
+    return placeholderGroupBytes;
+};
+exports.buildPlaceholderGroupBytes = buildPlaceholderGroupBytes;
+//# sourceMappingURL=Bytes.js.map

package/dist/milvus/utils/Bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bytes.js","sourceRoot":"","sources":["../../../milvus/utils/Bytes.ts"],"names":[],"mappings":";;;AACA,kDAAoD;AACpD,0BAWY;AAEZ;;;;;GAKG;AACI,MAAM,kBAAkB,GAAG,CAAC,KAAkB,EAAE,EAAE;IACvD,sBAAsB;IACtB,MAAM,CAAC,GAAG,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;IAClC,oCAAoC;IACpC,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC;AALW,QAAA,kBAAkB,sBAK7B;AAEF;;;;;GAKG;AACI,MAAM,qBAAqB,GAAG,CAAC,KAAmB,EAAE,EAAE;IAC3D,MAAM,CAAC,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;IAChC,oCAAoC;IACpC,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC;AAJW,QAAA,qBAAqB,yBAIhC;AAEF;;;;;GAKG;AACI,MAAM,kBAAkB,GAAG,CAAC,KAAoB,EAAE,EAAE;IACzD,MAAM,YAAY,GAAG,IAAI,sBAAY,CAAC,KAAK,CAAC,CAAC;IAC7C,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC,CAAC;AAHW,QAAA,kBAAkB,sBAG7B;AAEF;;;;GAIG;AACI,MAAM,kBAAkB,GAAG,CAAC,QAAoB,EAAE,EAAE;IACzD,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEnB,MAAM,QAAQ,GAAG,IAAI,sBAAY,CAAC,MAAM,CAAC,CAAC;IAC1C,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC9B,CAAC,CAAC;AAPW,QAAA,kBAAkB,sBAO7B;AAEF;;;;GAIG;AACI,MAAM,mBAAmB,GAAG,CAAC,KAAqB,EAAE,EAAE;IAC3D,MAAM,gBAAgB,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,sBAAsB;IACjE,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,gBAAgB,CAAC,CAAC;IACjD,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAE1C,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QACtB,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;QACvC,MAAM,SAAS,GAAG,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,gBAAgB,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;QAErD,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;QACvB,UAAU,CAAC,GAAG,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAC3D,SAAS,IAAI,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AACjC,CAAC,CAAC;AAjBW,QAAA,mBAAmB,uBAiB9B;AAEF;;;;GAIG;AACI,MAAM,mBAAmB,GAAG,CAAC,SAAqB,EAAE,EAAE;IAC3D,MAAM,YAAY,GAAa,EAAE,CAAC;IAClC,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAEzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;QACpC,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;QACvC,MAAM,SAAS,GAAG,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;QAE/C,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxD,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;KACjC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAdW,QAAA,mBAAmB,uBAc9B;AAEF;;;;;GAKG;AACI,MAAM,wBAAwB,GAAG,CACtC,MAAyB,EACqB,EAAE;IAChD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACzB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YACvB,OAAO,OAAO,CAAC;SAChB;QACD,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,WAAW,EAAE;YACrE,OAAO,OAAO,CAAC;SAChB;aAAM,IACJ,MAA0B,CAAC,KAAK,CAC/B,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,IAAI,IAAI,CACvE,EACD;YACA,OAAO,KAAK,CAAC;SACd;aAAM;YACL,OAAO,SAAS,CAAC;SAClB;KACF;SAAM,IACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,SAAS,IAAI,MAAM;QACnB,QAAQ,IAAI,MAAM,EAClB;QACA,OAAO,KAAK,CAAC;KACd;SAAM,IACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,EACjE;QACA,OAAO,MAAM,CAAC;KACf;SAAM;QACL,OAAO,SAAS,CAAC;KAClB;AACH,CAAC,CAAC;AAhCW,QAAA,wBAAwB,4BAgCnC;AAEF;;;;;;;GAOG;AACI,MAAM,aAAa,GAAG,CAAC,IAAuB,EAAc,EAAE;IACnE,yCAAyC;IACzC,MAAM,IAAI,GAAG,IAAA,gCAAwB,EAAC,IAAI,CAAC,CAAC;IAE5C,IAAI,OAAO,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,GAAa,EAAE,CAAC;IAE1B,QAAQ,IAAI,EAAE;QACZ,KAAK,OAAO;YACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAI,IAA0B,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC3D,MAAM,OAAO,GAAI,IAA0B,CAAC,CAAC,CAAC,CAAC;gBAC/C,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;oBAC5C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;oBAChB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;iBACtB;aACF;YACD,MAAM;QACR,KAAK,KAAK;YACR,OAAO,GAAG,MAAM,CAAC,MAAM,CACpB,IAAwB,CAAC,GAAG,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CACzD,CAAC;YACF,MAAM,GAAG,MAAM,CAAC,MAAM,CACnB,IAAwB,CAAC,GAAG,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CACzD,CAAC;YACF,MAAM;QACR,KAAK,KAAK;YACR,OAAO,GAAI,IAAwB,CAAC,OAAO,CAAC;YAC5C,MAAM,GAAI,IAAwB,CAAC,MAAM,CAAC;YAC1C,MAAM;QACR,KAAK,MAAM;YACT,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACxC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC7B,MAAM;KACT;IAED,qCAAqC;IACrC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjD,iEAAiE;IACjE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACvC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE;YAChD,MAAM,IAAI,KAAK,CACb,8DAA8D,KAAK,EAAE,CACtE,CAAC;SACH;QAED,MAAM,UAAU,GAAG,IAAI,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7C,KAAK,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,KAAK,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;KACzD;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAtDW,QAAA,aAAa,iBAsDxB;AAEF;;;;;;GAMG;AACI,MAAM,iBAAiB,GAAG,CAAC,IAAyB,EAAgB,EAAE;IAC3E,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,MAAM,CAAC,IAAI,CAAC,IAAA,qBAAa,EAAC,GAAG,CAAC,CAAC,CAAC;KACjC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AANW,QAAA,iBAAiB,qBAM5B;AAEF;;;;;;GAMG;AACI,MAAM,gBAAgB,GAAG,CAAC,UAAkB,EAAqB,EAAE;IACxE,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;QAC7C,MAAM,GAAG,GAAW,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC1D,MAAM,KAAK,GAAW,UAAU,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,IAAI,KAAK,EAAE;YACT,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;SACrB;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAVW,QAAA,gBAAgB,oBAU3B;AAEF;;;;;;;;GAQG;AACI,MAAM,0BAA0B,GAAG,CACxC,WAAiB,EACjB,OAAsB,EACtB,cAAwB,EACxB,EAAE;IACF,iCAAiC;IACjC,IAAI,KAAK,CAAC;IACV,yBAAyB;IACzB,QAAQ,cAAc,EAAE;QACtB,KAAK,YAAQ,CAAC,WAAW;YACvB,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,0BAAkB,EAAC,CAAgB,CAAC,CAAC,CAAC;YAC/D,MAAM;QACR,KAAK,YAAQ,CAAC,YAAY;YACxB,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,6BAAqB,EAAC,CAAiB,CAAC,CAAC,CAAC;YACnE,MAAM;QACR,KAAK,YAAQ,CAAC,cAAc;YAC1B,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CACtB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,2BAAmB,EAAC,CAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAChE,CAAC;YACF,MAAM;QACR,KAAK,YAAQ,CAAC,aAAa;YACzB,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CACtB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,0BAAkB,EAAC,CAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAC9D,CAAC;YACF,MAAM;QACR,KAAK,YAAQ,CAAC,iBAAiB;YAC7B,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,qBAAa,EAAC,CAAsB,CAAC,CAAC,CAAC;YAEhE,MAAM;KACT;IACD,2BAA2B;IAC3B,MAAM,gBAAgB,GAAG,WAAW,CAAC,UAAU,CAC7C,sCAAsC,CACvC,CAAC;IACF,sDAAsD;IACtD,MAAM,qBAAqB,GAAG,gBAAgB,CAAC,MAAM,CACnD,gBAAgB,CAAC,MAAM,CAAC;QACtB,YAAY,EAAE;YACZ;gBACE,GAAG,EAAE,IAAI;gBACT,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,KAAK;aACd;SACF;KACF,CAAC,CACH,CAAC,MAAM,EAAE,CAAC;IAEX,OAAO,qBAAqB,CAAC;AAC/B,CAAC,CAAC;AAhDW,QAAA,0BAA0B,8BAgDrC"}

package/dist/milvus/utils/Format.d.ts

@@ -1,10 +1,10 @@
-import { Type } from 'protobufjs';
-import { KeyValuePair, FieldType, DataTypeMap, DataType, CreateCollectionReq, DescribeCollectionResponse, RowData, Field, FieldData } from '../';
+import { Type, Root } from 'protobufjs';
+import { KeyValuePair, FieldType, DataTypeMap, DataType, CreateCollectionReq, DescribeCollectionResponse, RowData, Field, FieldData, SearchReq, SearchSimpleReq, VectorTypes, SearchParam, HybridSearchSingleReq, HybridSearchReq, DslType, SearchRes, ConsistencyLevelEnum, RerankerObj, InsertTransformers, OutputTransformers } from '../';
 /**
- *  parse [{key:"row_count",value:4}] to {row_count:4}
- * @param data key value pair array
- * @param keys all keys in data
- * @returns {key:value}
+ * Formats key-value data based on the provided keys.
+ * @param {KeyValuePair[]} data - The array of key-value pairs.
+ * @param {string[]} keys - The keys to include in the formatted result.
+ * @returns {Object} - The formatted key-value data as an object.
  */
 export declare const formatKeyValueData: (data: KeyValuePair[], keys: string[]) => {
     [x: string]: any;
@@ -24,74 +24,32 @@ export declare const parseToKeyValue: (data?: {
  * @returns
  */
 export declare const formatNumberPrecision: (number: number, precision: number) => number;
-export declare const checkTimeParam: (ts: any) => boolean;
 /**
- * Convert a hybrid timestamp to UNIX Epoch time ignoring the logic part.
- *
- * @param data
- *  | Property          | Type  |           Description              |
- *  | :---------------- | :----  | :-------------------------------  |
- *  | hybridts          | String or BigInt |    The known hybrid timestamp to convert to UNIX Epoch time. Non-negative interger range from 0 to 18446744073709551615.       |
- *
- *
- *
- * @returns
- * | Property | Description |
- *  | :-----------| :-------------------------------  |
- *  | unixtime as string      |  The Unix Epoch time is the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT). |
+ * Checks if the given time parameter is valid.
  *
- *
- * #### Example
- *
- * ```
- *   const res = hybridtsToUnixtime("429642767925248000");
- * ```
+ * @param ts - The time parameter to be checked.
+ * @returns A boolean value indicating whether the time parameter is valid or not.
+ */
+export declare const checkTimeParam: (ts: any) => boolean;
+/**
+ * Converts a hybrid timestamp to Unix time.
+ * @param hybridts - The hybrid timestamp to convert.
+ * @returns The Unix time representation of the hybrid timestamp.
+ * @throws An error if the hybridts parameter fails the time parameter check.
  */
 export declare const hybridtsToUnixtime: (hybridts: bigint | string) => string;
 /**
- * Generate a hybrid timestamp based on Unix Epoch time, timedelta and incremental time internval.
- *
- * @param data
- *  | Property          | Type  |           Description              |
- *  | :---------------- | :----  | :-------------------------------  |
- *  | unixtime          | string or bigint |    The known Unix Epoch time used to generate a hybrid timestamp.  The Unix Epoch time is the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).       |
- *
- *
- *
- * @returns
- *  | Property    | Type  |           Description              |
- *  | :-----------| :---   | :-------------------------------  |
- *  | Hybrid timetamp       | String   | Hybrid timetamp is a non-negative interger range from 0 to 18446744073709551615. |
- *
- *
- * #### Example
- *
- * ```
- *   const res = unixtimeToHybridts("429642767925248000");
- * ```
+ * Converts a Unix timestamp to a hybrid timestamp.
+ * @param unixtime - The Unix timestamp to convert.
+ * @returns The hybrid timestamp as a string.
+ * @throws An error if the unixtime parameter fails the check.
  */
 export declare const unixtimeToHybridts: (unixtime: bigint | string) => string;
 /**
- * Generate a hybrid timestamp based on datetime。
- *
- * @param data
- *  | Property          | Type  |           Description              |
- *  | :---------------- | :----  | :-------------------------------  |
- *  | datetime          | Date |    The known datetime used to generate a hybrid timestamp.       |
- *
- *
- *
- * @returns
- *  | Property    | Type  |           Description              |
- *  | :-----------| :---   | :-------------------------------  |
- *  | Hybrid timetamp       | String   | Hybrid timetamp is a non-negative interger range from 0 to 18446744073709551615. |
- *
- *
- * #### Example
- *
- * ```
- *   const res = datetimeToHybrids("429642767925248000");
- * ```
+ * Converts a JavaScript Date object to a hybridts timestamp.
+ * @param datetime - The JavaScript Date object to be converted.
+ * @returns The hybridts timestamp.
+ * @throws An error if the input is not a valid Date object.
  */
 export declare const datetimeToHybrids: (datetime: Date) => string;
 /**
@@ -178,7 +136,7 @@ export declare const buildDynamicRow: (rowData: RowData, fieldMap: Map<string, F
  * If the field is a vector, split the data into chunks of the appropriate size.
  * If the field is a scalar, decode the JSON/array data if necessary.
  */
-export declare const buildFieldDataMap: (fields_data: any[]) => Map<string, RowData[]>;
+export declare const buildFieldDataMap: (fields_data: any[], transformers?: OutputTransformers) => Map<string, RowData[]>;
 /**
  * Generates an authentication string based on the provided credentials.
  *
@@ -200,4 +158,104 @@ export declare const getAuthString: (data: {
  * @param {Field} column - The column information.
  * @returns {FieldData} The field data for the row and column.
  */
-export declare const buildFieldData: (rowData: RowData, field: Field) => FieldData;
+export declare const buildFieldData: (rowData: RowData, field: Field, transformers?: InsertTransformers) => FieldData;
+/**
+ * Builds search parameters based on the provided data.
+ * @param data - The data object containing search parameters.
+ * @returns The search parameters in key-value format.
+ */
+export declare const buildSearchParams: (data: SearchSimpleReq | (HybridSearchSingleReq & HybridSearchReq), anns_field: string) => SearchParam;
+/**
+ * Creates a RRFRanker object with the specified value of k.
+ * @param k - The value of k used in the RRFRanker strategy.
+ * @returns An object representing the RRFRanker strategy with the specified value of k.
+ */
+export declare const RRFRanker: (k?: number) => RerankerObj;
+/**
+ * Creates a weighted ranker object.
+ * @param weights - An array of numbers representing the weights.
+ * @returns The weighted ranker object.
+ */
+export declare const WeightedRanker: (weights: number[]) => RerankerObj;
+/**
+ * Converts the rerank parameters object to a format suitable for API requests.
+ * @param rerank - The rerank parameters object.
+ * @returns The converted rerank parameters object.
+ */
+export declare const convertRerankParams: (rerank: RerankerObj) => any;
+/**
+ * This method is used to build search request for a given data.
+ * It first fetches the collection info and then constructs the search request based on the data type.
+ * It also creates search vectors and a placeholder group for the search.
+ *
+ * @param {SearchReq | SearchSimpleReq | HybridSearchReq} data - The data for which to build the search request.
+ * @param {DescribeCollectionResponse} collectionInfo - The collection information.
+ * @param {Root} milvusProto - The milvus protocol object.
+ * @returns {Object} An object containing the search requests and search vectors.
+ * @returns {Object} return.params - The search requests used in the operation.
+ * @returns {string} return.params.collection_name - The name of the collection.
+ * @returns {string[]} return.params.partition_names - The partition names.
+ * @returns {string[]} return.params.output_fields - The output fields.
+ * @returns {number} return.params.nq - The number of query vectors.
+ * @returns {string} return.params.dsl - The domain specific language.
+ * @returns {string} return.params.dsl_type - The type of the domain specific language.
+ * @returns {Uint8Array} return.params.placeholder_group - The placeholder group.
+ * @returns {Object} return.params.search_params - The search parameters.
+ * @returns {string} return.params.consistency_level - The consistency level.
+ * @returns {Number[][]} return.searchVectors - The search vectors used in the operation.
+ * @returns {number} return.round_decimal - The score precision.
+ */
+export declare const buildSearchRequest: (data: SearchReq | SearchSimpleReq | HybridSearchReq, collectionInfo: DescribeCollectionResponse, milvusProto: Root) => {
+    isHybridSearch: boolean;
+    request: {
+        collection_name: string;
+        partition_names: string[];
+        output_fields: string[];
+        nq: number;
+        dsl: string;
+        dsl_type: DslType;
+        placeholder_group: Uint8Array;
+        search_params: KeyValuePair[];
+        consistency_level: ConsistencyLevelEnum;
+    } | {
+        collection_name: string;
+        partition_names: string[] | undefined;
+        requests: {
+            collection_name: string;
+            partition_names: string[];
+            output_fields: string[];
+            nq: number;
+            dsl: string;
+            dsl_type: DslType;
+            placeholder_group: Uint8Array;
+            search_params: KeyValuePair[];
+            consistency_level: ConsistencyLevelEnum;
+        }[];
+        rank_params: KeyValuePair[];
+        output_fields: string[];
+        consistency_level: ConsistencyLevelEnum;
+    };
+    nq: number;
+    round_decimal: number;
+};
+/**
+ * Formats the search results returned by Milvus into row data for easier use.
+ *
+ * @param {SearchRes} searchRes - The search results returned by Milvus.
+ * @param {Object} options - The options for formatting the search results.
+ * @param {number} options.round_decimal - The number of decimal places to which to round the scores.
+ *
+ * @returns {any[]} The formatted search results.
+ *
+ */
+export declare const formatSearchResult: (searchRes: SearchRes, options: {
+    round_decimal: number;
+    transformers?: OutputTransformers;
+}) => any[];
+/**
+ * Formats the search vector to match a specific data type.
+ * @param {VectorTypes | VectorTypes[]} searchVector - The search vector or array of vectors to be formatted.
+ * @param {DataType} dataType - The specified data type.
+ * @returns {VectorTypes[]} The formatted search vector or array of vectors.
+ */
+export declare const formatSearchVector: (searchVector: VectorTypes | VectorTypes[], dataType: DataType) => VectorTypes[];