milvus-logo

describeIndex()

This method gets the index information in a collection.

Invocation

new milvusClient(MILUVS_ADDRESS).collectionManager.describeIndex(
  DescribeIndexReq
);

Parameters

DescribeIndexReq

ParameterDescriptionTypeRequired
collection_nameName of the collection to checkStringTrue
field_nameName of the field to checkStringFalse
index_nameName of the index to checkStringFalse
timeoutAn optional duration of time in millisecond to allow for the RPC. Default is undefinedNumberFalse

Example

new milvusClient(MILUVS_ADDRESS).indexManager.describeIndex({
  collection_name: "my_collection",
});

Return

// describeIndex return
{
  status: { error_code: 'Success', reason: '' },
  index_descriptions: [
    {
      params: [
        { key: 'index_type', value: 'IVF_FLAT' },
        { key: 'metric_type', value: 'IP' },
        { key: 'params', value: '{"nlist":10}' }
      ],
      index_name: '_default_idx',
      indexID: '434828928027721731',
      field_name: 'vector_01'
    }
  ],
}