Skip to main content

CreateIndex()

This method creates an index on a specific field.

func (c *Client) CreateIndex(ctx context.Context, option CreateIndexOption, callOptions ...grpc.CallOption) (*CreateIndexTask, error)

Request Parameters​

Parameter

Description

Type

ctx

Context for the current call to work.

context.Context

option

Optional parameters of the methods.

CreateIndexOption

callOpts

Optional parameters for calling the methods.

grpc.CallOption

CreateIndexOption​

This is an interface type. The createIndexOption struct type implements this interface type.

You can use the NewCreateIndexOption() function to get the concrete implementation.

NewCreateIndexOption​

The signature of this method is as follows:

func NewCreateIndexOption(collectionName string, fieldName string, index index.Index) *createIndexOption

Parameter

Description

Type

collectionName

Name of the target collection.

string

fieldName

Name of the target field.

string

index

Type of the index.

index.Index

index.Index​

This is an interface type. The following methods implement this interface type.

Auto-indexing​

Index Type

Applicable Field Data Types

AUTOINDEX (index.NewAutoIndex)

All field types

Indexing floating vectors​

Index Type

Applicable Field Data Types

FLAT (index.NewFlatIndex)

entity.FieldTypeFloat

IVF_FLAT (index.NewIvfFlatIndex)

IVF_SQ8 (index.NewIvfSQ8Index)

IVF_PQ (index.NewIvfPQIndex)

GPU_CAGRA (index.NewGRPCagraIndex)

GPU_IVF_FLAT (index.NewGPUIVPFlatIndex)

GPU_IVF_PQ (index.NewGPUIVPPQIndex)

GPU_BRUTE_FORCE (index.NewGPUBruteForceIndex)

HNSW (index.NewHNSWIndex)

SCANN (index.NewSCANNIndex)

DISKANN (index.NewDiskANNIndex)

Indexing binary vectors​

Index Type

Applicable Field Data Types

BIN_FLAT (index.NewBinFlatIndex)

entity.FieldTypeDouble

BIN_IVF_FLAT (index.NewBinlvfFlatIndex)

Indexing sparse vectors​

Index Type

Applicable Field Data Types

SPARSE_INVERTED_INDEX (index.NewSparseInvertedIndex)

entity.FieldTypeSparseVector

SPARSE_WAND (index.NewSparseWANDIndex)

Indexing scalar fields​

Index Type

Applicable Field Data Types

BITMAP (index.NewBitmapIndex)

  • entity.FieldTypeBool

  • entity.FieldTypeInt8

  • entity.FieldTypeInt16

  • entity.FieldTypeInt32

  • entity.FieldTypeInt64

  • entity.FieldTypeVarChar

  • entity.FieldTypeArray (with element type set to one of the above)

INVERTED (index.NewInvertedIndex)

All scalar field types

STL_SORTED (index.NewSortedIndex)

  • entity.FieldTypeInt8

  • entity.FieldTypeInt16

  • entity.FieldTypeInt32

  • entity.FieldTypeInt64

  • entity.FieldTypeFloat

  • entity.FieldTypeDouble

TRIE (index.NewTrieIndex)

entity.FieldTypeVarChar

Generic index​

Index Type

Description

index.NewGenericIndex

This is a general method for you to create parameters for any applicable index type. If the index type you need to create is not listed above, use this method to create the index.

index.NewAutoIndex​

This method prepares the index parameters with the index type set to AUTOINDEX. The signature of this method is as follows:

func NewAutoIndex(metricType MetricType) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

index.NewBinFlatIndex​

This method prepares the index parameters with the index type set to BIN_FLAT. The signature of this method is as follows:

func NewBinFlatIndex(metricType MetricType) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

index.NewBinIvfFlatIndex​

This method prepares the index parameters with the index type set to BIN_IVF_FLAT. The signature of this method is as follows:

func NewBinIvfFlatIndex(metricType MetricType, nlist int) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

nlist

index.NewBitmapIndex​

This method prepares the index parameters with the index type set to BITMAP. The signature of this method is as follows:

func NewBitmapIndex() Index

index.NewDiskANNIndex​

This method prepares the index parameters with the index type set to DiskANN. The signature of this method is as follows:

func NewDiskANNIndex(metricType MetricType) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

index.NewFlatIndex​

This method prepares the index parameters with the index type set to FLAT. The signature of this method is as follows:

func NewFlatIndex(metricType MetricType) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

index.NewGPUBruteForceIndex​

This method prepares the index parameters with the index type set to GPU_BRUTE_FORCE. The signature of this method is as follows:

func NewGPUBruteForceIndex(metricType MetricType) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

index.NewGPUCagraIndex​

This method prepares the index parameters with the index type set to GPU_CAGRA. The signature of this method is as follows:

func NewGPUCagraIndex(metricType MetricType, intermediateGraphDegree, graphDegree int, ) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

intermediateGraphDegree

int

graphDegree

int

index.NewGPUIVPFlatIndex​

This method prepares the index parameters with the index type set to GPU_IVF_FLAT. The signature of this method is as follows:

func NewGPUIVPFlatIndex(metricType MetricType) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

index.NewGPUIVPPQIndex​

This method prepares the index parameters with the index type set to GPU_IVF_PQ. The signature of this method is as follows:

func NewGPUIVPPQIndex(metricType MetricType) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

index.NewGenericIndex​

This method prepares the index parameters with the index type set to generic. The signature of this method is as follows:

func NewGenericIndex(name string, params map[string]string) Index

Parameter

Description

Type

name

Name of the index type.

string

params

Parameters specific to the index type.

map[string]string

index.NewHNSWIndex​

This method prepares the index parameters with the index type set to HNSW. The signature of this method is as follows:

func NewHNSWIndex(metricType MetricType, m int, efConstruction int) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

m

int

efConstruction

int

index.NewInvertedIndex​

This method prepares the index parameters with the index type set to Inverted. The signature of this method is as follows:

func NewInvertedIndex() Index

index.NewIvfFlatIndex​

This method prepares the index parameters with the index type set to IVF_FLAT. The signature of this method is as follows:

func NewIvfFlatIndex(metricType MetricType, nlist int) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

nlist

int

index.NewIvfPQIndex​

This method prepares the index parameters with the index type set to IVF_PQ. The signature of this method is as follows:

func NewIvfPQIndex(metricType MetricType, nlist int, m int, nbits int) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

nlist

int

m

int

nbits

int

index.NewIvfSQ8Index​

This method prepares the index parameters with the index type set to IVF_SQ8. The signature of this method is as follows:

func NewIvfSQ8Index(metricType MetricType, nlist int) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

nlist

int

index.NewSCANNIndex​

This method prepares the index parameters with the index type set to SCANN. The signature of this method is as follows:

func NewSCANNIndex(metricType MetricType, nlist int, withRawData bool) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

nlist

int

withRawData

bool

index.NewSortedIndex​

This method prepares the index parameters with the index type set to Sorted. The signature of this method is as follows:

func NewSortedIndex() Index

index.NewSparseInvertedIndex​

This method prepares the index parameters with the index type set to SPARSE_INVERTED_INDEX. The signature of this method is as follows:

func NewSparseInvertedIndex(metricType MetricType, dropRatio float64) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

dropRatio

float64

index.NewSparseWANDIndex​

This method prepares the index parameters with the index type set to SPARSE_WAND. The signature of this method is as follows:

func NewSparseWANDIndex(metricType MetricType, dropRatio float64) Index

Parameter

Description

Type

metricType

Name of the metric type that is used to measure the distance between two vectors.

index.MetricType

dropRatio

float64

index.NewTrieIndex​

This method prepares the index parameters with the index type set to Trie. The signature of this method is as follows:

func NewTrieIndex() Index

index.MetricType​

This is an alias type that maps to entity.MetricType.

Return​

Null

Example​

index := index.NewHNSWIndex(entity.COSINE, 32, 128)
indexTask, err := cli.CreateIndex(ctx, milvusclient.NewCreateIndexOption("my_collection", "vector", index))
if err != nil {
    // handler err
}

err = indexTask.Await(ctx)
if err != nil {
    // handler err
}