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

     1  # Get Index Building Progress 
     2  
     3  API to describe index building progress.
     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 building progress.   | String                   |
    11  | `fieldName`  | Name of the field to describe index building progress.        | String                   |
    12  
    13  
    14  ## Response
    15  
    16  - `total`: INT64 number that describes the total records count to build index on.
    17  
    18  - `index`: INT64 number that describe the indexed records count.
    19  
    20  - `err`: error in the process (if any). Possible errors are listed below:
    21  
    22      - `ErrClientNotReady`, error that the client is not connected.
    23  
    24      - `ErrCollectionNotExists`, error that collection with the specified name does not exist.
    25  
    26      - error that the specified field is not valid.
    27      
    28      - error that API invocation failed.
    29  
    30  ## Example
    31  
    32  ```go
    33  ctx := context.Background()
    34  // cli is a valid Client instance
    35  indexes, err := cli.GetIndexBuildProgress(ctx, "TestCollection", "Vector")
    36  // handles the error not nil
    37  ```