メインコンテンツまでスキップ

コレクション フィールドの追加 (V2)

この操作は、コレクションを再作成せずに、コレクションにフィールドを追加します。

POST/v2/vectordb/collections/fields/add
接続エンドポイント

https://${CLUSTER_ENDPOINT}

📘ノート
  • ${CLUSTER_ENDPOINT} を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。
  • エンドポイントを取得するには、Describe Cluster V2 APIを使用してレスポンスから値を抽出してください。
shell
export CLUSTER_ENDPOINT=""
パラメータ
Authorizationstringheader必要

認証トークンは、 適切な権限を持つAPIキー、または コロンで連結されたユーザー名とパスワードのペア（例: username:password）である必要があります。プロジェクトエンドポイントを使用する場合は、十分な権限を持つ有効なAPIキーのみが適用されます。

値の例： Bearer {{TOKEN}}
リクエスト・ボディapplication/json
dbNamestring

コレクションが属するデータベースの名前。存在しないデータベースを指定するとエラーになります。指定しない場合は、デフォルトのデータベースが適用されます。

collectionNamestring必要

対象コレクションの名前。 存在しないコレクションを指定するとエラーになります。

schemaobject必要

フィールドのスキーマオブジェクト。

fieldNamestring必要

対象コレクションに作成するフィールドの名前。

dataTypestring必要

フィールド値のデータ型。

elementDataTypestring

配列フィールド内の要素のデータ型。現在のフィールドが配列型の場合は必須です。

nullableboolean

フィールドが null 値を取れるかどうか。true に設定すると、フィールドに null 値を含めることができます。

defaultValuestring

フィールドのデフォルト値。現在のフィールドがVarChar 型の場合は必須です。

isPrimaryboolean

現在のフィールドがプライマリフィールドであるかどうか。これを True に設定すると、現在のフィールドがプライマリフィールドになります。

isPartitionKeyboolean

現在のフィールドがパーティションキーとして機能するかどうか。これを True に設定すると、現在のフィールドがパーティションキーとして機能します。この場合、 が現在のコレクション内のすべてのパーティションを管理します。

elementTypeParamsobject

追加のフィールドパラメーター。

max_lengthinteger

VarChar 値のオプションのパラメーターであり、現在のフィールドの値の最大長を決定します。

diminteger

FloatVector または BinaryVector フィールドのオプションのパラメーターで、ベクトルの次元を決定します。

max_capacityinteger

Array フィールドの値のオプションのパラメーターで、現在の配列フィールド内の要素の最大数を決定します。

externalFieldstring

外部ソース内の対応する列の名前。外部コレクションを作成する場合に必須です。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/fields/add" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--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 OK - application/json

空のオブジェクトを返します。

codeinteger

レスポンスコード。

dataobject

エラーメッセージを返します。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {}
}
Ctrl I