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

JSON インデックス作成

JSON フィールドは、Zilliz Cloud で構造化メタデータを保存するための柔軟な方法を提供します。インデックスがない場合、JSON フィールドへのクエリでは collection 全体のスキャンが必要となり、データセットが大きくなるほど遅くなります。JSON インデックス作成では、JSON データ内の特定のパスにインデックスを作成するため、そのパスに対する equality、range、その他の filter クエリを高速に実行できます。

JSON インデックス作成は、次のような場合に適しています。

  • 一貫性があり、既知のキーを持つ構造化スキーマ

  • 特定の JSON パスに対する equality、IN、range、および text-match クエリ

  • どのキーをインデックス化するかを正確に制御する必要があるシナリオ

多様なクエリパターンを持つ複雑な JSON ドキュメントには、代替手段として JSON Shredding を検討してください。

インデックスタイプの概要​

Zilliz Cloud は JSON パスに対して 4 つのインデックスタイプを提供します。それぞれ異なるクエリパターンに適しています。

インデックスタイプを選ぶ前に、その JSON パスの cast type を特定してください。cast type は、Zilliz Cloud がそのパスの値をどのように解釈するか、および利用可能なインデックスタイプを決定します。

cast type を理解する​

json_cast_type は、json_path にある値を解釈してインデックス化するために使用されるデータ型です。これはフィールドのスキーマ型とは異なります。フィールド自体は依然として JSON フィールドですが、インデックス化された各パスは特定の scalar、array、または JSON object 型として扱われます。

そのパスに保存されている値に一致する cast type を選択してください。特定のインデックスタイプでどの cast type が使えるかを確認するには、互換性リファレンス を参照してください。

Cast typeパスの値が... の場合に使用値の例
BOOLBoolean 値true
DOUBLE数値99.99
VARCHAR文字列"electronics"
ARRAY_BOOLBoolean 値の配列[true, false]
ARRAY_DOUBLE数値の配列[1.2, 3.14]
ARRAY_VARCHAR文字列の配列["tag1", "tag2"]
JSONJSON object 全体または sub-object。object 全体の JSON インデックス作成は Milvus 3.0.0 から非推奨です。{"supplier": {"country": "USA"}}

同じパスにある値の型が一貫していない場合、cast type に一致する値だけがインデックス化されます。たとえば、metadata["price"] に 99.99 と "99.99" の両方が含まれている場合、DOUBLE cast type のインデックスには数値が含まれ、文字列値はスキップされます。インデックス作成中に文字列値を変換するには、json_cast_function を使用してください。詳しくは 例 5: インデックス作成時にデータ型を変換する を参照してください。

インデックスタイプを選ぶ​

cast type を選択したら、クエリパターンに応じてインデックスタイプを選択します。

クエリパターン推奨インデックスタイプcast type 要件注記
scalar 値に対する equality と range filter の混在AUTOINDEXBOOL、DOUBLE、または VARCHAR を使用します。値の cardinality に基づいて、Zilliz Cloud が内部インデックスレイアウトを選択します。
JSON array 内の値に対する filterINVERTEDARRAY_BOOL、ARRAY_DOUBLE、または ARRAY_VARCHAR を使用します。すべての array cast type で必須です。
object 全体または sub-object のインデックス作成（非推奨）INVERTED または AUTOINDEX（互換性のみ）JSON を使用します。互換性のためにサポートされています。新しいワークロードでは、パス固有のインデックスを作成するか、JSON Shredding を検討してください。
数値またはソート可能な文字列に対する range filterSTL_SORT または AUTOINDEXDOUBLE または VARCHAR を使用します。ソート済みレイアウトを強制するには STL_SORT、自動選択したい場合は AUTOINDEX を使用します。
低 cardinality 値に対する equality または IN filterBITMAP または AUTOINDEXBOOL または VARCHAR を使用します。bitmap レイアウトを強制するには BITMAP を使用します。数値には AUTOINDEX または STL_SORT を使用してください。

迷った場合は、scalar パスに対して AUTOINDEX から始めてください。array cast type と text-match クエリには明示的に INVERTED を使用してください。INVERTED または AUTOINDEX のいずれを使った object 全体の JSON インデックス作成も引き続きサポートされていますが、Milvus 3.0.0 から非推奨です。

AUTOINDEX​

AUTOINDEX の動作は、指定する json_cast_type に依存します。

Cast typeAUTOINDEX の動作
BOOL, DOUBLE, VARCHAR値の cardinality に基づいて BITMAP と STL_SORT のいずれかを選択します。
ARRAY_BOOL, ARRAY_DOUBLE, ARRAY_VARCHARサポートされていません。インデックスタイプとして明示的に INVERTED を使用してください。
JSONobject 全体または sub-object のインデックス作成に INVERTED を使用します。このモードは Milvus 3.0.0 から非推奨です。

scalar cast type（BOOL、DOUBLE、VARCHAR）に対しては、Zilliz Cloud に内部インデックスレイアウトを選ばせたい場合、AUTOINDEX が推奨される出発点です。インデックス作成中、Zilliz Cloud は JSON パスにある値の cardinality を測定します。cardinality とは、そのパスにある異なる値の数を意味します。

cardinality に基づいて、Zilliz Cloud は 2 つの内部レイアウトのうち 1 つを選択します。

  • 低 cardinality: metadata["in_stock"] の true と false、または小さな集合のステータス文字列を持つ metadata["status"] のように、値が頻繁に繰り返される場合です。Zilliz Cloud は、高速な equality および IN filter のために内部的に BITMAP index を構築します。

  • 高 cardinality: metadata["price"]、metadata["created_at"]、metadata["product_id"] のように、ほとんどの値が一意である場合です。Zilliz Cloud は、>、<、>=、<= のような高速な range filter のために内部的に STL_SORT index を構築します。

デフォルトの BITMAP と STL_SORT のしきい値は 100 個の異なる値 です。このしきい値は bitmap_cardinality_limit で調整できます。詳しくは AUTOINDEX の BITMAP-vs-STL_SORT しきい値を調整するにはどうすればよいですか? を参照してください。

INVERTED​

INVERTED は、text-match クエリまたは array のインデックス作成が必要な場合に最適です。また、非推奨となった object 全体の JSON インデックス作成でも引き続き利用できます。

次の場合は明示的に INVERTED を指定してください。

  • JSON array 内の値をインデックス化する必要がある場合。

  • object 全体または sub-object に対する既存のインデックスを維持しており、INVERTED の動作を明示したい場合。

  • equality、IN、range、text-match、および array クエリを処理できる 1 つのインデックスタイプが必要な場合。object 全体のサポートは互換性のために引き続き利用可能ですが、その代償としてインデックスサイズは大きくなります。

JSON object 全体に対する既存のインデックス（json_cast_type="JSON"）については、引き続き INVERTED または AUTOINDEX のいずれかを使用できます。この cast type では、AUTOINDEX は INVERTED を使用します。object 全体の JSON インデックス作成は、新しいワークロードにはもはや推奨されません。

詳細は、INVERTED を参照してください。

STL_SORT​

STL_SORT は JSON パスの値をソート順に保存します。これは、数値またはソート可能な文字列値に対する range filter に最適化されています。

STL_SORT は DOUBLE と VARCHAR cast type のみをサポートします。次の場合に使用してください。

  • filter で >、<、>=、または <= を使う場合。

  • インデックス化された値の cardinality が高い場合。たとえば価格、タイムスタンプ、ID、またはソート可能なコードなどです。

  • AUTOINDEX に選ばせるのではなく、ソート済みレイアウトを強制したい場合。

STL_SORT は BOOL、ARRAY_*、または JSON cast type をサポートしません。array には INVERTED を使用してください。既存の object 全体のインデックスでは引き続き INVERTED または AUTOINDEX を使用できますが、object 全体の JSON インデックス作成は非推奨です。

詳細は、STL_SORT を参照してください。

BITMAP​

BITMAP は、JSON パス上の個々の異なる値に対してコンパクトな bitmap を作成します。これは、頻繁に繰り返される値に対する equality および IN filter に最適化されています。

BITMAP は BOOL と VARCHAR cast type のみをサポートします。次の場合に使用してください。

  • filter で == または IN を使用する場合。

  • インデックス化された値の cardinality が低い場合。たとえば boolean、ステータス値、または少数のカテゴリなどです。

  • AUTOINDEX に選ばせるのではなく、bitmap レイアウトを強制したい場合。

BITMAP は DOUBLE、ARRAY_*、または JSON cast type をサポートしません。数値には、代わりに AUTOINDEX、STL_SORT、または INVERTED を使用してください。

詳細は、BITMAP を参照してください。

互換性リファレンス​

サポートされている (cast type, index type) の組み合わせを素早く確認するには、次のマトリクスを使用してください。

Cast type説明値の例AUTOINDEXINVERTEDSTL_SORTBITMAP
BOOLBoolean 値（true/false）。true—
DOUBLE数値（整数または浮動小数点）。99.99—
VARCHAR文字列値。"electronics"
ARRAY_BOOLBoolean の配列。[true, false]———
ARRAY_DOUBLE数値の配列。[1.2, 3.14]———
ARRAY_VARCHAR文字列の配列。["tag1", "tag2"]———
JSON自動型推論と flattening を伴う JSON object 全体または sub-object。Milvus 3.0.0 から非推奨です。任意のネストされた objectYes (deprecated)Yes (deprecated)——

— とマークされたセルでは、Zilliz Cloud はインデックス作成時にリクエストを拒否します。array cast type には、明示的に INVERTED を使用してください（AUTOINDEX は array を対象にしません）。

JSON インデックスを作成する​

このセクションでは、さまざまな形状の JSON データをインデックス化する方法を説明します。すべての例では、以下のサンプル構造を使用し、metadata という名前の JSON フィールドを含む collection がすでに存在している前提です。

サンプル JSON 構造​

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"
      }
    }
  }
}

基本セットアップ​

以下の例では、Zilliz Cloud デプロイメントに接続された client という名前の MilvusClient と、metadata という名前の JSON フィールドをすでに含む collection があることを前提としています。これらを最初からセットアップする必要がある場合は、以下のブロックを展開してください。

接続してサンプル collection を作成する
python
from pymilvus import DataType, MilvusClient

client = MilvusClient(uri="YOUR_CLUSTER_ENDPOINT")

# Define a schema with a JSON field
schema = client.create_schema(enable_dynamic_field=False)
schema.add_field("pk", DataType.INT64, is_primary=True, auto_id=False)
schema.add_field("vec", DataType.FLOAT_VECTOR, dim=4)
schema.add_field("metadata", DataType.JSON, nullable=True)

# Minimal vector index so the collection can be loaded
vec_index = client.prepare_index_params()
vec_index.add_index(field_name="vec", index_type="AUTOINDEX", metric_type="L2")

client.create_collection(
    collection_name="your_collection_name",
    schema=schema,
    index_params=vec_index,
)

# Insert one row that matches the sample JSON structure above
client.insert(
    collection_name="your_collection_name",
    data=[{
        "pk": 1,
        "vec": [0.1, 0.2, 0.3, 0.4],
        "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"
                }
            }
        }
    }],
)

以下の例で追加するインデックス定義を集約するために、index-params object を準備します。

python
index_params = client.prepare_index_params()

以降の各例では、1 つの index_params.add_index(...) 呼び出しを示します。自分のデータに合うものを選んで、同じ index_params object に対して呼び出してください。その後、最後に 1 回の client.create_index(...) 呼び出しでまとめて適用します（「インデックスを適用する」を参照）。

例 1: AUTOINDEX でトップレベルキーをインデックス化する​

category フィールドをインデックス化して、製品カテゴリによる高速な filter を実現します。AUTOINDEX を使うと、データ内に異なるカテゴリがどれくらい存在するかに基づいて、Zilliz Cloud が BITMAP または STL_SORT を選択します。

python
index_params.add_index(
    field_name="metadata",
    index_type="AUTOINDEX",
    index_name="category_index",
    params={
        "json_path": 'metadata["category"]',
        "json_cast_type": "VARCHAR",
    }
)

例 2: ネストされたキーをインデックス化する​

サプライヤーの連絡先検索のために、深くネストされた email フィールドをインデックス化します。json_path パラメータは、任意の深さの bracket notation を受け付けます。

python
index_params.add_index(
    field_name="metadata",
    index_type="AUTOINDEX",
    index_name="email_index",
    params={
        "json_path": 'metadata["supplier"]["contact"]["email"]',
        "json_cast_type": "VARCHAR",
    }
)

例 3: STL_SORT を使った range クエリ​

あるパスに対するクエリの大半が range 比較（>、<、>=、<=）になると分かっている場合は、直接 STL_SORT を選択します。これにより cardinality の測定を省略し、即座にソート済みレイアウトを構築します。

python
index_params.add_index(
    field_name="metadata",
    index_type="STL_SORT",
    index_name="price_index",
    params={
        "json_path": 'metadata["price"]',
        "json_cast_type": "DOUBLE",
    }
)

インデックス作成後、metadata["price"] > 50 AND metadata["price"] < 100 のような range クエリでは、全スキャンではなく二分探索が使用されます。

例 4: BITMAP を使った equality クエリ​

低 cardinality のキー、つまり status code、boolean、enum のような文字列には、直接 BITMAP を選択してください。equality クエリおよび IN クエリは bitmap 演算になります。

python
index_params.add_index(
    field_name="metadata",
    index_type="BITMAP",
    index_name="in_stock_index",
    params={
        "json_path": 'metadata["in_stock"]',
        "json_cast_type": "BOOL",
    }
)

BITMAP は、少数の異なる文字列値だけを持つ status column のようなフィールドにも非常に適しています。

例 5: インデックス作成時にデータ型を変換する​

数値データが誤って文字列として保存されている場合は、STRING_TO_DOUBLE を使用して、インデックス作成中に値を数値へ変換します。

python
index_params.add_index(
    field_name="metadata",
    index_type="AUTOINDEX",
    index_name="string_to_double_index",
    params={
        "json_path": 'metadata["string_price"]',
        "json_cast_type": "DOUBLE",
        "json_cast_function": "STRING_TO_DOUBLE",
    }
)

行ごとの変換に失敗した場合（たとえば "invalid" のような非数値文字列）、その行はインデックス作成時にスキップされます。

例 6: JSON object 全体をインデックス化する​

🚧警告

Milvus 3.0.0 以降、object 全体の JSON インデックス作成（json_cast_type="JSON"）、別名 JSON flat indexing は非推奨です。既存のインデックスおよび新しいインデックス作成リクエストは互換性のために引き続きサポートされますが、このモードは新しいワークロードには推奨されなくなりました。既知のクエリパスに対して JSON パスインデックスを作成してください。広範なクエリパターンを持つ複雑または変化しやすい JSON ドキュメントには、JSON Shredding を検討してください。JSON shredding は array 内の値を高速化しません。そうしたクエリには、array cast type を使った JSON パスインデックスを使用してください。

互換性のために既存ワークロードで使用する場合、json_cast_type="JSON" を設定すると、指定したパスにある完全な構造をインデックス化します。Zilliz Cloud はネストされた object をパスに flatten し、各値の型を自動的に推論します。そのパス配下のすべてのキーが検索可能になります。

AUTOINDEX は、flattening と型推論が inverted-index の機能であるため、JSON cast type に対して透過的に INVERTED を使用します。

metadata object 全体をインデックス化する例:

python
index_params.add_index(
    field_name="metadata",
    index_type="AUTOINDEX",
    index_name="metadata_full_index",
    params={
        "json_path": "metadata",
        "json_cast_type": "JSON",
    }
)

または、sub-object をインデックス化します。たとえば、すべての supplier 情報です。

python
index_params.add_index(
    field_name="metadata",
    index_type="AUTOINDEX",
    index_name="supplier_index",
    params={
        "json_path": 'metadata["supplier"]',
        "json_cast_type": "JSON",
    }
)

object 全体をインデックス化すると、インデックスサイズが増加します。深くネストされたドキュメントと多様なクエリパターンを持つ新しいワークロードでは、パス固有のインデックスを使用するか、JSON Shredding を検討してください。

インデックスを適用する​

すべてのインデックスパラメータを追加したら、それらを collection に適用します。

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

インデックスのビルドは非同期で実行されます。特定のインデックスのビルド状態を確認するには client.describe_index(...) を使用します。ビルドが完了すると state フィールドは Finished を示し、途中経過は total_rows / indexed_rows / pending_index_rows で確認できます。

python
client.describe_index(
    collection_name="your_collection_name",
    index_name="category_index",
)

レスポンス例:

json
{
  "json_path": "metadata[\"category\"]",
  "json_cast_type": "VARCHAR",
  "index_type": "AUTOINDEX",
  "field_name": "metadata",
  "index_name": "category_index",
  "total_rows": 20,
  "indexed_rows": 20,
  "pending_index_rows": 0,
  "state": "Finished"
}

state が Finished を返したら、インデックス対象パスに対するクエリは自動的に新しいインデックスを使用します。

AUTOINDEX エントリについては、このレスポンス内の index_type フィールドは AUTOINDEX として報告されます。Zilliz Cloud は現在、ビルド時にどの基盤レイアウト（BITMAP または STL_SORT）が選ばれたかを公開していません。この選択は内部最適化として扱ってください。どのレイアウトが選ばれた場合でも、そのパスに対する等価、IN、および範囲クエリは機能します。

FAQ​

AUTOINDEX と明示的なインデックスタイプはどう選べばよいですか？​

まずは AUTOINDEX から始めてください。これはデータの cardinality に基づいて適切なレイアウトを選択し、JSON パスに対するほとんどの等価、IN、および範囲クエリをカバーします。明示的なタイプを選ぶのは、次のような場合です。

  • クエリパターンがわかっている場合（例: 常に範囲クエリ → STL_SORT、低 cardinality に対する等価クエリのみ → BITMAP）で、cardinality の測定を省略したい。

  • テキスト一致または部分文字列クエリが必要な場合 → INVERTED。

  • 配列の cast type に対してインデックスを作成する場合。明示的に INVERTED を使用してください。

  • 既存の JSON オブジェクト全体に対するインデックスを維持している場合。互換性のため INVERTED と AUTOINDEX はどちらも引き続きサポートされますが、JSON オブジェクト全体へのインデックス作成は Milvus 3.0.0 以降で非推奨です。

クエリの filter expression が、インデックス化された cast type と異なる型を使っている場合はどうなりますか？​

filter expression がインデックスの json_cast_type と異なる型を使用している場合、Zilliz Cloud はそのインデックスを使用せず、データ上許可される場合はより低速な総当たりスキャンにフォールバックすることがあります。最良のパフォーマンスを得るには、常に filter expression をインデックスの cast type に合わせてください。たとえば、json_cast_type="DOUBLE" で数値インデックスを作成した場合、インデックスを活用できるのは数値の filter 条件だけです。

JSON キーが異なる entity 間で一貫しないデータ型を持つ場合はどうなりますか？​

型の不一致は 部分的なインデックス作成 につながる可能性があります。たとえば、metadata["price"] が数値（99.99）と文字列（"99.99"）の両方で保存されていて、json_cast_type="DOUBLE" でインデックスを作成した場合、インデックス化されるのは数値だけです。文字列形式のエントリはスキップされ、filter 結果には現れません。インデックス作成時に文字列を数値へ強制変換するには json_cast_function="STRING_TO_DOUBLE" を使用するか、すべてのエントリが同じ型を共有するようにソースデータを修正してください。

同じ JSON キーに複数のインデックスを作成できますか？​

いいえ。Zilliz Cloud では、cast type やインデックスタイプに関係なく、(field, json_path) の組ごとに作成できるインデックスは最大 1 つです。同じパスに INVERTED と BITMAP の両方を作成したり、異なる cast type で同じパスに 2 つのインデックスを作成したりすることはできません。ただし、JSON オブジェクト全体に対するインデックスと、そのオブジェクト内のネストされたキーに対する別のインデックスを作成することはできます。これらは異なるパスだからです。

AUTOINDEX の BITMAP と STL_SORT のしきい値はどう調整すればよいですか？​

デフォルトでは、AUTOINDEX はインデックス対象の値が 100 個以下の distinct values を持つ場合に BITMAP を選び、それ以外の場合は STL_SORT を選びます。このしきい値は、インデックスパラメータに "bitmap_cardinality_limit" を追加することで上書きできます（範囲: 1–1000）。

python
index_params.add_index(
    field_name="metadata",
    index_type="AUTOINDEX",
    index_name="string_to_double_index",
    params={
    "json_path": 'metadata["category"]',
    "json_cast_type": "VARCHAR",
    "bitmap_cardinality_limit": 200,  # use BITMAP up to 200 distinct values
    }
)

ほとんどのユーザーはこれを調整する必要はありません。中程度の cardinality を持つ field に対してビットマップ方式を優先したい場合は値を上げてください。AUTOINDEX をより早く STL_SORT に寄せたい場合は値を下げてください。INVERTED、STL_SORT、または BITMAP を明示的に指定した場合、この設定は無視されます。

Ctrl I