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

StructArray によるグループ検索

このページでは、StructArray の要素レベルの検索結果を親エンティティごとにグループ化する方法について説明します。複数の Struct 要素がクエリに一致すると、要素レベルの検索で同じエンティティから複数のヒットが返されることがあります。グループ化すると、それらの要素ヒットがまとめられ、各親エンティティは最大 1 回だけ表示されます。

このページでは、StructArray フィールドを作成する で作成した tech_articles コレクションを使用します。コレクションには chunks という名前の StructArray フィールドがあります。chunks[emb] ベクトルサブフィールドは、通常のベクトルメトリクスを使用した要素レベルの検索用にインデックス付けされています。

StructArray におけるグループ化の適用​

検索モードグループ化の動作結果の動作
EmbeddingList 検索サポートされていません。該当しません。
要素レベルの検索プライマリキーによるグループ化でサポートされます。親エンティティごとに最大 1 件の結果を返します。要素レベルのメタデータは保持されるため、API または SDK によって公開されている場合は、選択された要素のインデックスまたはオフセットを返すことができます。
ハイブリッド検索すべてのサブ検索が同じ StructArray フィールド配下の要素レベルのベクトルフィールドを対象とする場合にのみサポートされます。要素レベルのサブ検索は、最終的な結果処理の前にプライマリキーでグループ化されます。
Notes

グループ化されていない要素レベルの検索で重複する親エンティティが多すぎる場合は、グループ化を使用します。一致する各 Struct 要素を個別のヒットとして取得する場合は、group_by_field を指定せずに StructArray による基本ベクトル検索 を使用します。

事前準備​

グループ検索を実行する前に、コレクション、データ、インデックスを準備してください。

要件詳細
要素レベルのベクトルサブフィールドchunks[emb] など、通常のベクトルメトリクスでインデックス付けされた StructArray のベクトルサブフィールドを使用します。
通常のベクトルクエリEmbeddingList ではなく、通常のクエリベクトルを使用します。
プライマリキーによるグループ化コレクションのプライマリキーを、doc_id などの group_by_field として使用します。
範囲パラメーターを使用しないグループ検索を、radius や range_filter などの範囲検索パラメーターと組み合わせないでください。

インデックスの設定については、StructArray フィールドのインデックスを作成する を参照してください。

次の例では、まず個々のチャンクを検索し、その後、要素ヒットを親エンティティのプライマリキーでグループ化します。

python
from pymilvus import MilvusClient

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

query_vector = [0.19, 0.24, 0.30, 0.37]

results = client.search(
collection_name="tech_articles",
data=[query_vector],
anns_field="chunks[emb]",
limit=5,
group_by_field="doc_id",
output_fields=[
"doc_id",
"title",
"chunks[text]",
"chunks[section]",
"chunks[page]",
"chunks[quality_score]",
],
)

for hits in results:
for hit in hits:
print(
"doc_id:", hit["doc_id"],
"distance:", hit["distance"],
"offset:", hit.get("offset"),
"entity:", hit["entity"],
)

グループ化しない場合、複数のチャンクがクエリに一致すると、同じ doc_id が複数回表示されることがあります。group_by_field="doc_id" を指定すると、各親エンティティは最大 1 回だけ表示されます。グループ化では要素レベルのメタデータが保持されるため、API または SDK が公開している場合は、グループ化された結果に選択された Struct 要素のインデックスまたはオフセットを含めることができます。

スカラーフィルターを追加する​

グループ検索を StructArray のスカラーフィルタリングと組み合わせることができます。スカラー条件によって、要素レベルのベクトル検索に参加する Struct 要素を制限する場合は、element_filter を使用します。

python
query_vector = [0.19, 0.24, 0.30, 0.37]

filter_expr = (
'category == "search" && '
'element_filter(chunks, '
'$[section] == "index" && '
'$[quality_score] > 0.9)'
)

results = client.search(
collection_name="tech_articles",
data=[query_vector],
anns_field="chunks[emb]",
filter=filter_expr,
limit=5,
group_by_field="doc_id",
output_fields=[
"doc_id",
"title",
"category",
"chunks[text]",
"chunks[section]",
"chunks[quality_score]",
],
)

最上位の述語は候補エンティティを選択します。element_filter 述語は、要素レベルのベクトル検索を一致する Struct 要素に制限します。その後、グループ化によって一致する要素ヒットがプライマリキーごとにまとめられます。

StructArray でのハイブリッドグループ化は要素レベルの機能です。すべてのサブ検索が同じ StructArray フィールド配下の要素レベルのベクトルフィールドを対象とする場合にのみサポートされます。グループ化された StructArray ハイブリッド検索では、EmbeddingList レベルのリクエストを使用しないでください。

次の例では、chunks StructArray フィールドに chunks[emb] と chunks[code_emb] という 2 つの要素レベルのベクトルサブフィールドがあり、両方とも通常のベクトルメトリクスでインデックス付けされていることを前提としています。

python
from pymilvus import AnnSearchRequest, RRFRanker

query_vector = [0.19, 0.24, 0.30, 0.37]
code_query_vector = [0.18, 0.23, 0.29, 0.36]

index_chunk_req = AnnSearchRequest(
data=[query_vector],
anns_field="chunks[emb]",
param={"metric_type": "COSINE", "params": {"efSearch": 64}},
limit=10,
expr='element_filter(chunks, $[section] == "index")',
)

code_chunk_req = AnnSearchRequest(
data=[code_query_vector],
anns_field="chunks[code_emb]",
param={"metric_type": "COSINE", "params": {"efSearch": 64}},
limit=10,
expr='element_filter(chunks, $[has_code] == true)',
)

results = client.hybrid_search(
collection_name="tech_articles",
reqs=[index_chunk_req, code_chunk_req],
ranker=RRFRanker(),
limit=5,
group_by_field="doc_id",
output_fields=[
"doc_id",
"title",
"chunks[text]",
"chunks[section]",
],
)

この例では、両方のサブリクエストが同じ StructArray フィールド chunks 配下の要素レベルのベクトルフィールドを対象としています。ハイブリッド検索で通常のベクトルフィールド、異なる StructArray フィールド、または EmbeddingList レベルのリクエストが混在している場合、要素レベルの group-by はサポートされません。

グループ化された結果を解釈する​

結果項目意味
idグループ化された親エンティティのプライマリキーです。
distance またはスコアその親エンティティに対して選択された Struct 要素のスコアまたは距離です。
offset返される場合の、選択された Struct 要素の 0 から始まる位置です。
重複するプライマリキープライマリキーでグループ化する場合、想定されません。
limitグループ化された親エンティティの結果に適用されます。

制限事項​

  • グループ検索は、要素レベルの StructArray ベクトル検索にのみ適用されます。EmbeddingList 検索および EmbeddingList レベルのハイブリッド検索は、group-by をサポートしていません。

  • group_by_field としてプライマリキーを使用します。StructArray の要素レベルのグループ化は、任意のスカラーフィールドに対する汎用的な group-by ではありません。

  • グループ検索を範囲検索と組み合わせないでください。

  • グループ検索には、EmbeddingList クエリまたは MAX_SIM* メトリクスを使用しないでください。

  • ハイブリッドグループ化は、すべてのサブ検索が同じ StructArray フィールド配下の要素レベルのベクトルフィールドを対象とする場合にのみサポートされます。

  • ハイブリッド検索で通常のベクトルフィールド、異なる StructArray フィールド、または EmbeddingList レベルのリクエストが混在している場合、ハイブリッドグループ化はサポートされません。

よくある間違い​

  • EmbeddingList 検索を目的とした chunks[emb_list_vector] でグループ化を使用する。

  • プライマリキー以外のスカラーフィールドでグループ化する。

  • 複数のフィールドでグループ化する。StructArray の要素レベルのグループ化は、プライマリキーによるグループ化のみをサポートしています。

  • グループ化された結果が一致するすべての Struct 要素を表すことを期待する。グループ化では、親エンティティごとに最大 1 件の結果が返されます。

  • グループ化された要素レベルの検索が EmbeddingList 形式の MAX_SIM* スコアを再計算すると想定する。グループ化は要素レベルのヒットをまとめるだけであり、スコアリングモデルを変更しません。

  • group_by_field を radius または range_filter と組み合わせる。

次のステップ​

  1. グループ化されていない要素レベルの検索について先に学ぶには、StructArray による基本ベクトル検索 を参照してください。

  2. グループ検索にスカラーフィルターを追加するには、StructArray によるフィルター検索 を参照してください。

  3. グループ化の代わりにスコアまたは距離の境界を使用するには、StructArray による範囲検索 を参照してください。

  4. StructArray 検索の制限を確認するには、StructArray の制限 を参照してください。