milvus-logo

Index()

This is the constructor method to build an index on the specified field with the specified index parameters.

Invocation

Index(collection, field_name, index_params, **kwargs)

Parameters

ParameterDescriptionTypeRequired
collectionName of the collection.StringTrue
field_nameName of the field to build index on.StringTrue
index_paramsParameters of the index to build.DictTrue

Return

A new index object created with the specified parameters.

Properties

PropertyDescriptionType
paramsIndex parameters.Dict
collection_nameName of the collection.String
field_nameName of the indexed field.String

Example

from pymilvus import Index
index_params = {"index_type": "IVF_FLAT", "metric_type": "L2", "params": {"nlist": 1024}}
index = Index("book", "book_intro", index_params)