Package io.milvus.client

Class Index.Builder

java.lang.Object

io.milvus.client.Index.Builder

Enclosing class:

Index

public static class Index.Builder
extends Object

Builder for Index

Constructor Summary

Constructors

Constructor	Description
Builder(String collectionName, IndexType indexType)

Method Summary

Modifier and Type	Method	Description
Index	build()
Index.Builder	withParamsInJson(String paramsInJson)	Optional.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(@Nonnull
               String collectionName,
               @Nonnull
               IndexType indexType)

Parameters:

collectionName - collection to create index on

indexType - a IndexType object

Method Detail

withParamsInJson

public Index.Builder withParamsInJson(@Nonnull
                                      String paramsInJson)

Optional. Default to empty String.

 For different index type, index parameter is different accordingly, for example:

 FLAT/IVFLAT/SQ8: {"nlist": 16384}
 nlist range:[1, 999999]

 IVFPQ: {"nlist": 16384, "m": 12}
 nlist range:[1, 999999]
 m is decided by dim and have a couple of results.

 NSG: {"search_length": 45, "out_degree": 50, "candidate_pool_size": 300, "knng": 100}
 search_length range:[10, 300]
 out_degree range:[5, 300]
 candidate_pool_size range:[50, 1000]
 knng range:[5, 300]

 HNSW: {"M": 16, "efConstruction": 500}
 M range:[5, 48]
 efConstruction range:[100, 500]
 

Parameters:

paramsInJson - extra parameters in JSON format

Returns:

Builder

build

public Index build()