create_index()
This method creates an index with the specified index parameter.
Invocation
create_index(field_name, index_params, timeout=None, **kwargs)
Parameters
| Parameter | Description | Type | Required |
|---|---|---|---|
field_name | Name of the field to create index on. | String | True |
index_params | Parameters of the index to create. | Dict | True |
timeout | An optional duration of time in seconds to allow for the RPC. If it is set to None, the client keeps waiting until the server responds or error occurs. | Float | False |
Return
The newly created index object.
Raises
CollectionNotExistException: error if the collection does not exist.ParamError: error if the parameters are invalid.BaseException: error if the specified field does not exist.BaseException: error if the index has been created.
Example
index_params = {
"metric_type":"L2",
"index_type":"IVF_FLAT",
"params":{"nlist":1024}
}
from pymilvus import Collection
collection = Collection("book") # Get an existing collection.
collection.create_index(
field_name="book_intro",
index_params=index_params
)