milvus-logo
LFAI
< Docs
  • Python
    • Index

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 collectionStringTrue
field_nameName of the field to build index onStringTrue
index_paramsMilvus Connection used to create the collectionDictTrue

Return

A new index object created with the specified parameters.

Properties

PropertyDescriptionType
paramsIndex parametersDict
collection_nameName of the collectionString
field_nameName of the indexed fieldString

Example

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

Try Managed Milvus for Free

Zilliz Cloud is hassle-free, powered by Milvus and 10x faster.

Get Started
Feedback

Was this page helpful?