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

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

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

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

https://${CLUSTER_ENDPOINT}

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

認証トークンは、適切な権限を持つ API key または username:password のようにコロンで連結した username と password の組み合わせである必要があります。project endpoint を使用している場合は、十分な権限を持つ有効な API key のみ使用できます。

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

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

collectionNamestring必要

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

schemaobject必要

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

fieldNamestring必要

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

dataTypestring必要

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

elementDataTypestring

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

nullableboolean

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

defaultValuestring

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

isPrimaryboolean

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

isPartitionKeyboolean

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

elementTypeParamsobject

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

max_lengthinteger

現在のフィールドにおける値の最大長を決定する、VarChar 値用のオプションパラメータです。

diminteger

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

max_capacityinteger

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

externalFieldstring

外部ソース内の対応する列の名前。external collection を作成する場合に必須です。

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": "VARCHAR",
        "nullable": true,
        "defaultValue": "default_value",
        "elementTypeParams": {
            "max_length": 255
        }
    }
}'
レスポンス200 OK - application/json

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

codeinteger

レスポンスコード。

dataobject

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

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