Skip to main content

prepare_index_params()

Addedv2.3.x

This operation prepares index parameters to build indexes for a specific collection.

📘Notes

This method applies only to dedicated serving clusters and on-demand compute.

  • For this operation in a collection of a serving cluster, please create MilvusClient with the cluster endpoint.

  • Free & Serverless

https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

  • Dedicated

https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

  • For this operation in a collection for on-demand compute, create MilvusClient with the project endpoints, and then create a session to attach to an on-demand cluster for searches.

https://{project-id}.{region}.api.zillizcloud.com

Request syntax​

pymilvus.MilvusClient.prepare_index_params() -> IndexParams

PARAMETERS:

N/A

RETURN TYPE:

IndexParams

RETURNS:

An IndexParams contains a list of IndexParam objects.

  • IndexParams

    A list of IndexParam objects.

    ├── IndexParams 
    │       └── add_index()

    It offers the add_index() method to add indexes to the list.

EXCEPTIONS:

None

Examples​

from pymilvus import MilvusClient

index_params = MilvusClient.prepare_index_params()