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

Alter Field Properties (V2)

この操作は、コレクション内のフィールドのプロパティを変更します。

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

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必要

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

fieldNamestring必要

プロパティを変更するフィールドの名前。

fieldParamsobject

変更するフィールドのプロパティ。

max_lengthinteger

フィールドの最大長。この値をゼロ以外に設定すると、フィールドの最大長が指定値に制限されます。
このパラメータは、フィールドのタイプがVarCharの場合にのみ適用されます。

max_capacityinteger

フィールドの最大容量。この値をゼロ以外に設定すると、フィールドの最大容量が指定値に制限されます。
このパラメータは、フィールドのタイプがArrayの場合にのみ適用されます。

mmap_enabledboolean

フィールドのメモリマップドファイルを有効にするかどうか。
このパラメータは、フィールドのタイプがVectorの場合にのみ適用されます。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/fields/alter_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "test_collection",
    "fieldName": "my_varchar",
    "fieldParams": {
        "max_length": 100
    }
}'
レスポンス200 OK - application/json

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

codeinteger

レスポンスコード。

dataobject

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

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