milvus-logo
LFAI
< Docs
  • C#

DescribeIndexAsync()

Describes an index, returning information about its configuration.

Invocation

await collection.DescribeIndexAsync(fieldName, indexName = null, cancellationToken = default);

Parameters

ParameterDescriptionTypeRequired
fieldNameThe name of the field which has the index to be described.stringTrue
indexNameAn optional name of the index to be described.string?False
cancellationTokenThe token to monitor for cancellation requests. The default value is CancellationToken.None.CancellationTokenFalse

Return

A list of MilvusIndexInfo containing information about the matching indexes.