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

Dynamic Field

Zilliz Cloud では、dynamic field と呼ばれる特別な機能を使用して、柔軟で進化する構造を持つエンティティを挿入できます。このフィールドは $meta という名前の非表示の JSON フィールドとして実装されており、コレクションスキーマで明示的に定義されていないデータ内のフィールドを自動的に保存します。

仕組み​

dynamic field が有効になると、Zilliz Cloud は各エンティティに非表示の $meta フィールドを追加します。このフィールドは JSON 型であるため、JSON と互換性のある任意のデータ構造を保存でき、JSON path 構文を使用してインデックスを作成できます。

データ挿入時には、スキーマで宣言されていないフィールドはすべて、この dynamic field 内にキーと値のペアとして自動的に保存されます。

$meta を手動で管理する必要はありません。Zilliz Cloud が透過的に処理します。

たとえば、コレクションスキーマで id と vector のみを定義していて、次のエンティティを挿入するとします。

json
{
  "id": 1,
  "vector": [0.1, 0.2, 0.3],
  "name": "Item A",    // Not in schema
  "category": "books"  // Not in schema
}

dynamic field 機能を有効にすると、Zilliz Cloud は内部的に次のように保存します。

json
{
  "id": 1,
  "vector": [0.1, 0.2, 0.3],
  "$meta": {
    "name": "Item A",
    "category": "books"
  }
}

これにより、スキーマを変更することなくデータ構造を進化させることができます。

一般的なユースケースは次のとおりです。

  • オプションのフィールドや取得頻度の低いフィールドの保存

  • エンティティごとに異なるメタデータの取り込み

  • 特定の dynamic field キーに対するインデックスによる柔軟なフィルタリングのサポート

サポートされるデータ型​

dynamic field は、単純な値と複雑な値の両方を含め、Zilliz Cloud が提供するすべてのスカラーデータ型をサポートします。これらのデータ型は、$meta に保存されるキーの値に適用されます。

サポートされる型は次のとおりです:

  • 文字列（VARCHAR）

  • 整数（INT8、INT32、INT64）

  • 浮動小数点（FLOAT、DOUBLE）

  • ブール値（BOOL）

  • スカラー値の配列（ARRAY）

  • JSON オブジェクト（JSON）

例:

json
{
  "brand": "Acme",
  "price": 29.99,
  "in_stock": true,
  "tags": ["new", "hot"],
  "specs": {
    "weight": "1.2kg",
    "dimensions": { "width": 10, "height": 20 }
  }
}

上記の各キーと値は、$meta フィールド内に保存されます。

dynamic field を有効にする​

dynamic field 機能を使用するには、コレクションスキーマの作成時に enable_dynamic_field=True を設定します。

python
from pymilvus import MilvusClient, DataType

# Initialize client
client = MilvusClient(uri="YOUR_CLUSTER_ENDPOINT")

# Create schema with dynamic field enabled
schema = client.create_schema(
    auto_id=False,
    enable_dynamic_field=True,
)

# Add explicitly defined fields
schema.add_field(field_name="my_id", datatype=DataType.INT64, is_primary=True)
schema.add_field(field_name="my_vector", datatype=DataType.FLOAT_VECTOR, dim=5)

# Create the collection
client.create_collection(
    collection_name="my_collection",
    schema=schema
)

コレクションにエンティティを挿入する​

dynamic field を使用すると、スキーマで定義されていない追加のフィールドをコレクションに挿入できます。これらのフィールドは自動的に $meta に保存されます。

python
entities = [
    {
        "my_id": 1, # Explicitly defined primary field
        "my_vector": [0.1, 0.2, 0.3, 0.4, 0.5], # Explicitly defined vector field
        "overview": "Great product",       # Scalar key not defined in schema
        "words": 150,                      # Scalar key not defined in schema
        "dynamic_json": {                  # JSON key not defined in schema
            "varchar": "some text",
            "nested": {
                "value": 42.5
            },
            "string_price": "99.99"        # Number stored as string
        }
    }
]

client.insert(collection_name="my_collection", data=entities)

dynamic field 内のキーにインデックスを作成する​

Zilliz Cloud では、JSON path indexing を使用して、dynamic field 内の特定のキーにインデックスを作成できます。対象となるのは、スカラー値または JSON オブジェクト内のネストされた値です。

Notes

dynamic field のキーに対するインデックス作成は任意です。インデックスがなくても dynamic field のキーでクエリやフィルターを実行できますが、総当たり検索になるためパフォーマンスが低下する可能性があります。

JSON path インデックス構文​

JSON path インデックスを作成するには、次の項目を指定します。

  • JSON path（json_path）: インデックスを作成する対象の、JSON オブジェクト内のキーまたはネストされたフィールドへのパス。

    • 例: metadata["category"]

      これは、インデックス作成エンジンが JSON 構造内のどこを参照すべきかを定義します。

  • JSON cast type（json_cast_type）: 指定されたパスの値を解釈してインデックスを作成する際に Zilliz Cloud が使用するデータ型。

    • この型は、インデックスを作成するフィールドの実際のデータ型と一致している必要があります。

    • 完全なリストについては、サポートされている JSON cast type を参照してください。

JSON path を使用して dynamic field のキーにインデックスを作成する​

dynamic field は JSON フィールドであるため、JSON path 構文を使用してその内部の任意のキーにインデックスを作成できます。これは、単純なスカラー値と複雑なネスト構造の両方で機能します。

JSON path の例:

  • 単純なキーの場合: overview、words

  • ネストされたキーの場合: dynamic_json['varchar']、dynamic_json['nested']['value']

python
index_params = client.prepare_index_params()

# Index a simple string key
index_params.add_index(
    field_name="overview",  # Key name in the dynamic field
    index_type="AUTOINDEX", # Must be set to AUTOINDEX for JSON path indexing
    index_name="overview_index",  # Unique index name
    params={
        "json_cast_type": "varchar",   # Data type that Zilliz Cloud uses when indexing the values
        "json_path": "overview"        # JSON path to the key
    }
)

# Index a simple numeric key
index_params.add_index(
    field_name="words",  # Key name in the dynamic field
    index_type="AUTOINDEX", # Must be set to AUTOINDEX for JSON path indexing
    index_name="words_index",  # Unique index name
    params={
        "json_cast_type": "double",  # Data type that Zilliz Cloud uses when indexing the values
        "json_path": "words" # JSON path to the key
    }
)

# Index a nested key within a JSON object
index_params.add_index(
    field_name="dynamic_json", # JSON key name in the dynamic field
    index_type="AUTOINDEX", # Must be set to AUTOINDEX for JSON path indexing
    index_name="json_varchar_index", # Unique index name
    params={
        "json_cast_type": "varchar", # Data type that Zilliz Cloud uses when indexing the values
        "json_path": "dynamic_json['varchar']" # JSON path to the nested key
    }
)

# Index a deeply nested key
index_params.add_index(
    field_name="dynamic_json",
    index_type="AUTOINDEX", # Must be set to AUTOINDEX for JSON path indexing
    index_name="json_nested_index", # Unique index name
    params={
        "json_cast_type": "double",
        "json_path": "dynamic_json['nested']['value']"
    }
)

JSON cast 関数を使用して型を変換する​

dynamic field のキーに正しくない形式の値（たとえば、文字列として保存された数値）が含まれている場合は、cast 関数を使用して変換できます。

python
# Convert a string to double before indexing
index_params.add_index(
    field_name="dynamic_json", # JSON key name
    index_type="AUTOINDEX",
    index_name="json_string_price_index",
    params={
        "json_path": "dynamic_json['string_price']",
        "json_cast_type": "double", # Must be the output type of the cast function
        "json_cast_function": "STRING_TO_DOUBLE" # Case insensitive; convert string to double
    }
)
Notes

  • 型変換に失敗した場合（たとえば、値 "not_a_number" を数値に変換できない場合）、その値はスキップされ、インデックスに登録されません。

  • cast 関数のパラメーターの詳細については、JSON フィールドの概要 を参照してください。

インデックスをコレクションに適用する​

インデックスパラメーターを定義したら、create_index() を使用してそれらをコレクションに適用できます。

python
client.create_index(
    collection_name="my_collection",
    index_params=index_params
)

dynamic field のキーでフィルターする​

dynamic field のキーを持つエンティティを挿入した後は、標準のフィルター式を使用してそれらをフィルタリングできます。

  • JSON 以外のキー（文字列、数値、ブール値など）の場合は、キー名で直接参照できます。

  • JSON オブジェクトを保存するキーの場合は、JSON path 構文を使用してネストされた値にアクセスします。

前のセクションの例のエンティティに基づくと、有効なフィルター式には次のものがあります。

python
filter = 'overview == "Great product"'                # Non-JSON key
filter = 'words >= 100'                               # Non-JSON key
filter = 'dynamic_json["nested"]["value"] < 50'       # JSON object key

dynamic field のキーの取得: 検索またはクエリの結果で dynamic field のキーを返すには、フィルタリングと同じ JSON path 構文を使用して、output_fields パラメーターで明示的に指定する必要があります。

python
# Example: Include dynamic field keys in search results
results = client.search(
    collection_name="my_collection",
    data=[[0.1, 0.2, 0.3, 0.4, 0.5]],
    filter=filter,                         # Filter expression defined earlier
    limit=10,
    output_fields=[
        "overview",                        # Simple dynamic field key
        "dynamic_json"          # Nested JSON key
    ]
)
Notes

dynamic field のキーはデフォルトでは結果に含まれないため、明示的に要求する必要があります。

サポートされている演算子とフィルター式の完全なリストについては、フィルタ付き検索 を参照してください。

まとめ​

ここまでで、dynamic field を使用して、スキーマで定義されていないキーを柔軟に保存し、インデックスを作成する方法を学びました。dynamic field のキーを挿入した後は、特別な構文を使用することなく、フィルター式内で他のフィールドと同じように使用できます。

実際のアプリケーションでワークフローを完成させるには、次のことも必要です。

  • ベクトルフィールドにインデックスを作成する（各コレクションで必須）

    詳細は、AUTOINDEX の解説 およびその関連ページを参照してください。

  • コレクションをロードする

    詳細は、ロードと解放 を参照してください。

  • JSON path フィルターを使用して検索またはクエリする

    詳細は、フィルタ付き検索 および JSON 演算子 を参照してください。

FAQ​

dynamic field のキーを使用するのではなく、スキーマでフィールドを明示的に定義するのはどのような場合ですか？​

次のような場合は、dynamic field のキーを使用するのではなく、スキーマでフィールドを明示的に定義する必要があります。

  • フィールドを output_fields に頻繁に含める場合: output_fields を通じて効率的に取得できることが保証されるのは、明示的に定義されたフィールドだけです。dynamic field のキーは高頻度の取得向けに最適化されていないため、パフォーマンスのオーバーヘッドが発生する可能性があります。

  • フィールドへのアクセスやフィルタリングが頻繁に行われる場合: dynamic field のキーにインデックスを作成すると、固定スキーマのフィールドと同様のフィルタリングパフォーマンスが得られますが、明示的に定義されたフィールドの方が構造が明確で保守性に優れています。

  • フィールドの動作を完全に制御する必要がある場合: 明示的なフィールドは、スキーマレベルの制約、検証、より明確な型指定をサポートしているため、データの整合性と一貫性の管理に役立ちます。

  • インデックス作成の不整合を避けたい場合: dynamic field のキー内のデータは、型や構造が不整合になりがちです。固定スキーマを使用すると、特にインデックス作成やキャストを使用する予定がある場合に、データ品質を確保しやすくなります。

dynamic field のキーを既存のコレクションの明示的なスカラーフィールドにする場合は、コレクションスキーマの変更 を参照してください。既存のコレクションレベルの dynamic field 設定はコレクションプロパティで管理されます。詳細は、コレクションの変更 を参照してください。

同じ dynamic field のキーに、異なるデータ型で複数のインデックスを作成できますか？​

いいえ、作成できるのは JSON path ごとに 1 つのインデックスのみです。dynamic field のキーに混在した型の値（文字列と数値が混在している場合など）が含まれていても、そのパスにインデックスを作成する際には単一の json_cast_type を選択する必要があります。現時点では、同じキーに異なる型で複数のインデックスを作成することはサポートされていません。

dynamic field のキーにインデックスを作成するときにデータのキャストが失敗した場合はどうなりますか？​

dynamic field のキーにインデックスを作成していて、データのキャストが失敗した場合、たとえば double にキャストされるはずの値が "abc" のような数値以外の文字列である場合、それらの値はインデックスの作成中に通知されることなくスキップされます。これらの値はインデックスに含まれないため、インデックスに依存するフィルターベースの検索やクエリの結果では返されません。

これにはいくつかの重要な影響があります。

  • フルスキャンへのフォールバックはなし: ほとんどのエンティティが正常にインデックス化されると、フィルタリングクエリはインデックスに完全に依存します。キャストに失敗したエンティティは、フィルター条件に論理的に一致していても、結果セットから除外されます。

  • 検索精度のリスク: データ品質が一貫していない大規模なデータセット（特に dynamic field のキー）では、この動作によって予期しない結果の欠落が発生する可能性があります。インデックスを作成する前に、一貫性のある有効なデータ形式を確保することが重要です。

  • キャスト関数は慎重に使用する: インデックス作成時に json_cast_function を使用して文字列を数値に変換する場合は、文字列の値を確実に変換できるようにしてください。json_cast_type と実際に変換された型が一致しないと、エラーが発生したり、エントリがスキップされたりします。

クエリでインデックス作成時の cast type とは異なるデータ型を使用するとどうなりますか？​

クエリで dynamic field のキーを比較する際に、インデックスで使用された型とは異なるデータ型を使用すると（たとえば、インデックスが double にキャストされているのに文字列比較でクエリする場合）、システムはインデックスを使用しません。また、可能な場合に限りフルスキャンにフォールバックすることがあります。最高のパフォーマンスと精度を得るには、クエリの型をインデックス作成時に使用した json_cast_type と一致させてください。

Ctrl I