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

テキストマッチ

Zilliz Cloud のテキストマッチは、特定の用語に基づいてドキュメントを正確に取得できます。この機能は主に、特定の条件を満たすためのフィルタ付き検索に使用され、scalar filtering を組み込んでクエリ結果を絞り込むことができます。これにより、scalar 条件を満たす vectors 内で類似検索を実行できます。

📘注意

テキストマッチは、一致したドキュメントの関連性にスコアを付けることなく、クエリ用語の正確な出現箇所を見つけることに重点を置いています。クエリ用語の意味的な内容や重要性に基づいて最も関連性の高いドキュメントを取得したい場合は、Full Text Search の使用をおすすめします。

Zilliz Cloud では、プログラムまたは Web コンソールからテキストマッチを有効にできます。このページでは、プログラムでテキストマッチを有効にする方法に重点を置いて説明します。Web コンソールでの操作の詳細については、Manage Collections (Console) を参照してください。

概要​

Zilliz Cloud は、基盤となる inverted index および用語ベースのテキスト検索を実現するために Tantivy を統合しています。各テキストエントリについて、Zilliz Cloud は次の手順に従ってインデックス化を行います。

  1. Analyzer: analyzer は入力テキストを個々の単語、つまり tokens に分割し、必要に応じてフィルタを適用します。これにより、Zilliz Cloud はこれらの tokens に基づいてインデックスを構築できます。

  2. Indexing: テキスト解析後、Zilliz Cloud は各一意の token を、その token を含むドキュメントに対応付ける inverted index を作成します。

ユーザーがテキストマッチを実行すると、inverted index を使用して、用語を含むすべてのドキュメントをすばやく取得します。これは各ドキュメントを個別に走査するよりもはるかに高速です。

N43zw7HuGhmCHRbYDDmctO1bnkd

テキストマッチを有効にする​

テキストマッチは VARCHAR フィールド型で動作します。これは Zilliz Cloud における文字列データ型に相当します。テキストマッチを有効にするには、collection schema を定義する際に enable_analyzer と enable_match の両方を True に設定し、必要に応じてテキスト解析用の analyzer を構成します。

enable_analyzer と enable_match を設定する​

特定の VARCHAR フィールドでテキストマッチを有効にするには、フィールド schema を定義するときに enable_analyzer と enable_match の両方のパラメータを True に設定します。これにより、Zilliz Cloud は指定されたフィールドのテキストを token 化して inverted index を作成し、高速で効率的なテキストマッチを可能にします。

python
from pymilvus import MilvusClient, DataType

schema = MilvusClient.create_schema(enable_dynamic_field=False)
schema.add_field(
    field_name="id",
    datatype=DataType.INT64,
    is_primary=True,
    auto_id=True
)
schema.add_field(
    field_name='text', 
    datatype=DataType.VARCHAR, 
    max_length=1000, 
    enable_analyzer=True, # Whether to enable text analysis for this field
    enable_match=True # Whether to enable text match
)
schema.add_field(
    field_name="embeddings",
    datatype=DataType.FLOAT_VECTOR,
    dim=5
)

オプション: analyzer を構成する​

キーワードマッチングの性能と精度は、選択した analyzer に依存します。analyzer は言語やテキスト構造に応じてそれぞれ最適化されているため、適切なものを選ぶことで、特定のユースケースにおける検索結果に大きな影響を与える可能性があります。

デフォルトでは、Zilliz Cloud は standard analyzer を使用します。これは空白文字と句読点に基づいてテキストを token 化し、40 文字を超える tokens を削除し、テキストを小文字に変換します。このデフォルト設定を適用するために追加のパラメータは必要ありません。詳細については、Standard を参照してください。

別の analyzer が必要な場合は、analyzer_params パラメータを使用して構成できます。たとえば、英語テキストの処理に english analyzer を適用するには、次のようにします。

python
analyzer_params = {
    "type": "english"
}
schema.add_field(
    field_name='text',
    datatype=DataType.VARCHAR,
    max_length=200,
    enable_analyzer=True,
    analyzer_params = analyzer_params,
    enable_match = True,
)

Zilliz Cloud は、さまざまな言語やシナリオに適した他の analyzer も多数提供しています。詳細については、Analyzer Overview を参照してください。

テキストマッチを使用する​

collection schema 内の VARCHAR フィールドでテキストマッチを有効にすると、TEXT_MATCH 式を使用してテキストマッチを実行できます。

TEXT_MATCH 式の構文​

TEXT_MATCH 式は、検索対象のフィールドと検索する用語を指定するために使用されます。その構文は次のとおりです。

python
TEXT_MATCH(field_name, text)

  • field_name: 検索対象の VARCHAR フィールド名。

  • text: 検索する用語。複数の用語は、言語や構成された analyzer に応じて、スペースまたはその他の適切な区切り文字で区切ることができます。

デフォルトでは、TEXT_MATCH は OR マッチングロジックを使用します。つまり、指定された用語のいずれかを含むドキュメントを返します。たとえば、text フィールド内で machine または deep を含むドキュメントを検索するには、次の式を使用します。

python
filter = "TEXT_MATCH(text, 'machine deep')"

複数の TEXT_MATCH 式を論理演算子で組み合わせて、AND マッチングを実行することもできます。

  • text フィールド内で machine と deep の両方を含むドキュメントを検索するには、次の式を使用します。

    python
    filter = "TEXT_MATCH(text, 'machine') and TEXT_MATCH(text, 'deep')"

  • text フィールド内で machine と learning の両方を含み、deep は含まないドキュメントを検索するには、次の式を使用します。

    python
    filter = "not TEXT_MATCH(text, 'deep') and TEXT_MATCH(text, 'machine') and TEXT_MATCH(text, 'learning')"

テキストマッチ付きで検索する​

テキストマッチは、ベクトル類似検索と組み合わせて使用することで、検索範囲を絞り込み、検索パフォーマンスを向上させることができます。ベクトル類似検索の前にテキストマッチで collection をフィルタリングすることで、検索対象となるドキュメント数を減らし、クエリ時間を短縮できます。

この例では、filter 式によって検索結果が、指定された keyword1 または keyword2 に一致するドキュメントのみに絞り込まれます。その後、この絞り込まれたドキュメント集合に対してベクトル類似検索が実行されます。

python
# Match entities with `keyword1` or `keyword2`
filter = "TEXT_MATCH(text, 'keyword1 keyword2')"

# Assuming 'embeddings' is the vector field and 'text' is the VARCHAR field
result = client.search(
    collection_name="my_collection", # Your collection name
    anns_field="embeddings", # Vector field name
    data=[query_vector], # Query vector
    filter=filter,
    search_params={"params": {"nprobe": 10}},
    limit=10, # Max. number of results to return
    output_fields=["id", "text"] # Fields to return
)

テキストマッチを使用したクエリ​

テキストマッチは、query 操作における scalar フィルタリングにも使用できます。query() メソッドの expr パラメータに TEXT_MATCH 式を指定することで、指定した用語に一致するドキュメントを取得できます。

以下の例では、text フィールドに keyword1 と keyword2 の両方の用語を含むドキュメントを取得します。

python
# Match entities with both `keyword1` and `keyword2`
filter = "TEXT_MATCH(text, 'keyword1') and TEXT_MATCH(text, 'keyword2')"

result = client.query(
    collection_name="my_collection",
    filter=filter, 
    output_fields=["id", "text"]
)

注意事項​

  • フィールドに対して用語マッチを有効にすると、反転 index の作成がトリガーされ、ストレージリソースを消費します。この機能を有効にするかどうかを判断する際は、ストレージへの影響を考慮してください。影響は、テキストサイズ、一意のトークン数、使用する analyzer によって異なります。

  • schema で analyzer を定義すると、その設定はその collection に対して永続的になります。別の analyzer の方がニーズに適していると判断した場合は、既存の collection を削除し、目的の analyzer 設定で新しい collection を作成することを検討してください。

  • フレーズマッチのパフォーマンスは、テキストがどのようにトークン化されるかに依存します。analyzer を collection 全体に適用する前に、run_analyzer メソッドを使用してトークン化の出力を確認してください。詳細については、Analyzer 概要 を参照してください。

  • filter 式におけるエスケープルール:

    • 式内でダブルクォートまたはシングルクォートで囲まれた文字は、文字列定数として解釈されます。文字列定数にエスケープ文字が含まれる場合、エスケープ文字はエスケープシーケンスで表現する必要があります。たとえば、\ は \\、タブ \t は \\t、改行は \\n を使用して表現します。

    • 文字列定数がシングルクォートで囲まれている場合、定数内のシングルクォートは \\' で表現する必要があります。一方、ダブルクォートは " または \\" のいずれでも表現できます。例: 'It\\'s milvus'。

    • 文字列定数がダブルクォートで囲まれている場合、定数内のダブルクォートは \\" で表現する必要があります。一方、シングルクォートは ' または \\' のいずれでも表現できます。例: "He said \\"Hi\\""。

Ctrl I