メインコンテンツまでスキップ
バージョン: User Guides (Cloud)

クエリ

Zilliz Cloudは、ANN検索に加えて、クエリによるメタデータフィルタリングもサポートしています。このページでは、Query、Get、およびQueryIteratorを使用してメタデータフィルタリングを実行する方法について説明します。

概要​

Collectionは、さまざまなタイプのスカラーフィールドを保存できます。Zilliz Cloudに1つ以上のスカラーフィールドに基づいてエンティティをフィルタリングさせることができます。Zilliz Cloudは、Query、Get、およびQueryIteratorの3種類のクエリを提供します。以下の表は、これら3つのクエリタイプを比較したものです。

Get

Query

QueryIterator

適用可能なシナリオ

指定された主キーを持つエンティティを検索する場合。

カスタムフィルタリング条件を満たすすべてのエンティティ、または指定された数のエンティティを検索する場合

ページネーションクエリでカスタムフィルタリング条件を満たすすべてのエンティティを検索する場合。

フィルタリング方法

主キーによる

フィルタリング式による

フィルタリング式による

必須パラメータ

  • コレクション名

  • 主キー

  • コレクション名

  • フィルタリング式

  • コレクション名

  • フィルタリング式

  • クエリごとに返されるエンティティの数

オプションパラメータ

  • パーティション名

  • 出力フィールド

  • パーティション名

  • 返されるエンティティの数

  • 出力フィールド

  • パーティション名

  • 合計で返されるエンティティの数

  • 出力フィールド

戻り値

指定されたコレクションまたはパーティションで、指定された主キーを持つエンティティを返します。

指定されたコレクションまたはパーティションで、カスタムフィルタリング条件を満たすすべてのエンティティ、または指定された数のエンティティを返します。

ページネーションクエリを通じて、指定されたコレクションまたはパーティションでカスタムフィルタリング条件を満たすすべてのエンティティを返します。

メタデータフィルタリングの詳細については、フィルタリングとフィルタリングの説明を参照してください。

Getを使用する​

主キーでエンティティを検索する必要がある場合は、Getメソッドを使用できます。以下のコード例では、コレクションにid、vector、colorという3つのフィールドがあることを前提としています。

[
        {"id": 0, "vector": [0.3580376395471989, -0.6023495712049978, 0.18414012509913835, -0.26286205330961354, 0.9029438446296592], "color": "pink_8682"},
        {"id": 1, "vector": [0.19886812562848388, 0.06023560599112088, 0.6976963061752597, 0.2614474506242501, 0.838729485096104], "color": "red_7025"},
        {"id": 2, "vector": [0.43742130801983836, -0.5597502546264526, 0.6457887650909682, 0.7894058910881185, 0.20785793220625592], "color": "orange_6781"},
        {"id": 3, "vector": [0.3172005263489739, 0.9719044792798428, -0.36981146090600725, -0.4860894583077995, 0.95791889146345], "color": "pink_9298"},
        {"id": 4, "vector": [0.4452349528804562, -0.8757026943054742, 0.8220779437047674, 0.46406290649483184, 0.30337481143159106], "color": "red_4794"},
        {"id": 5, "vector": [0.985825131989184, -0.8144651566660419, 0.6299267002202009, 0.1206906911183383, -0.1446277761879955], "color": "yellow_4222"},
        {"id": 6, "vector": [0.8371977790571115, -0.015764369584852833, -0.31062937026679327, -0.562666951622192, -0.8984947637863987], "color": "red_9392"},
        {"id": 7, "vector": [-0.33445148015177995, -0.2567135004164067, 0.8987539745369246, 0.9402995886420709, 0.5378064918413052], "color": "grey_8510"},
        {"id": 8, "vector": [0.39524717779832685, 0.4000257286739164, -0.5890507376891594, -0.8650502298996872, -0.6140360785406336], "color": "white_9381"},
        {"id": 9, "vector": [0.5718280481994695, 0.24070317428066512, -0.3737913482606834, -0.06726932177492717, -0.6980531615588608], "color": "purple_4976"},
]

エンティティは、そのIDで取得できます。

from pymilvus import MilvusClient

client = MilvusClient(
    uri="YOUR_CLUSTER_ENDPOINT",
    token="YOUR_CLUSTER_TOKEN"
)

res = client.get(
    collection_name="my_collection",
    ids=[0, 1, 2],
    output_fields=["vector", "color"]
)

print(res)

クエリの使用方法​

カスタムフィルタリング条件でエンティティを検索する必要がある場合は、Query メソッドを使用します。以下のコード例では、id、vector、color という3つのフィールドがあり、color の値が red で始まる指定された数のエンティティを返します。

from pymilvus import MilvusClient

client = MilvusClient(
    uri="YOUR_CLUSTER_ENDPOINT",
    token="YOUR_CLUSTER_TOKEN"
)

res = client.query(
    collection_name="my_collection",
    filter="color like \"red%\"",
    output_fields=["vector", "color"],
    limit=3
)

QueryIterator の使用方法​

ページ分割されたクエリによってカスタムフィルタリング条件でエンティティを検索する必要がある場合は、QueryIterator を作成し、その next() メソッドを使用してすべてのエンティティを反復処理し、フィルタリング条件を満たすエンティティを見つけます。以下のコード例では、id、vector、color という名前の3つのフィールドがあり、color の値が red で始まるすべてのエンティティを返します。

iterator = client.query_iterator(
    "my_collection",
    batch_size=10,
    filter="color like \"red%\"",
    output_fields=["color"]
)

results = []

while True:
    result = iterator.next()
    if not result:
        iterator.close()
        break

    print(result)
    results += result

パーティション内のクエリ​

Get、Query、または QueryIterator リクエストにパーティション名を含めることで、1つまたは複数のパーティション内でクエリを実行することもできます。以下のコード例では、コレクション内にPartitionAという名前のパーティションがあることを前提としています。

res = client.get(
    collection_name="my_collection",
    partitionNames=["partitionA"],
    ids=[10, 11, 12],
    output_fields=["vector", "color"]
)

res = client.query(
    collection_name="my_collection",
    partitionNames=["partitionA"],
    filter="color like \"red%\"",
    output_fields=["vector", "color"],
    limit=3
)

# Use QueryIterator
iterator = client.query_iterator(
    "my_collection",
    partition_names=["partitionA"],
    batch_size=10,
    filter="color like \"red%\"",
    output_fields=["color"]
)

results = []
while True:
    result = iterator.next()
    if not result:
        iterator.close()
        break

    print(result)
    results += result

クエリによるランダムサンプリング​

データ探索や開発テストのために、コレクションからデータの代表的なサブセットを抽出するには、RANDOM_SAMPLE(sampling_factor) 式を使用します。ここで、sampling_factor は、サンプリングするデータの割合を表す 0 から 1 の間の浮動小数点数です。

📘Notes

詳細な使用方法、高度な例、およびベストプラクティスについては、ランダムサンプリングを参照してください。

# Sample 1% of the entire collection
res = client.query(
    collection_name="my_collection",
    filter="RANDOM_SAMPLE(0.01)",
    output_fields=["vector", "color"]
)

print(f"Sampled {len(res)} entities from collection")

# Combine with other filters - first filter, then sample
res = client.query(
    collection_name="my_collection", 
    filter="color like \"red%\" AND RANDOM_SAMPLE(0.005)",
    output_fields=["vector", "color"],
    limit=10
)

print(f"Found {len(res)} red items in sample")

クエリのタイムゾーンを一時的に設定する​

コレクションにTIMESTAMPTZフィールドがある場合、クエリ呼び出しでtimezoneパラメータを設定することで、単一の操作に対してデータベースまたはコレクションのデフォルトタイムゾーンを一時的に上書きできます。これにより、操作中にTIMESTAMPTZ値が表示および比較される方法が制御されます。

timezoneの値は、有効なIANAタイムゾーン識別子である必要があります（例：Asia/Shanghai、America/Chicago、またはUTC）。TIMESTAMPTZフィールドの使用方法の詳細については、TIMESTAMPTZフィールドを参照してください。

以下の例は、クエリ操作のタイムゾーンを一時的に設定する方法を示しています。

# Query data and display the tsz field converted to "America/Havana"
results = client.query(
    "my_collection",
    filter="id <= 10",
    output_fields=["id", "tsz", "vec"],
    limit=2,
    timezone="America/Havana",
)