# Types & Enums

Look up Milvus Node.js SDK data types, consistency levels, error codes, and common request and response shapes.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/

## Section links

- [Common response types](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#common-response-types)
- [ResStatus](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#resstatus)
- [ErrorCode](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#errorcode)
- [KeyValuePair](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#keyvaluepair)
- [GrpcTimeOut](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#grpctimeout)
- [DataType enum](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#datatype-enum)
- [Scalar and vector value types](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#scalar-and-vector-value-types)
- [Field and schema types](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#field-and-schema-types)
- [FieldType](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#fieldtype)
- [FunctionObject](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#functionobject)
- [Partial update enums Milvus 3.0](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#partial-update-enums-milvus-30)
- [Search and query result types](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#search-and-query-result-types)
- [SearchAggregation Milvus 3.0](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#searchaggregation-milvus-30)
- [QueryResults](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#queryresults)
- [SearchResults](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#searchresults)
- [MutationResult](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#mutationresult)
- [ConsistencyLevelEnum](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#consistencylevelenum)
- [Index enums](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#index-enums)
- [MetricType enum](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#metrictype-enum)
- [Load, compaction, and import states](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#load-compaction-and-import-states)
- [RBAC enums and privilege types](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#rbac-enums-and-privilege-types)
- [Related](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#related)
- [Membership-filter utilities (SDK 3.0.5)](https://milvus-io.github.io/milvus-sdk-node/api-reference/types-and-enums/#membership-filter-utilities-sdk-305)

This page lists common SDK types and enums used across API requests and responses.

## Common response types

### ResStatus

Most mutation and management APIs either return `ResStatus` directly or include it as `response.status`.

```typescript
interface ResStatus {
  extra_info: Record<string, any>;
  error_code: string | number;
  reason: string;
  code?: number;
  retriable: boolean;
  detail: string;
}
```

Check `error_code` against `ErrorCode.SUCCESS` before using returned data:

```typescript
const status = await client.dropCollection({ collection_name: 'books' });
if (status.error_code !== ErrorCode.SUCCESS) {
  throw new Error(status.reason);
}
```

### ErrorCode

```typescript
enum ErrorCode {
  SUCCESS = 'Success',
  IndexNotExist = 'IndexNotExist',
  UnexpectedError = 'UnexpectedError',
  EmptyCollection = 'EmptyCollection',
  UpsertAutoIDTrue = 'UpsertAutoIDTrue',
  CollectionNotExists = 'CollectionNotExists',
  IllegalArgument = 'IllegalArgument',
  RateLimit = 'RateLimit',
  SchemaMismatch = 'SchemaMismatch',
}
```

### KeyValuePair

```typescript
interface KeyValuePair<T = string, U = string | number> {
  key: T;
  value: U;
}
```

### GrpcTimeOut

Many gRPC requests extend this type.

```typescript
interface GrpcTimeOut {
  timeout?: number;
  client_request_id?: string;
  'client-request-id'?: string;
}
```

## DataType enum

```typescript
enum DataType {
  None = 0,
  Bool = 1,
  Int8 = 2,
  Int16 = 3,
  Int32 = 4,
  Int64 = 5,
  Float = 10,
  Double = 11,
  VarChar = 21,
  Array = 22,
  JSON = 23,
  Geometry = 24,
  Text = 25,
  Timestamptz = 26,
  BinaryVector = 100,
  FloatVector = 101,
  Float16Vector = 102,
  BFloat16Vector = 103,
  SparseFloatVector = 104,
  Int8Vector = 105,
  ArrayOfVector = 106,
  Struct = 201,
}
```

## Scalar and vector value types

```typescript
type Bool = boolean;
type Int8 = number;
type Int16 = number;
type Int32 = number;
type Int64 = number;
type Float = number;
type Double = number;
type VarChar = string;
type JSON = { [key: string]: any };
type Geometry = string;
type Timestamptz = string;
```

Vector aliases:

```typescript
type FloatVector = number[];
type Float16Vector = number[] | Uint8Array;
type BFloat16Vector = number[] | Uint8Array;
type BinaryVector = number[];
type Int8Vector = number[] | Int8Array;

type SparseVectorArray = (number | undefined)[];
type SparseVectorDic = { [key: string]: number };
type SparseVectorCSR = { indices: number[]; values: number[] };
type SparseVectorCOO = { index: number; value: number }[];

type SparseFloatVector =
  | SparseVectorArray
  | SparseVectorDic
  | SparseVectorCSR
  | SparseVectorCOO;
```

Row data:

```typescript
import type { Array } from '@zilliz/milvus2-sdk-node';

type FieldData =
  | Bool
  | Int8
  | Int16
  | Int32
  | Int64
  | Float
  | Double
  | VarChar
  | JSON
  | Geometry
  | Array
  | VectorTypes
  | null
  | undefined;

interface RowData {
  [fieldName: string]: FieldData;
}
```

## Field and schema types

### FieldType

Used by `createCollection`, `addCollectionField`, and `addCollectionFields`.

Milvus 3.0 `external_field` maps a Milvus field to a source field when creating external collections.

```typescript
type FieldType = {
  name: string;
  description?: string;
  data_type: DataType | keyof typeof DataTypeMap;
  element_type?: DataType | keyof typeof DataTypeMap;
  is_primary_key?: boolean;
  is_partition_key?: boolean;
  is_function_output?: boolean;
  is_clustering_key?: boolean;
  type_params?: Partial<Record<TypeParamKey, TypeParam>>;
  autoID?: boolean;
  default_value?: number | string;
  nullable?: boolean;
  external_field?: string;
  fields?: FieldType[];
} & Partial<Record<TypeParamKey, TypeParam>>;
```

Common `TypeParamKey` values include:

- `dim`
- `max_length`
- `max_capacity`
- `analyzer_params`
- `enable_analyzer`
- `enable_match`
- `mmap.enabled`

### FunctionObject

Used for BM25, text embedding, rerank, MinHash, and other function schemas.

Milvus 3.0 Collection functions can be added to or dropped from existing collections through schema alteration APIs.

```typescript
type FunctionObject = {
  name: string;
  description?: string;
  type: FunctionType;
  input_field_names: string[];
  output_field_names?: string[];
  params: Record<string, any>;
};
```

```typescript
enum FunctionType {
  Unknown = 0,
  BM25 = 1,
  TEXTEMBEDDING = 2,
  RERANK = 3,
  MINHASH = 4,
  MOLFINGERPRINT = 5,
}
```

`addFunctionField()` currently provides validated convenience wrappers for `FunctionType.BM25` and `FunctionType.MINHASH` schema evolution.

## Partial update enums Milvus 3.0

`FieldPartialUpdateOpType` is used by `upsert({ field_ops })` to control partial updates. `PATH_REPLACE` requires Milvus 3.0.6 or later.

```typescript
enum FieldPartialUpdateOpType {
  REPLACE = 0,
  ARRAY_APPEND = 1,
  ARRAY_REMOVE = 2,
  PATH_REPLACE = 3,
}
```

## Search and query result types

### SearchAggregation Milvus 3.0

```typescript
type AggregationMetricOp = 'avg' | 'sum' | 'count' | 'min' | 'max';
type AggregationDirection = 'asc' | 'desc';

interface SearchAggregation {
  fields: string[];
  size: number;
  metrics?: Record<string, { op: AggregationMetricOp; field_name: string }>;
  order?: { key: string; direction: AggregationDirection }[];
  top_hits?: {
    size: number;
    sort?: {
      field_name: string;
      direction: AggregationDirection;
    }[];
  };
  sub_aggregation?: SearchAggregation;
}

interface AggregationBucket {
  key: { field_id: string | number; field_name: string; value?: unknown }[];
  count: string | number;
  metrics: Record<string, unknown>;
  hits: Record<string, unknown>[];
  sub_groups: AggregationBucket[];
}
```

### QueryResults

```typescript
interface QueryResults {
  status: ResStatus;
  data: Record<string, any>[];
}
```

### SearchResults

Milvus 3.0 `offset` represents element-level result offsets, and `group_by_field_values` carries grouped search metadata when Milvus returns it.

```typescript
interface SearchResults<
  T extends SearchReq | SearchSimpleReq | HybridSearchReq,
> {
  status: ResStatus;
  results: SearchResultData[] | SearchResultData[][];
  recalls: number[];
  session_ts: number;
  collection_name: string;
  all_search_count?: number;
  agg_buckets?: AggregationBucket[] | AggregationBucket[][];
}

interface SearchResultData {
  [fieldName: string]: any;
  score: number;
  id: string;
  offset?: number | string;
  group_by_field_values?: Record<string, FieldData>;
  highlight?: HighlightResult;
}
```

### MutationResult

Returned by `insert`, `upsert`, and `delete`.

```typescript
interface MutationResult {
  status: ResStatus;
  succ_index: Number[];
  err_index: Number[];
  acknowledged: boolean;
  insert_cnt: string;
  delete_cnt: string;
  upsert_cnt: string;
  timestamp: string;
  IDs: StringArrayId | NumberArrayId;
}
```

## ConsistencyLevelEnum

```typescript
enum ConsistencyLevelEnum {
  Strong = 0,
  Session = 1,
  Bounded = 2,
  Eventually = 3,
  Customized = 4,
}
```

Many APIs also accept string equivalents such as `'Strong'`, `'Session'`, `'Bounded'`, and `'Eventually'`.

## Index enums

```typescript
enum IndexState {
  IndexStateNone = 0,
  Unissued = 1,
  InProgress = 2,
  Finished = 3,
  Failed = 4,
}

enum IndexType {
  FLAT = 'FLAT',
  IVF_FLAT = 'IVF_FLAT',
  IVF_SQ8 = 'IVF_SQ8',
  IVF_PQ = 'IVF_PQ',
  HNSW = 'HNSW',
  DISKANN = 'DISKANN',
  AUTOINDEX = 'AUTOINDEX',
  SPARSE_INVERTED_INDEX = 'SPARSE_INVERTED_INDEX',
  SPARSE_WAND = 'SPARSE_WAND',
  STL_SORT = 'STL_SORT',
  TRIE = 'Trie',
  INVERTED = 'INVERTED',
  BITMAP = 'BITMAP',
  MINHASH_LSH = 'MINHASH_LSH',
  RTREE = 'RTREE',
  HNSW_SQ = 'HNSW_SQ',
  HNSW_PQ = 'HNSW_PQ',
  HNSW_PRQ = 'HNSW_PRQ',
  AISAQ = 'AISAQ',
  NGRAM = 'NGRAM',
  FMINDEX = 'FMINDEX',
}
```

## MetricType enum

```typescript
enum MetricType {
  L2 = 'L2',
  IP = 'IP',
  COSINE = 'COSINE',
  HAMMING = 'HAMMING',
  JACCARD = 'JACCARD',
  TANIMOTO = 'TANIMOTO',
  SUBSTRUCTURE = 'SUBSTRUCTURE',
  SUPERSTRUCTURE = 'SUPERSTRUCTURE',
  BM25 = 'BM25',
  MHJACCARD = 'MHJACCARD',
  MAX_SIM = 'MAX_SIM',
  MAX_SIM_COSINE = 'MAX_SIM_COSINE',
  MAX_SIM_IP = 'MAX_SIM_IP',
  MAX_SIM_L2 = 'MAX_SIM_L2',
  DTW_COSINE = 'DTW_COSINE',
  DTW_IP = 'DTW_IP',
}
```

## Load, compaction, and import states

```typescript
enum LoadState {
  LoadStateNotExist = 'LoadStateNotExist',
  LoadStateNotLoad = 'LoadStateNotLoad',
  LoadStateLoading = 'LoadStateLoading',
  LoadStateLoaded = 'LoadStateLoaded',
}

enum CompactionState {
  UndefiedState = 0,
  Executing = 1,
  Completed = 2,
}

enum ImportState {
  ImportPending = 'ImportPending',
  ImportFailed = 'ImportFailed',
  ImportStarted = 'ImportStarted',
  ImportPersisted = 'ImportPersisted',
  ImportCompleted = 'ImportCompleted',
  ImportFailedAndCleaned = 'ImportFailedAndCleaned',
}
```

## RBAC enums and privilege types

```typescript
enum RbacObjects {
  Collection = 'Collection',
  Global = 'Global',
  User = 'User',
}

enum Roles {
  ADMIN = 'admin',
  PUBLIC = 'public',
}

type PrivilegesTypes =
  | CollectionPrivileges
  | UserPrivileges
  | GlobalPrivileges
  | string;
```

See [User & Role Operations](https://milvus-io.github.io/milvus-sdk-node/api-reference/users-roles/) for RBAC methods and examples.

## Related

- [API Reference overview](https://milvus-io.github.io/milvus-sdk-node/api-reference/)
- [Data Types & Schemas guide](https://milvus-io.github.io/milvus-sdk-node/core-concepts/data-types-schemas/)
- [Data Operations](https://milvus-io.github.io/milvus-sdk-node/api-reference/data/)

## Membership-filter utilities (SDK 3.0.5)

Package-root exports include `buildBloomFilter`, `BloomFilterBuilder`, `estimateBloomFilterSize`, the three `BLOOM_FILTER_*_FPR` constants, `buildRoaringBitmap`, `RoaringBitmapBuilder`, and the `RoaringBitmapMember` type. See [Membership Filters](https://milvus-io.github.io/milvus-sdk-node/advanced/membership-filters/) for signatures, binary `exprValues` examples, integer precision rules and approximate versus exact matching.
