github.com/milvus-io/milvus-sdk-go/v2@v2.4.1/docs/describe_index.md (about)

     1  # Describe Index 
     2  
     3  API to describe index on vector field of a collection.
     4  
     5  ## Parameters
     6  
     7  | Parameter    | Description                                                  | Type                     |
     8  | ------------ | ------------------------------------------------------------ | ------------------------ |
     9  | `ctx`        | Context to control API invocation process.                    | context.Context          |
    10  | `collName`   | Name of the collection to describe index on.                  | String                   |
    11  | `fieldName`  | Name of the field to describe index on.                       | String                   |
    12  
    13  ## Response
    14  
    15  - `indexes`: slice of entity.Index that specifies the indexes on the vector field.
    16  
    17  - `err`: error in the process (if any). Possible errors are listed below:
    18  
    19      - `ErrClientNotReady`, error that the client is not connected.
    20  
    21      - `ErrCollectionNotExists`, error that collection with the specified name does not exist.
    22  
    23      - error that the specified field is not valid.
    24      
    25      - error that API invocation failed.
    26  
    27  ## Example
    28  
    29  ```go
    30  ctx := context.Background()
    31  // cli is a valid Client instance
    32  indexes, err := cli.DescribeIndex(ctx, "TestCollection", "Vector")
    33  // handles the error not nil
    34  ```