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

JSON インデックス作成

JSON フィールドは、Zilliz Cloud で構造化メタデータを柔軟に保存する方法を提供します。インデックスがない場合、JSON フィールドに対するクエリはコレクション全体のスキャンを必要とし、データセットの増加に伴って遅くなります。JSON インデックス作成では、JSON データ内の特定のパスにインデックスを作成するため、そのパスに対する等価、範囲、その他のフィルタークエリを高速に実行できます。

JSON インデックス作成は次のような場合に最適です。

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

  • 特定の JSON パスに対する等価、IN、範囲、テキスト一致クエリ

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

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

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

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

インデックスタイプを選択する前に、JSON パスに対するキャスト型を特定します。キャスト型は、Zilliz Cloud がそのパスの値をどのように解釈するか、および使用できるインデックスタイプを決定します。

キャスト型を理解する​

json_cast_type は、json_path の値を解釈してインデックスするために使用されるデータ型です。これはフィールドスキーマの型とは異なります。フィールドは引き続き JSON フィールドですが、インデックス対象の各パスは特定のスカラー、配列、または JSON オブジェクト型として扱われます。

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

キャスト型パスの値が次の場合に使用値の例
BOOLブール値true
DOUBLE数値99.99
VARCHAR文字列値"electronics"
ARRAY_BOOLブール値の配列[true, false]
ARRAY_DOUBLE数値の配列[1.2, 3.14]
ARRAY_VARCHAR文字列値の配列["tag1", "tag2"]
JSONJSON オブジェクト全体またはサブオブジェクト。オブジェクト全体の JSON インデックスは Milvus 3.0.0 以降で非推奨です。{"supplier": {"country": "USA"}}

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

インデックスタイプを選択する​

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

クエリパターン推奨されるインデックスタイプキャスト型の要件備考
スカラー値に対する等価フィルターと範囲フィルターの混在AUTOINDEXBOOL、DOUBLE、または VARCHAR を使用します。値のカーディナリティに基づいて、Zilliz Cloud が内部インデックスレイアウトを選択できるようにします。
JSON 配列内の値に対するフィルターINVERTEDARRAY_BOOL、ARRAY_DOUBLE、または ARRAY_VARCHAR を使用します。すべての配列キャスト型で必須です。
オブジェクト全体またはサブオブジェクトのインデックス（非推奨）INVERTED または AUTOINDEX（互換性のみ）JSON を使用します。互換性のためにサポートされています。新しいワークロードでは、パス固有のインデックスを作成するか、JSON Shredding を検討してください。
数値またはソート可能な文字列に対する範囲フィルターSTL_SORT または AUTOINDEXDOUBLE または VARCHAR を使用します。ソートされたレイアウトを強制するには STL_SORT を使用します。自動選択を行う場合は AUTOINDEX を使用します。
低カーディナリティ値に対する等価フィルターまたは IN フィルターBITMAP または AUTOINDEXBOOL または VARCHAR を使用します。ビットマップレイアウトを強制するには BITMAP を使用します。数値の場合は、AUTOINDEX または STL_SORT を使用します。

判断に迷う場合は、スカラーパスには AUTOINDEX から始めてください。配列キャスト型とテキスト一致クエリには INVERTED を明示的に使用します。INVERTED または AUTOINDEX を使用したオブジェクト全体の JSON インデックスは引き続きサポートされていますが、Milvus 3.0.0 以降で非推奨です。

AUTOINDEX​

AUTOINDEX の動作は、指定する json_cast_type によって異なります。

キャスト型AUTOINDEX の動作
BOOL、DOUBLE、VARCHAR値のカーディナリティに基づいて BITMAP と STL_SORT のいずれかを選択します。
ARRAY_BOOL、ARRAY_DOUBLE、ARRAY_VARCHARサポートされていません。インデックスタイプとして INVERTED を明示的に使用します。
JSONオブジェクト全体またはサブオブジェクトのインデックスに INVERTED を使用します。このモードは Milvus 3.0.0 以降で非推奨です。

スカラーキャスト型（BOOL、DOUBLE、VARCHAR）の場合、Zilliz Cloud に内部インデックスレイアウトを選択させたいときは、AUTOINDEX が出発点として推奨されます。インデックス構築中、Zilliz Cloud は JSON パスにある値のカーディナリティを測定します。カーディナリティとは、そのパスにある異なる値の数を意味します。

カーディナリティに基づいて、Zilliz Cloud は 2 つの内部レイアウトのいずれかを選択します。

  • 低カーディナリティ: 値が頻繁に繰り返される場合です。たとえば、true と false を持つ metadata["in_stock"]、または少数のステータス文字列を持つ metadata["status"] などです。Zilliz Cloud は、高速な等価フィルターと IN フィルターのために内部で BITMAP インデックスを構築します。

  • 高カーディナリティ: ほとんどの値が異なる場合です。たとえば、metadata["price"]、metadata["created_at"]、metadata["product_id"] などです。Zilliz Cloud は、>、<、>=、<= などの高速な範囲フィルターのために内部で STL_SORT インデックスを構築します。

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

INVERTED​

INVERTED は、テキスト一致クエリや配列のインデックスが必要な場合に最適です。非推奨のオブジェクト全体 JSON インデックスでも引き続き利用できます。

次の場合は INVERTED を明示的に指定します。

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

  • JSON オブジェクト全体またはサブオブジェクトに対する既存のインデックスを維持し、INVERTED の動作を明示したい場合。

  • 等価、IN、範囲、テキスト一致、配列のクエリを 1 つのインデックスタイプで処理したい場合。オブジェクト全体のサポートは互換性のために引き続き利用できますが、インデックスサイズが大きくなります。

JSON オブジェクト全体に対する既存のインデックス（json_cast_type="JSON"）では、INVERTED または AUTOINDEX のいずれかを引き続き使用できます。AUTOINDEX はこのキャスト型に INVERTED を使用します。オブジェクト全体の JSON インデックスは、新しいワークロードには推奨されなくなりました。

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

STL_SORT​

STL_SORT は、JSON パスの値をソートされた順序で保存します。数値またはソート可能な文字列値に対する範囲フィルターに最適化されています。

STL_SORT は DOUBLE と VARCHAR のキャスト型のみをサポートします。次の場合に使用します。

  • フィルターで >、<、>=、<= を使用して値を比較する場合。

  • インデックス対象の値のカーディナリティが高い場合。たとえば、価格、タイムスタンプ、ID、ソート可能なコードなどです。

  • AUTOINDEX に選択させるのではなく、ソートされたレイアウトを強制する場合。

STL_SORT は BOOL、ARRAY_*、JSON のキャスト型をサポートしません。配列には INVERTED を使用します。既存のオブジェクト全体インデックスは INVERTED または AUTOINDEX を引き続き使用できますが、オブジェクト全体の JSON インデックスは非推奨です。

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

BITMAP​

BITMAP は、JSON パスにある異なる値ごとにコンパクトなビットマップを作成します。頻繁に繰り返される値に対する等価フィルターと IN フィルターに最適化されています。

BITMAP は BOOL と VARCHAR のキャスト型のみをサポートします。次の場合に使用します。

  • フィルターで == または IN を使用する場合。

  • インデックス対象の値のカーディナリティが低い場合。たとえば、ブール値、ステータス値、少数のカテゴリなどです。

  • AUTOINDEX に選択させるのではなく、ビットマップレイアウトを強制する場合。

BITMAP は DOUBLE、ARRAY_*、JSON のキャスト型をサポートしません。数値の場合は、代わりに AUTOINDEX、STL_SORT、または INVERTED を使用します。

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

互換性リファレンス​

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

キャスト型説明値の例AUTOINDEXINVERTEDSTL_SORTBITMAP
BOOLブール値（true/false）。true—
DOUBLE数値（整数または浮動小数点数）。99.99—
VARCHAR文字列値。"electronics"
ARRAY_BOOLブール値の配列。[true, false]———
ARRAY_DOUBLE数値の配列。[1.2, 3.14]———
ARRAY_VARCHAR文字列の配列。["tag1", "tag2"]———
JSON自動的な型推論とフラット化を行う JSON オブジェクト全体またはサブオブジェクト。Milvus 3.0.0 以降で非推奨です。任意のネストされたオブジェクトはい（非推奨）はい（非推奨）——

— とマークされたセルでは、Zilliz Cloud はインデックス作成時にリクエストを拒否します。配列キャスト型の場合は、INVERTED を明示的に使用します（AUTOINDEX は配列をカバーしません）。

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

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

サンプルの 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 フィールドをすでに含むコレクションがあることを前提としています。これらを最初からセットアップする必要がある場合は、以下のブロックを展開してください。

接続してサンプルコレクションを作成する
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 オブジェクトを準備します。

python
index_params = client.prepare_index_params()

後続の各例では、1 つの index_params.add_index(...) 呼び出しを示します。データに合ったものを選び、同じ index_params オブジェクトに対して呼び出します。最後に、すべてを 1 回の client.create_index(...) 呼び出しで適用します（「インデックスを適用する」を参照）。

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

製品カテゴリによるフィルタリングを高速化するために、category フィールドをインデックスします。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 パラメーターは、任意の深さのブラケット記法を受け付けます。

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 による範囲クエリ​

あるパスに対するクエリが主に範囲比較（>、<、>=、<=）になると分かっている場合は、STL_SORT を直接選択します。これによりカーディナリティの測定が省略され、ソートされたレイアウトがすぐに構築されます。

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 のような範囲クエリは、フルスキャンではなく二分探索を使用します。

例 4: BITMAP による等価クエリ​

低カーディナリティのキー（ステータスコード、ブール値、列挙型のような文字列）には、BITMAP を直接選択します。等価クエリと IN クエリはビットマップ操作になります。

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 列のようなフィールドにも非常に適しています。

例 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 オブジェクト全体をインデックスする​

Warning

Milvus 3.0.0 以降、オブジェクト全体の JSON インデックス（json_cast_type="JSON"、JSON フラットインデックスとも呼ばれます）は非推奨です。既存のインデックスと新規のインデックス作成リクエストは互換性のために引き続きサポートされていますが、このモードは新しいワークロードには推奨されなくなりました。既知のクエリパスには JSON パスインデックスを作成してください。幅広いクエリパターンを持つ複雑または変化し続ける JSON ドキュメントでは、JSON Shredding を検討してください。JSON shredding は配列内の値を高速化しません。そのようなクエリには、配列キャスト型を指定した JSON パスインデックスを使用してください。

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

JSON キャスト型では、フラット化と型推論が転置インデックスの機能であるため、AUTOINDEX は透過的に INVERTED を使用します。

metadata オブジェクト全体をインデックスします。

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

または、サブオブジェクト（たとえば 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",
    }
)

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

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

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

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 から始めます。データのカーディナリティから適切なレイアウトを選択し、JSON パスに対するほとんどの等価、IN、範囲クエリをカバーします。次の場合は明示的なタイプを選択します。

  • クエリパターンが分かっており（例: 常に範囲 → STL_SORT、常に低カーディナリティの等価 → BITMAP）、カーディナリティの測定を省略したい場合。

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

  • 配列キャスト型をインデックスする場合。INVERTED を明示的に使用します。

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

クエリのフィルター式が、インデックスされたキャスト型とは異なる型を使用した場合はどうなりますか？​

フィルター式がインデックスの json_cast_type とは異なる型を使用した場合、Zilliz Cloud はそのインデックスを使用せず、データが許せばより低速なブルートフォーススキャンにフォールバックすることがあります。最高のパフォーマンスを得るには、フィルター式を常にインデックスのキャスト型に一致させてください。たとえば、json_cast_type="DOUBLE" で数値インデックスを作成した場合、数値のフィルター条件のみがインデックスを利用します。

JSON キーのデータ型がエンティティ間で一致しない場合はどうなりますか？​

型が一致しない場合、部分的なインデックスが発生することがあります。たとえば、metadata["price"] が数値（99.99）と文字列（"99.99"）の両方として保存されており、json_cast_type="DOUBLE" でインデックスを作成すると、数値のみがインデックスされます。文字列形式のエントリはスキップされ、フィルター結果に表示されません。インデックス作成時に文字列を数値へ変換するには json_cast_function="STRING_TO_DOUBLE" を使用するか、すべてのエントリが同じ型になるようにソースデータを修正してください。

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

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

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

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

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

ほとんどのユーザーはこれを調整する必要はありません。中程度のカーディナリティを持ち、ビットマップにしたいフィールドがある場合は値を大きくします。AUTOINDEX をより早く STL_SORT に寄せたい場合は値を小さくします。INVERTED、STL_SORT、または BITMAP を明示的に指定した場合、この設定は無視されます。

Ctrl I