createIndex()

Create an index on a vector field. Note that index building is an async progress.

Invocation

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

Parameter

CreateIndexReq

Parameter	Description	type	required
collection_name	Collection name	String	true
field_name	Filed name	string	true
extra_params	index parameters	ShowCollectionsType	IndexParams

IndexParams

Parameter	Description	type	required
index_type	index type	String	true
metric_type	metric type	string	true
params	index parameters	Json	true

ShowCollectionsType

value	Description	type	required
0	All	number	false
1	Loaded	number	false

Example

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

Return

// showCollections return