跳到主要内容

创建 Collection

This operation creates a collection in a specified cluster.

POST
/v2/vectordb/collections/create
集群 Endpoint

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

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

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

示例值：Bearer {{TOKEN}}
请求体application/json
dbNamestring

数据库名称。

collectionNamestring必填项

待创建 Collection 的名称。

dimensioninteger必填项

向量值的维度数。 若该字段的 dtype 为 DataType.FLOAT_VECTOR 或 DataType.Binary_VECTOR，则该字段为必填项。

metricTypestring

当前 Collection 的度量类型。

idTypestring

主键字段数据类型。该参数为快速创建 Collection 而设计，若您已定义 schema 字段，则该参数将被忽略。

autoIDstring

主键是否自动增长。该参数为快速创建 Collection 而设计，若您已定义 schema 字段，则该参数将被忽略。

primaryFieldNamestring

主键字段名称。该参数为快速创建 Collection 而设计，若您已定义 schema 字段，则该参数将被忽略。

vectorFieldNamestring

向量字段名称。该参数为快速创建 Collection 而设计，若您已定义 schema 字段，则该参数将被忽略。

dbNamestring

数据库名称。

collectionNamestring

待创建 Collection 的名称。

schemaobject

Schema 决定了 Collection 中数据的组织方式。一个有效的 Schema 应包含多个字段，其中必须包含主键字段、向量字段以及多个标量字段。设置本参数时，dimension、 idType、autoID、primaryFieldName、vectorFieldName 等参数将被忽略。

autoIDstring

是否允许主键字段自动增长。将该参数设置为 True 则主键字段将自动增长。在这种情况下，请不要在插入数据时包含主键字段，以避免错误。如果当前字段的 is_primary 参数设置为 True，则本参数为必填项。

enableDynamicFieldstring

是否允许使用保留字段 $meta 来保存 Schema 中未定义的字段。

fieldsarrayrequired

字段列表。

[]fieldsobjectrequired

A field object

fieldNamestring必填项

目标 Collection 中待创建的字段名称。

dataTypestring必填项

字段值的数据类型。

elementDataTypestring

数组字段中各元素的数据类型。若当前字段为数组类型，则该参数为必填项。

isPrimaryboolean

当前字段是否为主键字段。将该参数设置为 True 则当前字段将成为主键字段。此时，还需要确定 autoID 参数的取值。

isPartitionKeyboolean

当前字段是否为 Partition Key。将该参数设置为 True 则当前字段将作为 Partition Key。在这种情况下， 会管理当前 Collection 中的所有 Partition。

elementTypeParamsobject

字段附加参数。

max_lengthinteger

如果当前字段的数据类型为 VarChar，则该参数为必填项，用于设置该字段值的最大长度。

diminteger

如果当前字段的数据类型为 FloatVector 或 BinaryVector，则该参数为必填项，用于设置向量维度。

max_capacityinteger

如果当前字段的数据类型为 Array，则该参数为必填项，用于设置该字段值的最大元素数量。

indexParamsarray

索引构建所需相关参数。

[]indexParamsobject
metricTypestring必填项

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

fieldNamestring必填项

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

indexNamestring必填项

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

paramsobject

索引类型及相关设置。对于 Zilliz Cloud 集群而言，请始终将 index_type 设置成 AUTOINDEX。

index_typestring必填项

要创建的索引类型。对于 Zilliz Cloud 集群而言，请始终将 index_type 设置成 AUTOINDEX

paramsobject

创建 Collection 的附加参数。

max_lengthinteger

设置 VarChar 字段的最大长度。如果当前字段类型为 VarChar 时，该参数为必填项。

enableDynamicFieldboolean

是否启用保留的动态字段。如果设置为 true，则非 Schema 定义的字段将以键值对的形式保存被保存到保留的动态字段中。

consistencyLevelinteger

当前 Collection 的一致性级别。

partitionsNuminteger

随当前 Collection 创建的 Partition 数量。如果当前 Collection 中有指定为 Partition Key 的字段，则该参数为必填项。

ttlSecondsinteger

当前 Collection 的 TTL 时间。如果设置，则在 TTL 时间结束后，该 Collection 将被删除。

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "test_collection",
    "dimension": 5
}'
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "custom_quick_setup",
    "dimension": 5,
    "primaryFieldName": "my_id",
    "idType": "VarChar",
    "vectorFieldName": "my_vector",
    "metric_type": "L2",
    "autoId": true,
    "params": {
        "max_length": "512"
    }
}'
响应200 - application/json
codeinteger

响应码。

dataobject

响应负载，为空对象。

A failure response.

codeinteger

响应码。

messagestring

错误描述。

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