createIndex()

This method creates an index on a vector field. Note that the index building process is an asynchronous.

Invocation

new milvusClient(MILUVS_ADDRESS).collectionManager.createIndex(CreateIndexReq);

Parameters

CreateIndexReq

Parameter	Description	Type	Required
collection_name	Collection name	String	True
field_name	Name of the field to create index on	String	True
index_name	Name of the index to create	String	False
extra_params	Extra index parameters (see the table below)	IndexParams	False

IndexParams

Parameter	Description	Type	Required
index_type	Index type	String	True
metric_type	Metric type	String	True
params	Index parameters	Json	True

Example

new milvusClient(MILUVS_ADDRESS).indexManager.createIndex({
  collection_name: 'my_collection',
  field_name: "vector_01",
  extra_params: {
    index_type: "IVF_FLAT",
    metric_type: "IP",
    params: JSON.stringify({ nlist: 10 }),
  },
});

Return

// createIndex return
{ error_code: 'Success', reason: '' }