@zilliz/milvus2-sdk-node 2.5.0 → 2.5.2

package/dist/milvus/types/Collection.d.ts

@@ -1,24 +1,5 @@
 import { ResStatus, KeyValuePair, GrpcTimeOut, TimeStamp, TimeStampArray, resStatusResponse, collectionNameReq } from './Common';
 import { CompactionState, DataType, LoadState, DataTypeMap, ShowCollectionsType, FunctionType } from '../';
-export interface FieldSchema {
-    type_params: KeyValuePair[];
-    index_params: KeyValuePair[];
-    fieldID: string | number;
-    name: string;
-    is_primary_key: boolean;
-    description: string;
-    data_type: keyof typeof DataType;
-    autoID: boolean;
-    state: string;
-    element_type?: keyof typeof DataType;
-    default_value?: number | string;
-    dataType: DataType;
-    is_partition_key?: boolean;
-    is_dynamic?: boolean;
-    is_clustering_key?: boolean;
-    nullable?: boolean;
-    is_function_output: boolean;
-}
 export interface CollectionData {
     name: string;
     id: string;
@@ -38,9 +19,28 @@ export interface ReplicaInfo {
     shard_replicas: ShardReplica[];
     node_ids: string[];
 }
-export type TypeParam = string | number | Record<string, any>;
-export type TypeParamKey = 'dim' | 'max_length' | 'max_capacity';
-export interface FieldType {
+export type TypeParam = string | number | boolean | Record<string, any>;
+export type TypeParamKey = 'dim' | 'max_length' | 'max_capacity' | 'analyzer_params' | 'enable_analyzer' | 'enable_match';
+export type FieldSchema = {
+    type_params: KeyValuePair<TypeParamKey, TypeParam>[];
+    index_params: KeyValuePair[];
+    fieldID: string | number;
+    name: string;
+    is_primary_key: boolean;
+    description: string;
+    data_type: keyof typeof DataType;
+    autoID: boolean;
+    state: string;
+    element_type?: keyof typeof DataType;
+    default_value?: number | string;
+    dataType: DataType;
+    is_partition_key?: boolean;
+    is_dynamic?: boolean;
+    is_clustering_key?: boolean;
+    nullable?: boolean;
+    is_function_output: boolean;
+} & Partial<Record<TypeParamKey, TypeParam>>;
+export type FieldType = {
     name: string;
     description?: string;
     data_type: DataType | keyof typeof DataTypeMap;
@@ -49,26 +49,18 @@ export interface FieldType {
     is_partition_key?: boolean;
     is_function_output?: boolean;
     is_clustering_key?: boolean;
-    type_params?: {
-        [key: string]: TypeParam;
-    };
+    type_params?: Partial<Record<TypeParamKey, TypeParam>>;
     autoID?: boolean;
-    dim?: TypeParam;
-    max_capacity?: TypeParam;
-    max_length?: TypeParam;
     default_value?: number | string;
     nullable?: boolean;
-    enable_match?: boolean;
-    tokenizer_params?: Record<string, any>;
-    enable_analyzer?: boolean;
-}
+} & Partial<Record<TypeParamKey, TypeParam>>;
 export interface ShowCollectionsReq extends GrpcTimeOut {
     type?: ShowCollectionsType;
     collection_names?: string[];
     db_name?: string;
 }
 export type Properties = Record<string, string | number | boolean>;
-export type Function = {
+export type FunctionObject = {
     name: string;
     description?: string;
     type: FunctionType;
@@ -88,7 +80,7 @@ export interface BaseCreateCollectionReq extends GrpcTimeOut {
     enableDynamicField?: boolean;
     properties?: Properties;
     db_name?: string;
-    functions?: Function[];
+    functions?: FunctionObject[];
 }
 export interface CreateCollectionWithFieldsReq extends BaseCreateCollectionReq {
     fields: FieldType[];
@@ -157,7 +149,7 @@ export interface CollectionSchema {
     enable_dynamic_field: boolean;
     autoID: boolean;
     fields: FieldSchema[];
-    functions: Function[];
+    functions: FunctionObject[];
 }
 export interface DescribeCollectionResponse extends TimeStamp {
     status: ResStatus;
@@ -175,7 +167,7 @@ export interface DescribeCollectionResponse extends TimeStamp {
     shards_num: number;
     num_partitions?: string;
     db_name: string;
-    functions: Function[];
+    functions: FunctionObject[];
 }
 export interface GetCompactionPlansResponse extends resStatusResponse {
     state: CompactionState;
@@ -216,6 +208,10 @@ export interface GetLoadStateResponse extends resStatusResponse {
 }
 export interface AlterCollectionReq extends collectionNameReq {
     properties: Properties;
+    delete_keys?: string[];
+}
+export interface DropCollectionPropertiesReq extends collectionNameReq {
+    properties: string[];
 }
 export interface DescribeAliasResponse extends resStatusResponse {
     db_name: string;

package/dist/milvus/types/Common.d.ts

@@ -4,9 +4,9 @@ export interface MsgBase {
         msg_type: MsgType;
     };
 }
-export interface KeyValuePair {
-    key: string;
-    value: string | number;
+export interface KeyValuePair<T = string, U = string | number> {
+    key: T;
+    value: U;
 }
 interface NumberArray {
     data: Number[];
@@ -40,7 +40,7 @@ export interface TimeStampArray {
     created_timestamps: string[];
     created_utc_timestamps: string[];
 }
-export type keyValueObj = Record<string, string | number | string[] | number[] | boolean>;
+export type keyValueObj = Record<string, string | number | string[] | number[] | boolean | unknown>;
 export interface collectionNameReq extends GrpcTimeOut {
     collection_name: string;
     db_name?: string;

package/dist/milvus/types/Data.d.ts

@@ -30,7 +30,7 @@ export type JSON = {
     [key: string]: any;
 };
 export type Array = Int8[] | Int16[] | Int32[] | Int64[] | Float[] | Double[] | VarChar[];
-export type FieldData = Bool | Int8 | Int16 | Int32 | Int64 | Float | Double | VarChar | JSON | Array | VectorTypes | null;
+export type FieldData = Bool | Int8 | Int16 | Int32 | Int64 | Float | Double | VarChar | JSON | Array | VectorTypes | null | undefined;
 export interface RowData {
     [x: string]: FieldData;
 }
@@ -54,21 +54,32 @@ export type InsertTransformers = {
     [DataType.BFloat16Vector]?: (bf16: BFloat16Vector) => Buffer;
     [DataType.Float16Vector]?: (f16: Float16Vector) => Buffer;
 };
-export interface InsertReq extends collectionNameReq {
+interface BaseInsertReq extends collectionNameReq {
     partition_name?: string;
-    data?: RowData[];
-    fields_data?: RowData[];
-    hash_keys?: Number[];
+    hash_keys?: number[];
     transformers?: InsertTransformers;
 }
+interface DataInsertReq extends BaseInsertReq {
+    data: RowData[];
+    fields_data?: never;
+}
+interface FieldsDataInsertReq extends BaseInsertReq {
+    fields_data: RowData[];
+    data?: never;
+}
+export type InsertReq = DataInsertReq | FieldsDataInsertReq;
 interface BaseDeleteReq extends collectionNameReq {
     partition_name?: string;
     consistency_level?: 'Strong' | 'Session' | 'Bounded' | 'Eventually' | 'Customized';
+    exprValues?: keyValueObj;
 }
-export interface DeleteEntitiesReq extends BaseDeleteReq {
-    filter?: string;
+export type DeleteEntitiesReq = BaseDeleteReq & ({
     expr?: string;
-}
+    filter?: never;
+} | {
+    filter?: string;
+    expr?: never;
+});
 export interface DeleteByIdsReq extends BaseDeleteReq {
     ids: string[] | number[];
 }
@@ -168,6 +179,7 @@ export interface SearchResultData {
 }
 export interface SearchResults extends resStatusResponse {
     results: SearchResultData[];
+    recalls: number[];
 }
 export interface ImportResponse extends resStatusResponse {
     tasks: number[];
@@ -201,11 +213,13 @@ export interface SearchParam {
     group_by_field?: string;
     group_size?: number;
     strict_group_size?: boolean;
+    hints?: string;
 }
 export interface SearchReq extends collectionNameReq {
     anns_field?: string;
     partition_names?: string[];
     expr?: string;
+    exprValues?: keyValueObj;
     search_params: SearchParam;
     vectors: VectorTypes[];
     output_fields?: string[];
@@ -236,6 +250,7 @@ export interface SearchSimpleReq extends collectionNameReq {
     offset?: number;
     filter?: string;
     expr?: string;
+    exprValues?: keyValueObj;
     params?: keyValueObj;
     metric_type?: string;
     consistency_level?: ConsistencyLevelEnum;
@@ -243,12 +258,14 @@ export interface SearchSimpleReq extends collectionNameReq {
     group_by_field?: string;
     group_size?: number;
     strict_group_size?: boolean;
+    hints?: string;
     round_decimal?: number;
     transformers?: OutputTransformers;
 }
 export type HybridSearchSingleReq = Pick<SearchParam, 'anns_field' | 'ignore_growing' | 'group_by_field'> & {
     data: SearchDataType;
     expr?: string;
+    exprValues?: keyValueObj;
     params?: keyValueObj;
     transformers?: OutputTransformers;
 };
@@ -256,7 +273,7 @@ export type RerankerObj = {
     strategy: RANKER_TYPE | string;
     params: keyValueObj;
 };
-export type HybridSearchReq = Omit<SearchSimpleReq, 'data' | 'vector' | 'vectors' | 'params' | 'anns_field'> & {
+export type HybridSearchReq = Omit<SearchSimpleReq, 'data' | 'vector' | 'vectors' | 'params' | 'anns_field' | 'expr' | 'exprValues'> & {
     data: HybridSearchSingleReq[];
     rerank?: RerankerObj;
 };
@@ -295,6 +312,7 @@ export interface SearchRes extends resStatusResponse {
         topks: number[];
         output_fields: string[];
         group_by_field_value: string;
+        recalls: number[];
     };
 }
 export type OutputTransformers = {
@@ -302,7 +320,7 @@ export type OutputTransformers = {
     [DataType.Float16Vector]?: (f16: Uint8Array) => Float16Vector;
     [DataType.SparseFloatVector]?: (sparse: SparseVectorDic) => SparseFloatVector;
 };
-export interface QueryReq extends collectionNameReq {
+type BaseQueryReq = collectionNameReq & {
     output_fields?: string[];
     partition_names?: string[];
     ids?: string[] | number[];
@@ -312,7 +330,15 @@ export interface QueryReq extends collectionNameReq {
     limit?: number;
     consistency_level?: ConsistencyLevelEnum;
     transformers?: OutputTransformers;
-}
+    exprValues?: keyValueObj;
+};
+export type QueryReq = BaseQueryReq & ({
+    expr?: string;
+    filter?: never;
+} | {
+    filter?: string;
+    expr?: never;
+});
 export interface QueryIteratorReq extends Omit<QueryReq, 'ids' | 'offset' | 'limit'> {
     limit?: number;
     batchSize: number;

package/dist/milvus/types/Data.js.map

@@ -1 +1 @@
-{"version":3,"file":"Data.js","sourceRoot":"","sources":["../../../milvus/types/Data.ts"],"names":[],"mappings":";;AAAA,2BAca"}
+{"version":3,"file":"Data.js","sourceRoot":"","sources":["../../../milvus/types/Data.ts"],"names":[],"mappings":";;AACA,2BAca"}

package/dist/milvus/types/Database.d.ts

@@ -25,6 +25,11 @@ export interface AlterDatabaseRequest extends GrpcTimeOut {
     db_name: string;
     db_id?: string;
     properties: Properties;
+    delete_keys?: string[];
+}
+export interface DropDatabasePropertiesRequest extends GrpcTimeOut {
+    db_name: string;
+    properties: string[];
 }
 export interface AlterDatabaseResponse extends resStatusResponse {
 }

package/dist/milvus/types/MilvusIndex.d.ts

@@ -62,3 +62,7 @@ export interface AlterIndexReq extends collectionNameReq {
     index_name: string;
     params: Record<string, number | string | boolean>;
 }
+export interface DropIndexPropertiesReq extends collectionNameReq {
+    index_name: string;
+    properties: string[];
+}

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

@@ -1,5 +1,5 @@
 import { Type, Root } from 'protobufjs';
-import { KeyValuePair, FieldType, DataTypeMap, DataType, CreateCollectionReq, DescribeCollectionResponse, RowData, _Field, FieldData, SearchReq, SearchSimpleReq, SearchParam, HybridSearchSingleReq, HybridSearchReq, DslType, SearchRes, ConsistencyLevelEnum, RerankerObj, InsertTransformers, OutputTransformers, SearchDataType, FieldSchema, SearchMultipleDataType } from '../';
+import { KeyValuePair, FieldType, DataTypeMap, DataType, CreateCollectionReq, DescribeCollectionResponse, RowData, _Field, FieldData, SearchReq, SearchSimpleReq, SearchParam, HybridSearchSingleReq, HybridSearchReq, DslType, SearchRes, ConsistencyLevelEnum, RerankerObj, InsertTransformers, OutputTransformers, SearchDataType, FieldSchema, SearchMultipleDataType, TypeParamKey, keyValueObj } from '../';
 /**
  * Formats key-value data based on the provided keys.
  * @param {KeyValuePair[]} data - The array of key-value pairs.
@@ -72,7 +72,7 @@ export declare const formatAddress: (address: string) => string;
  * @param typeParamKeys - Keys to assign to `type_params` if present in `field`.
  * @returns The modified `FieldType` object.
  */
-export declare const assignTypeParams: (field: FieldType, typeParamKeys?: string[]) => FieldType;
+export declare const assignTypeParams: (field: FieldType, typeParamKeys?: TypeParamKey[]) => FieldType;
 /**
  * Parses a time token and returns the corresponding number of milliseconds.
  *
@@ -183,6 +183,20 @@ export declare const WeightedRanker: (weights: number[]) => RerankerObj;
  * @returns The converted rerank parameters object.
  */
 export declare const convertRerankParams: (rerank: RerankerObj) => any;
+type FormatedSearchRequest = {
+    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;
+    expr?: string;
+    expr_template_values?: keyValueObj;
+    rank_params?: KeyValuePair[];
+};
 /**
  * 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.
@@ -207,36 +221,10 @@ export declare const convertRerankParams: (rerank: RerankerObj) => any;
  */
 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;
+    request: FormatedSearchRequest;
+    nq: number | undefined;
     round_decimal: number;
+    expr_template_values: Record<string, TemplateValue> | undefined;
 };
 /**
  * Formats the search results returned by Milvus into row data for easier use.
@@ -259,3 +247,41 @@ export declare const formatSearchResult: (searchRes: SearchRes, options: {
  * @returns {VectorTypes[]} The formatted search vector or array of vectors.
  */
 export declare const formatSearchData: (searchData: SearchDataType | SearchMultipleDataType, field: FieldSchema) => SearchMultipleDataType;
+type TemplateValue = {
+    bool_val: boolean;
+} | {
+    int64_val: number;
+} | {
+    float_val: number;
+} | {
+    string_val: string;
+} | {
+    array_val: TemplateArrayValue;
+};
+type TemplateArrayValue = {
+    bool_data: {
+        data: boolean[];
+    };
+} | {
+    long_data: {
+        data: number[];
+    };
+} | {
+    double_data: {
+        data: number[];
+    };
+} | {
+    string_data: {
+        data: string[];
+    };
+} | {
+    json_data: {
+        data: any[];
+    };
+} | {
+    array_data: {
+        data: TemplateArrayValue[];
+    };
+};
+export declare const formatExprValues: (exprValues: Record<string, any>) => Record<string, TemplateValue>;
+export {};

package/dist/milvus/utils/Format.js

@@ -11,7 +11,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatSearchData = exports.formatSearchResult = exports.buildSearchRequest = exports.convertRerankParams = exports.WeightedRanker = exports.RRFRanker = exports.buildSearchParams = exports.buildFieldData = exports.getAuthString = exports.buildFieldDataMap = exports.buildDynamicRow = exports.formatDescribedCol = exports.formatCollectionSchema = exports.cloneObj = exports.convertToDataType = exports.extractMethodName = exports.parseTimeToken = exports.assignTypeParams = exports.formatAddress = exports.stringToBase64 = exports.datetimeToHybrids = exports.unixtimeToHybridts = exports.hybridtsToUnixtime = exports.checkTimeParam = exports.formatNumberPrecision = exports.parseToKeyValue = exports.formatKeyValueData = void 0;
+exports.formatExprValues = exports.formatSearchData = exports.formatSearchResult = exports.buildSearchRequest = exports.convertRerankParams = exports.WeightedRanker = exports.RRFRanker = exports.buildSearchParams = exports.buildFieldData = exports.getAuthString = exports.buildFieldDataMap = exports.buildDynamicRow = exports.formatDescribedCol = exports.formatCollectionSchema = exports.cloneObj = exports.convertToDataType = exports.extractMethodName = exports.parseTimeToken = exports.assignTypeParams = exports.formatAddress = exports.stringToBase64 = exports.datetimeToHybrids = exports.unixtimeToHybridts = exports.hybridtsToUnixtime = exports.checkTimeParam = exports.formatNumberPrecision = exports.parseToKeyValue = exports.formatKeyValueData = void 0;
 const __1 = require("../");
 /**
  * Formats key-value data based on the provided keys.
@@ -304,6 +304,17 @@ const formatDescribedCol = (data) => {
     // add a dataType property which indicate datatype number
     (_b = (_a = newData.schema) === null || _a === void 0 ? void 0 : _a.fields) === null || _b === void 0 ? void 0 : _b.forEach(f => {
         f.dataType = __1.DataTypeMap[f.data_type];
+        // if default_value is set, parse it to the correct format
+        if (f.default_value) {
+            const defaultValue = f.default_value;
+            f.default_value = defaultValue[defaultValue.data];
+        }
+        // extract type params(key value pair = {key: 'xxx', value: any}), and assign it to the field object(key)
+        if (f.type_params && f.type_params.length > 0) {
+            f.type_params.forEach(keyValuePair => {
+                f[keyValuePair.key] = keyValuePair.value;
+            });
+        }
     });
     return newData;
 };
@@ -490,9 +501,11 @@ const buildFieldData = (rowData, field, transformers) => {
                 : Buffer.alloc(0);
         case __1.DataType.Array:
             const elementField = Object.assign(Object.assign({}, field), { type: elementType });
-            return (0, exports.buildFieldData)(rowData, elementField, transformers);
+            return rowData[name] === null
+                ? undefined
+                : (0, exports.buildFieldData)(rowData, elementField, transformers);
         default:
-            return rowData[name];
+            return rowData[name] === null ? undefined : rowData[name];
     }
 };
 exports.buildFieldData = buildFieldData;
@@ -522,6 +535,9 @@ const buildSearchParams = (data, anns_field) => {
     if (data.group_size) {
         search_params.group_size = data.group_size;
     }
+    if (data.hints) {
+        search_params.hints = data.hints;
+    }
     return search_params;
 };
 exports.buildSearchParams = buildSearchParams;
@@ -637,17 +653,22 @@ const buildSearchRequest = (data, collectionInfo, milvusProto) => {
             // format searching data
             searchData = (0, exports.formatSearchData)(searchData, field);
             // create search request
-            requests.push({
+            const request = {
                 collection_name: req.collection_name,
                 partition_names: req.partition_names || [],
                 output_fields: req.output_fields || default_output_fields,
                 nq: searchReq.nq || searchData.length,
-                dsl: searchReq.expr || searchSimpleReq.filter || '',
+                dsl: req.expr || searchReq.expr || searchSimpleReq.filter || '',
                 dsl_type: __1.DslType.BoolExprV1,
                 placeholder_group: (0, __1.buildPlaceholderGroupBytes)(milvusProto, searchData, field),
                 search_params: (0, exports.parseToKeyValue)(searchReq.search_params || (0, exports.buildSearchParams)(req, name)),
                 consistency_level: req.consistency_level || collectionInfo.consistency_level,
-            });
+            };
+            // if exprValues is set, add it to the request(inner)
+            if (req.exprValues) {
+                request.expr_template_values = (0, exports.formatExprValues)(req.exprValues);
+            }
+            requests.push(request);
         }
     }
     /**
@@ -657,8 +678,12 @@ const buildSearchRequest = (data, collectionInfo, milvusProto) => {
      *  So the score need to slice by round_decimal
      */
     const round_decimal = (_d = (_b = (_a = searchReq.search_params) === null || _a === void 0 ? void 0 : _a.round_decimal) !== null && _b !== void 0 ? _b : (_c = searchSimpleReq.params) === null || _c === void 0 ? void 0 : _c.round_decimal) !== null && _d !== void 0 ? _d : -1;
+    // outter expr_template_values
+    const expr_template_values = searchSimpleReq.exprValues
+        ? (0, exports.formatExprValues)(searchSimpleReq.exprValues)
+        : undefined;
     return {
-        isHybridSearch,
+        isHybridSearch: isHybridSearch,
         request: isHybridSearch
             ? {
                 collection_name: data.collection_name,
@@ -678,6 +703,7 @@ const buildSearchRequest = (data, collectionInfo, milvusProto) => {
             : requests[0],
         nq: requests[0].nq,
         round_decimal,
+        expr_template_values,
     };
 };
 exports.buildSearchRequest = buildSearchRequest;
@@ -778,4 +804,82 @@ const formatSearchData = (searchData, field) => {
     }
 };
 exports.formatSearchData = formatSearchData;
+const formatExprValues = (exprValues) => {
+    const result = {};
+    for (const [key, value] of Object.entries(exprValues)) {
+        if (Array.isArray(value)) {
+            // Handle arrays
+            result[key] = { array_val: convertArray(value) };
+        }
+        else {
+            // Handle primitive types
+            if (typeof value === 'boolean') {
+                result[key] = { bool_val: value };
+            }
+            else if (typeof value === 'number') {
+                result[key] = Number.isInteger(value)
+                    ? { int64_val: value }
+                    : { float_val: value };
+            }
+            else if (typeof value === 'string') {
+                result[key] = { string_val: value };
+            }
+        }
+    }
+    return result;
+};
+exports.formatExprValues = formatExprValues;
+const convertArray = (arr) => {
+    const first = arr[0];
+    switch (typeof first) {
+        case 'boolean':
+            return {
+                bool_data: {
+                    data: arr,
+                },
+            };
+        case 'number':
+            if (Number.isInteger(first)) {
+                return {
+                    long_data: {
+                        data: arr,
+                    },
+                };
+            }
+            else {
+                return {
+                    double_data: {
+                        data: arr,
+                    },
+                };
+            }
+        case 'string':
+            return {
+                string_data: {
+                    data: arr,
+                },
+            };
+        case 'object':
+            if (Array.isArray(first)) {
+                return {
+                    array_data: {
+                        data: arr.map(convertArray),
+                    },
+                };
+            }
+            else {
+                return {
+                    json_data: {
+                        data: arr,
+                    },
+                };
+            }
+        default:
+            return {
+                string_data: {
+                    data: arr,
+                },
+            };
+    }
+};
 //# sourceMappingURL=Format.js.map