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

JSON Field Overview

製品カタログ、コンテンツ管理システム、ユーザー設定エンジンのようなアプリケーションを構築する際、vector 埋め込みとあわせて柔軟なメタデータを保存する必要がよくあります。製品属性はカテゴリごとに異なり、ユーザー設定は時間とともに変化し、ドキュメント属性は複雑なネスト構造を持ちます。Zilliz Cloud の JSON field は、パフォーマンスを損なうことなく柔軟な構造化データを保存およびクエリできるようにすることで、この課題を解決します。

JSON field とは何ですか？​

JSON field は、構造化されたキーと値のデータを保存する Zilliz Cloud のスキーマ定義データ型（DataType.JSON）です。従来の固定的なデータベース列とは異なり、JSON field はネストされたオブジェクト、配列、混在するデータ型を扱うことができ、高速なクエリのための複数のインデックスオプションを提供します。

JSON field 構造の例:

json
{
  "metadata": { 
    "category": "electronics",
    "brand": "BrandA",
    "in_stock": true,
    "price": 99.99,
    "string_price": "99.99",
    "tags": ["clearance", "summer_sale"],
    "supplier": {
      "name": "SupplierX",
      "country": "USA",
      "contact": {
        "email": "support@supplierx.com",
        "phone": "+1-800-555-0199"
      }
    }
  }
}

この例では、metadata は単一の JSON field であり、フラットな値（例: category、in_stock）、配列（tags）、ネストされたオブジェクト（supplier）が混在しています。

📘Notes

命名規則: JSON キーには文字、数字、アンダースコアのみを使用してください。特殊文字、スペース、ドットは、クエリ時に解析上の問題を引き起こす可能性があるため避けてください。

JSON field と dynamic field の違い​

よく混同されるのが、JSON field と dynamic field の違いです。どちらも JSON に関連していますが、用途は異なります。

以下の表は、JSON field と dynamic field の主な違いをまとめたものです。

FeatureJSON FieldDynamic Field
Schema definitionDataType.JSON 型で collection schema に明示的に宣言する必要がある scalar field。未宣言の field を自動的に保存する非表示の JSON field（$meta という名前）。
Use caseスキーマが既知で一貫している構造化データを保存。固定スキーマに収まらない、柔軟で変化し続ける、または半構造化のデータを保存。
Controlfield 名と構造を自分で制御できる。未定義 field 用にシステム管理される。
Queryingfield 名または JSON field 内の対象キーを使ってクエリ: metadata["key"]。dynamic field キーを直接使ってクエリ: "dynamic_key"、または $meta 経由: $meta["dynamic_key"]

基本操作​

JSON field を使用する基本的なワークフローは、スキーマで定義し、データを挿入し、その後特定のフィルター式を使ってデータをクエリすることです。

JSON field を定義する​

JSON field を使用するには、collection 作成時に collection schema で明示的に定義します。次の例は、DataType.JSON 型の metadata field を持つ collection を作成する方法を示しています。

python
from pymilvus import MilvusClient, DataType

CLUSTER_ENDPOINT = "YOUR_CLUSTER_ENDPOINT"
TOKEN = "YOUR_CLUSTER_TOKEN" 

# Set up a Milvus client
client = MilvusClient(
    uri=CLUSTER_ENDPOINT,
    token=TOKEN 
)

# Create schema
schema = client.create_schema(auto_id=False, enable_dynamic_field=True)

schema.add_field(field_name="product_id", datatype=DataType.INT64, is_primary=True) # Primary field
schema.add_field(field_name="vector", datatype=DataType.FLOAT_VECTOR, dim=5) # Vector field
# Define a JSON field that allows null values
schema.add_field(field_name="metadata", datatype=DataType.JSON, nullable=True)

client.create_collection(
    collection_name="product_catalog",
    schema=schema
)
📘Notes

この例では、collection schema で定義された JSON field は nullable=True により null 値を許可します。詳細は Nullable & Default を参照してください。

データを挿入する​

collection を作成したら、指定した JSON field に構造化された JSON オブジェクトを含む entity を挿入します。データは辞書のリストとしてフォーマットしてください。

python
entities = [
    {
        "product_id": 1,
        "vector": [0.1, 0.2, 0.3, 0.4, 0.5],
        "metadata": { # JSON field
            "category": "electronics",
            "brand": "BrandA",
            "in_stock": True,
            "price": 99.99,
            "string_price": "99.99",
            "tags": ["clearance", "summer_sale"],
            "supplier": {
                "name": "SupplierX",
                "country": "USA",
                "contact": {
                    "email": "support@supplierx.com",
                    "phone": "+1-800-555-0199"
                }
            }
        }
    }
]

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

フィルタリング操作​

JSON field に対してフィルタリング操作を行う前に、次の点を確認してください。

  • 各 vector field に対してインデックスを作成していること。

  • collection がメモリにロードされていること。

コード例を表示
python
index_params = client.prepare_index_params()
index_params.add_index(
    field_name="vector",
    index_type="AUTOINDEX",
    index_name="vector_index",
    metric_type="COSINE"
)

client.create_index(collection_name="product_catalog", index_params=index_params)

client.load_collection(collection_name="product_catalog")

これらの要件を満たすと、以下の式を使用して、JSON field 内の値に基づいて collection をフィルタリングできます。これらのフィルター式では、特定の JSON パス構文と専用の演算子を利用します。

JSON パス構文によるフィルタリング​

特定のキーをクエリするには、角括弧記法を使用して JSON キーにアクセスします: json_field_name["key"]。ネストされたキーの場合は、json_field_name["key1"]["key2"] のように連結します。

category が "electronics" の entity をフィルタリングするには:

python
# Define filter expression
filter = 'metadata["category"] == "electronics"'

client.search(
    collection_name="product_catalog",  # Collection name
    data=[[0.1, 0.2, 0.3, 0.4, 0.5]],               # Query vector (must match collection's vector dim)
    limit=5,                           # Max. number of results to return
    filter=filter,                    # Filter expression
    output_fields=["product_id", "metadata"]   # Fields to include in the search results
)

ネストされたキー supplier["country"] が "USA" の entity をフィルタリングするには:

python
# Define filter expression
filter = 'metadata["supplier"]["country"] == "USA"'

res = client.search(
    collection_name="product_catalog",  # Collection name
    data=[[0.1, 0.2, 0.3, 0.4, 0.5]],               # Query vector (must match collection's vector dim)
    limit=5,                           # Max. number of results to return
    filter=filter,                    # Filter expression
    output_fields=["product_id", "metadata"]   # Fields to include in the search results
)

print(res)

JSON 専用演算子によるフィルタリング​

Zilliz Cloud は、特定の JSON field キー上の配列値をクエリするための特別な演算子も提供しています。たとえば次のようなものです。

  • json_contains(identifier, expr): 特定の要素またはサブ配列が JSON 配列内に存在するかを確認します

  • json_contains_all(identifier, expr): 指定した JSON 式のすべての要素が field 内に存在することを確認します

  • json_contains_any(identifier, expr): JSON 式の少なくとも 1 つのメンバーが field 内に存在する entity をフィルタリングします

tags キーの下に "summer_sale" 値を持つ製品を見つけるには:

python
# Define filter expression
filter = 'json_contains(metadata["tags"], "summer_sale")'

res = client.search(
    collection_name="product_catalog",  # Collection name
    data=[[0.1, 0.2, 0.3, 0.4, 0.5]],               # Query vector (must match collection's vector dim)
    limit=5,                           # Max. number of results to return
    filter=filter,                    # Filter expression
    output_fields=["product_id", "metadata"]   # Fields to include in the search results
)

print(res)

tags キーの下に "electronics"、"new"、または "clearance" の少なくとも 1 つの値を持つ製品を見つけるには:

python
# Define filter expression
filter = 'json_contains_any(metadata["tags"], ["electronics", "new", "clearance"])'

res = client.search(
    collection_name="product_catalog",  # Collection name
    data=[[0.1, 0.2, 0.3, 0.4, 0.5]],               # Query vector (must match collection's vector dim)
    limit=5,                           # Max. number of results to return
    filter=filter,                    # Filter expression
    output_fields=["product_id", "metadata"]   # Fields to include in the search results
)

print(res)

JSON 専用演算子の詳細については、JSON Operators を参照してください。

次へ: JSON クエリを高速化する​

デフォルトでは、高速化なしの JSON field に対するクエリはすべての行をフルスキャンするため、大規模データセットでは遅くなる可能性があります。JSON クエリを高速化するために、Zilliz Cloud は高度なインデックス機能とストレージ最適化機能を提供しています。

🚧Warning

Milvus 3.0.0 以降では、オブジェクト全体の JSON インデックス（json_cast_type="JSON"）、いわゆる JSON flat indexing は非推奨です。既存のインデックスおよび新しいインデックス作成リクエストは互換性のため引き続きサポートされますが、このモードは新しいワークロードには推奨されなくなりました。既知のクエリパスには JSON path indexing を使用するか、複雑または変化し続けるドキュメント全体で広範なクエリ高速化を行う場合は JSON Shredding を検討してください。

以下の表は、それらの違いと最適な利用シナリオをまとめたものです。

TechniqueBest ForArrays AccelerationNotes
JSON Indexing頻繁にアクセスされる少数のキー、特定の配列キー上の配列Yes (on indexed array key)事前にキーを選択する必要があり、スキーマが変化する場合はメンテナンスが必要
JSON Shredding多数のキーにまたがる全般的な高速化、多様なクエリに柔軟に対応Yes (slightly accelerates array values compared to brute-force queries)追加のストレージ設定が必要で、配列には依然としてキーごとのインデックスが必要
NGRAM Indexワイルドカード検索、テキスト field での部分文字列一致N/A数値/範囲フィルター向けではない

Tip: これらのアプローチは組み合わせて使用できます。たとえば、広範なクエリ高速化には JSON shredding、高頻度の配列キーには JSON indexing、柔軟なテキスト検索には NGRAM indexing を使用できます。

実装の詳細については、以下を参照してください。

FAQ​

JSON field のサイズに制限はありますか？​

はい。各 JSON field は 65,536 バイトに制限されています。

JSON field はデフォルト値の設定をサポートしていますか？​

いいえ。JSON field はデフォルト値をサポートしていません。ただし、field 定義時に nullable=True を設定することで空のエントリを許可できます。

詳細は Nullable & Default を参照してください。

JSON フィールドのキーに命名規則はありますか?​

はい。クエリおよびインデックスとの互換性を確保するために、次の点に従ってください。

  • JSON キーには、英字、数字、アンダースコアのみを使用してください。

  • 特殊文字、スペース、ドット（ ., / など）は使用しないでください。

  • 互換性のないキーは、フィルター式の解析時に問題を引き起こす可能性があります。

Zilliz Cloud は JSON フィールド内の文字列値をどのように扱いますか?​

Zilliz Cloud は、文字列値を JSON 入力に現れるとおりに、そのまま保存します。意味的な変換は行いません。不適切に引用された文字列は、解析時にエラーの原因となる場合があります。

有効な文字列の例:

plaintext
"a\"b", "a'b", "a\\b"

無効な文字列の例:

plaintext
'a"b', 'a\'b'
Ctrl I