IndexParam

This operation prepares index parameters to build indexes for a specific collection.

io.milvus.v2.common.IndexParam

Request Syntax

IndexParam.builder()
    .fieldName(String fieldName)
    .indexName(String indexName)
    .indexType(IndexParam.IndexType indexType)
    .metricType(IndexParam.MetricType metricType)
    .extraParams(Map<String, Object> extraParams)
    .build();

BUILDER METHODS:

• fieldName(String fieldName)

  The name of the target field to apply this IndexParam object applies.

• indexName(String indexName)

  The name of the index field generated after this IndexParam object has been applied.

• indexType(IndexParam.IndexType indexType)

  The name of the algorithm used to arrange data in the specific field. For applicable algorithms, refer to Index Explained and the corresponding doc page of each applicable index type.

• metricType(IndexParam.MetricType metricType)

  The algorithm that is used to measure similarity between vectors. Possible values: IP, L2, COSINE, HAMMING, JACCARD, BM25 (used only for full text search). For more information, refer to Metric Types.

  This is available only when the specified field is a vector field.

• extraParams(Map<String, Object> extraParams)

  Extra index parameters. For details, refer to In-memory Index, On-disk Index, and GPU index.

RETURN TYPE:

IndexParam

RETURNS:

An IndexParam object.

EXCEPTIONS:

• MilvusClientExceptions

  This exception will be raised when any error occurs during this operation.

Example

// define index param for field "vector"
IndexParam indexParam = IndexParam.builder()
        .metricType(IndexParam.MetricType.L2)
        .indexType(IndexParam.IndexType.AUTOINDEX)
        .fieldName("vector")
        .indexName("idx")
        .build();