创建索引

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

集群 Endpoint

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

📘说明

• 你需要填入您的 Zilliz Cloud 集群的 ${CLUSTER_ENDPOINT}。
• 您可以参考 On Zilliz Cloud 控制台或使用 查看集群详情 V2 来获取集群的 Endpoint.

export CLUSTER_ENDPOINT=""

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 username:password。

示例值：Bearer {{TOKEN}}

请求体application/json

collectionNamestring必填项

目标 Collection 的名称。设置为不存在的 Collection 将导致错误。

indexParamsarrayrequired

应用于索引构建过程的参数。

[]indexParamsobjectrequired

Index parameters for a specific field.

metricTypestring必填项

用于构建索引的相似度类型。更多详情，请参考相似度类型。

枚举值：

L2IPCOSINE

fieldNamestring必填项

要创建索引的目标字段名称。

indexNamestring必填项

要创建的索引的名称，该值默认为目标字段名称。

paramsobject

索引类型及相关设置。详细信息，请参阅 向量索引。

index_typestring必填项

要创建的索引类型。

Minteger

数据节点与其他节点连接的边数。此参数仅适用于索引类型为 HNSW 的情况。

efConstructioninteger

搜索范围。此参数仅适用于索引类型为 HNSW 的情况。

nlistinteger

数据集群单元的数量。此参数仅适用于索引类型为 IVF 系列索引的情况。

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"
            }
        }
    ]
}'

响应200 - application/json

SUCCESS

A success response

codeinteger

响应码。

dataobject

响应载荷。为空对象。

FAILURE

A failure response.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

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