跳到主要内容

添加 Collection 字段

本操作可以在不重建 Collection 的情况下添加字段。
POST
/v2/vectordb/collections/fields/add
集群 Endpoint

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

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

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

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

Database 名称。

collectionNamestring

Collection 名称。

schemaobject

待添加字段的 Schema。

fieldNamestring

待添加字段的名称。

dataTypestring

待添加字段的数据类型。支持的类型有 Int64、Float、Double、VarChar、Array 和 Vector。

elementDataTypestring

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

nullableboolean

字段是否可以为 null。在此处处须设置为 true，以兼容 Collection 中已经存在数据的情形。

defaultValueobject

字段的默认值。若当前字段为 VarChar 类型，则该参数为必填项。

elementTypeParamsobject

字段附加参数。

max_lengthinteger

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

max_capacityinteger

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

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/fields/add" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "test_db",
    "collectionName": "test_collection",
    "schema": {
        "fieldName": "new_field",
        "dataType": "DataType.VARCHAR",
        "nullable": true,
        "defaultValue": "default_value",
        "elementTypeParams": {
            "max_length": 255
        }
    }
}'
响应200 - application/json
codeinteger

响应码。

dataobject

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

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