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

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 つの内部レイアウトのいずれかを選択します。

  • 低カーディナリティ: metadata["in_stock"] の true と false、または少数のステータス文字列を持つ 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"
                }
            }
        }
    }],
)

以下の例で追加するインデックス定義を収集するためのインデックスパラメーターオブジェクトを準備します。

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 インデックス（json_cast_type="JSON"）は非推奨です。既存のインデックスと新しいインデックス作成リクエストは互換性のために引き続きサポートされていますが、このモードは新しいワークロードには推奨されなくなりました。既知のクエリパスには JSON パスインデックスを作成してください。広範なクエリパターンを持つ複雑または進化する JSON ドキュメントでは、JSON Shredding を検討してください。JSON Shredding は配列内の値を高速化しません。これらのクエリには、配列キャストタイプを指定した JSON パスインデックスを使用してください。

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

AUTOINDEX は JSON キャストタイプに対して透過的に 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 オブジェクト全体に 1 つのインデックスを作成し、そのオブジェクト内のネストされたキーに別のインデックスを作成することはできます。これらは異なるパスです。

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