Skip to main content

Create Index

This creates a named index for a target field, which can either be a vector field or a scalar field.

POST
/v2/vectordb/indexes/create
Cluster Endpoint

The base URL for this API is in the following format:

https://${CLUSTER_ENDPOINT}

📘Notes
  • You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
  • To get the endpoint, refer to Zilliz Cloud Console or use the Describe Cluster V2 API to extract the values from the responses.
export CLUSTER_ENDPOINT=""
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
dbNamestring

The name of the database that to which the collection belongs . Setting this to a non-existing database results in an error.

collectionNamestringrequired

The name of the target collection. Setting this to a non-existing collection results in an error.

indexParamsarrayrequired

The parameters that apply to the index-building process.

[]indexParamsobjectrequired

Index parameters for a specific field.

metricTypestringrequired

The similarity metric type used to build the index. For more information, refer to Similarity Metrics Explained.

fieldNamestringrequired

The name of the target field on which an index is to be created.

indexNamestringrequired

The name of the index to create. The value defaults to the target field name.

paramsobject

The index type and related settings. For details, refer to Vector Indexes.

index_typestringrequired

The type of the index to create

Minteger

The maximum degree of the node. This applies only when index_type is set to HNSW.

efConstructioninteger

The search scope. This applies only when index_type is set to HNSW.

nlistinteger

The number of cluster units. This applies only when index_type is set to IVF-related index types.

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/indexes/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "custom_setup_not_indexed",
    "indexParams": [
        {
            "metricType": "L2",
            "fieldName": "my_vector",
            "indexName": "my_vector",
            "indexConfig": {
                "index_type": "AUTOINDEX"
            }
        }
    ]
}'
Responses200 - application/json

A success response

codeinteger

Response code.

dataobject

Response payload which is an empty object.

A failure response.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {}
}