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

フレーズマッチ

フレーズマッチを使用すると、クエリの用語を完全なフレーズとして含むドキュメントを検索できます。デフォルトでは、単語は同じ順序で直接隣り合って出現する必要があります。たとえば、"robotics machine learning" に対するクエリは、"…typical robotics machine learning models…" のようなテキストに一致します。ここでは、"robotics"、"machine"、"learning" の各単語が間に他の単語を挟まずに連続して出現しています。

ただし、実際のシナリオでは、厳密なフレーズマッチングは柔軟性に欠ける場合があります。"…machine learning models widely adopted in robotics…" のようなテキストに一致させたい場合があります。ここでは同じキーワードが含まれていますが、隣接しておらず、元の順序でもありません。これに対応するため、フレーズマッチは柔軟性を導入する slop パラメーターをサポートしています。slop の値は、フレーズ内の用語間に許容される位置のずれの数を定義します。たとえば、slop が 1 の場合、"machine learning" に対するクエリは、"...machine deep learning..." のようなテキストに一致します。この場合、1 つの単語（"deep"）が元の用語を分けています。

概要​

Tantivy 検索エンジンライブラリによって提供され、フレーズマッチはドキュメント内の単語の位置情報を分析して動作します。次の図はそのプロセスを示しています。

AFrdwVT8ChT11ibs9lpcuN7onZc

  1. ドキュメントのトークン化: Zilliz Cloud にドキュメントを挿入すると、アナライザーを使用してテキストがトークン（個々の単語または用語）に分割され、各トークンの位置情報が記録されます。たとえば、doc_1 は ["machine" (pos=0), "learning" (pos=1), "boosts" (pos=2), "efficiency" (pos=3)] にトークン化されます。アナライザーの詳細は、Analyzer Overview を参照してください。

  2. 転置インデックスの作成: Zilliz Cloud は転置インデックスを構築し、各トークンを、それが出現するドキュメントおよびそれらのドキュメント内のトークン位置にマッピングします。

  3. フレーズマッチング: フレーズクエリが実行されると、Zilliz Cloud は転置インデックスで各トークンを検索し、それらの位置を確認して、正しい順序と近接性で出現するかどうかを判定します。slop パラメーターは、一致するトークン間に許容される位置の最大数を制御します：

    • slop = 0 は、トークンが正確な順序で直ちに隣接して出現する必要があることを意味します（つまり、間に余分な単語はありません）。

      • この例では、doc_1（pos=0 の "machine"、pos=1 の "learning"）のみが完全に一致します。

    • slop = 2 は、一致するトークン間に最大 2 位置の柔軟性または並べ替えを許容します。

      • これにより、逆順（"learning machine"）またはトークン間の小さな間隔が許容されます。

      • その結果、doc_1、doc_2（pos=0 の "learning"、pos=1 の "machine"）、および doc_3（pos=1 の "learning"、pos=2 の "machine"）がすべて一致します。

フレーズマッチを有効にする​

フレーズマッチは、Zilliz Cloud の文字列データ型である VARCHAR フィールド型で動作します。

フレーズマッチングを有効にするには、enable_analyzer と enable_match の両方のパラメーターを True に設定して、コレクションスキーマを構成します。この設定によりテキストがトークン化され、位置情報を含む転置インデックスが構築され、効率的なフレーズ検索が可能になります。

スキーマフィールドを定義する​

特定の VARCHAR フィールドでフレーズマッチを有効にするには、フィールドスキーマを定義するときに enable_analyzer と enable_match の両方を True に設定します。

python
from pymilvus import MilvusClient, DataType

# Set up a MilvusClient
CLUSTER_ENDPOINT = "YOUR_CLUSTER_ENDPOINT"
TOKEN = "YOUR_CLUSTER_TOKEN" 

client = MilvusClient(
    uri=CLUSTER_ENDPOINT,
    token=TOKEN 
)

# Create a schema for a new collection
schema = client.create_schema(enable_dynamic_field=False)

# Add a primary key field
schema.add_field(
    field_name="id",
    datatype=DataType.INT64,
    is_primary=True,
    auto_id=True
)

# Add a VARCHAR field configured for phrase matching
schema.add_field(
    field_name="text",                  # Name of the field
    datatype=DataType.VARCHAR,          # Field data type set as VARCHAR (string)
    max_length=1000,                    # Maximum string length
    enable_analyzer=True,               # Required. Enables text analysis
    enable_match=True,                  # Required. Enables inverted indexing for phrase matching
    # Optional: Use a custom analyzer for better phrase matching in specific languages.
    # analyzer_params = {"type": "english"}     # Example: English analyzer; uncomment to apply custom analyzer
)

# Add a vector field for embeddings
schema.add_field(
    field_name="embeddings",
    datatype=DataType.FLOAT_VECTOR,
    dim=5
)

デフォルトでは、Zilliz Cloud は standard analyzer を使用します。これは、空白と句読点でテキストをトークン化し、テキストを小文字に変換します。

テキストデータが特定の言語または形式である場合は、analyzer_params パラメーター（たとえば、{ "type": "english" } または { "type": "jieba" }）を使用してカスタムアナライザーを構成できます。

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

コレクションを作成する​

必要なフィールドが定義されたら、次のコードを使用してコレクションを作成します：

python
# Create the collection
COLLECTION_NAME = "tech_articles" # Name your collection

if client.has_collection(COLLECTION_NAME):
    client.drop_collection(COLLECTION_NAME)

client.create_collection(
    collection_name=COLLECTION_NAME,
    schema=schema
)

コレクションを作成した後、フレーズマッチを使用する前に、次の必要な手順を実行してください：

  • エンティティがコレクションに挿入されていること。

  • 各ベクトルフィールドにインデックスを作成していること。

  • コレクションがメモリにロードされていること。

サンプルコードを表示
python
# Insert sample data with text containing "machine learning" phrases
sample_data = [
    {
        "text": "Machine learning is a subset of artificial intelligence that focuses on algorithms.",
        "embeddings": [0.1, 0.2, 0.3, 0.4, 0.5]
    },
    {
        "text": "Deep learning machine algorithms require large datasets for training.",
        "embeddings": [0.2, 0.3, 0.4, 0.5, 0.6]
    },
    {
        "text": "The machine learning model showed excellent performance on the test set.",
        "embeddings": [0.3, 0.4, 0.5, 0.6, 0.7]
    },
    {
        "text": "Natural language processing and machine learning go hand in hand.",
        "embeddings": [0.4, 0.5, 0.6, 0.7, 0.8]
    },
    {
        "text": "This article discusses various learning machine techniques and applications.",
        "embeddings": [0.5, 0.6, 0.7, 0.8, 0.9]
    }
]

# Insert the data
client.insert(
    collection_name=COLLECTION_NAME,
    data=sample_data
)

# Index the vector field and load the collection
index_params = client.prepare_index_params()
index_params.add_index(
    field_name="embeddings",
    index_type="AUTOINDEX",
    index_name="embeddings_index",
    metric_type="COSINE"
)

client.create_index(collection_name=COLLECTION_NAME, index_params=index_params)

client.load_collection(collection_name=COLLECTION_NAME)

フレーズマッチを使用する​

コレクションスキーマの VARCHAR フィールドでマッチを有効にすると、PHRASE_MATCH 式を使用してフレーズマッチを実行できます。

Notes

PHRASE_MATCH 式は大文字と小文字を区別しません。PHRASE_MATCH または phrase_match のいずれかを使用できます。

PHRASE_MATCH 式の構文​

検索時に、PHRASE_MATCH 式を使用してフィールド、フレーズ、およびオプションの柔軟性（slop）を指定します。構文は次のとおりです：

python
PHRASE_MATCH(field_name, phrase, slop)

  • field_name: フレーズマッチを実行する VARCHAR フィールドの名前です。

  • phrase: 検索する完全なフレーズです。

  • slop（オプション）: 一致するトークンで許容される位置の最大数を指定する整数です。

    • 0（デフォルト）：完全なフレーズのみに一致します。例："machine learning" のフィルターは "machine learning" に完全に一致しますが、"machine boosts learning" や "learning machine" には一致しません。

    • 1：1 つの余分な用語やわずかな位置のずれなど、小さな変動を許容します。例："machine learning" のフィルターは "machine boosts learning"（"machine" と "learning" の間に 1 トークン）に一致しますが、"learning machine"（用語が逆順）には一致しません。

    • 2：用語の逆順や間に最大 2 トークンを許容するなど、より大きな柔軟性を提供します。例："machine learning" のフィルターは "learning machine"（用語が逆順）または "machine quickly boosts learning"（"machine" と "learning" の間に 2 トークン）に一致します。

フレーズマッチでクエリする​

query() メソッドを使用する場合、PHRASE_MATCH はスカラーフィルターとして機能します。指定されたフレーズを含むドキュメント（許容される slop の範囲内）のみが返されます。

例：slop = 0（完全一致）​

この例は、間に余分なトークンを挟まずに完全なフレーズ "machine learning" を含むドキュメントを返します。

python
# Match documents containing exactly "machine learning"
filter = "PHRASE_MATCH(text, 'machine learning')"

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

print("Query result: ", result)

# Expected output:
# Query result:  data: ["{'id': 461366973343948097, 'text': 'Machine learning is a subset of artificial intelligence that focuses on algorithms.'}", "{'id': 461366973343948099, 'text': 'The machine learning model showed excellent performance on the test set.'}", "{'id': 461366973343948100, 'text': 'Natural language processing and machine learning go hand in hand.'}"]

フレーズマッチで検索する​

検索操作では、PHRASE_MATCH を使用して、ベクトル類似度ランキングを適用する前にドキュメントを事前フィルタリングします。この 2 段階のアプローチでは、まずテキストマッチングによって候補セットを絞り込み、次にベクトル埋め込みに基づいてそれらの候補を再ランク付けします。

例：slop = 1​

ここでは、slop を 1 に設定します。フィルターは、フレーズ "learning machine" をわずかな柔軟性をもって含むドキュメントに適用されます。

python
# Example: Filter documents containing "learning machine" with slop=1
filter_slop1 = "PHRASE_MATCH(text, 'learning machine', 1)"

result_slop1 = client.search(
    collection_name=COLLECTION_NAME,
    anns_field="embeddings",
    data=[[0.1, 0.2, 0.3, 0.4, 0.5]],
    filter=filter_slop1,
    search_params={},
    limit=10,
    output_fields=["id", "text"]
)

print("Slop 1 result: ", result_slop1)

# Expected output:
# Slop 1 result:  data: [[{'id': 461366973343948098, 'distance': 0.9949367046356201, 'entity': {'text': 'Deep learning machine algorithms require large datasets for training.', 'id': 461366973343948098}}, {'id': 461366973343948101, 'distance': 0.9710607528686523, 'entity': {'text': 'This article discusses various learning machine techniques and applications.', 'id': 461366973343948101}}]]

例：slop = 2​

この例では、slop を 2 に設定します。これは、"machine" と "learning" の単語間に最大 2 つの余分なトークン（または逆順の用語）が許容されることを意味します。

python
# Example: Filter documents containing "machine learning" with slop=2
filter_slop2 = "PHRASE_MATCH(text, 'machine learning', 2)"

result_slop2 = client.search(
    collection_name=COLLECTION_NAME,
    anns_field="embeddings",             # Vector field name
    data=[[0.1, 0.2, 0.3, 0.4, 0.5]],                 # Query vector
    filter=filter_slop2,                 # Filter expression
    search_params={},
    limit=10,                            # Maximum results to return
    output_fields=["id", "text"]
)

print("Slop 2 result: ", result_slop2)

# Expected output:
# Slop 2 result:  data: [[{'id': 461366973343948097, 'distance': 0.9999999403953552, 'entity': {'text': 'Machine learning is a subset of artificial intelligence that focuses on algorithms.', 'id': 461366973343948097}}, {'id': 461366973343948098, 'distance': 0.9949367046356201, 'entity': {'text': 'Deep learning machine algorithms require large datasets for training.', 'id': 461366973343948098}}, {'id': 461366973343948099, 'distance': 0.9864400029182434, 'entity': {'text': 'The machine learning model showed excellent performance on the test set.', 'id': 461366973343948099}}, {'id': 461366973343948100, 'distance': 0.9782319068908691, 'entity': {'text': 'Natural language processing and machine learning go hand in hand.', 'id': 461366973343948100}}, {'id': 461366973343948101, 'distance': 0.9710607528686523, 'entity': {'text': 'This article discusses various learning machine techniques and applications.', 'id': 461366973343948101}}]]

例：slop = 3​

この例では、slop を 3 に設定してさらに柔軟性を高めます。フィルターは、単語間に最大 3 つのトークン位置を許容して "machine learning" を検索します。

python
# Example: Filter documents containing "machine learning" with slop=3
filter_slop3 = "PHRASE_MATCH(text, 'machine learning', 3)"

result_slop3 = client.search(
    collection_name=COLLECTION_NAME,
    anns_field="embeddings",             # Vector field name
    data=[[0.1, 0.2, 0.3, 0.4, 0.5]],                 # Query vector
    filter=filter_slop3,                 # Filter expression
    search_params={},
    limit=10,                            # Maximum results to return
    output_fields=["id", "text"]
)

print("Slop 3 result: ", result_slop3)

# Expected output:
# Slop 3 result:  data: [[{'id': 461366973343948097, 'distance': 0.9999999403953552, 'entity': {'text': 'Machine learning is a subset of artificial intelligence that focuses on algorithms.', 'id': 461366973343948097}}, {'id': 461366973343948098, 'distance': 0.9949367046356201, 'entity': {'text': 'Deep learning machine algorithms require large datasets for training.', 'id': 461366973343948098}}, {'id': 461366973343948099, 'distance': 0.9864400029182434, 'entity': {'text': 'The machine learning model showed excellent performance on the test set.', 'id': 461366973343948099}}, {'id': 461366973343948100, 'distance': 0.9782319068908691, 'entity': {'text': 'Natural language processing and machine learning go hand in hand.', 'id': 461366973343948100}}, {'id': 461366973343948101, 'distance': 0.9710607528686523, 'entity': {'text': 'This article discusses various learning machine techniques and applications.', 'id': 461366973343948101}}]]

考慮事項​

  • フィールドのフレーズマッチングを有効にすると転置インデックスが作成され、ストレージリソースが消費されます。この機能を有効にするかどうかを決定する際は、テキストサイズ、一意のトークン、および使用するアナライザーによってストレージへの影響が異なることを考慮してください。

  • スキーマでアナライザーを定義すると、その設定はそのコレクションに対して永続的になります。別のアナライザーの方がニーズに適していると判断した場合は、既存のコレクションを削除し、目的のアナライザー構成で新しいコレクションを作成することを検討してください。

  • フレーズマッチのパフォーマンスは、テキストがどのようにトークン化されるかによって異なります。アナライザーをコレクション全体に適用する前に、run_analyzer メソッドを使用してトークン化の出力を確認してください。詳細は、Analyzer Overview を参照してください。

  • filter 式のエスケープルール：

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

    • 文字列定数が一重引用符で囲まれている場合、定数内の一重引用符は \\' で表す必要がありますが、二重引用符は " または \\" のいずれかで表すことができます。例：'It\\'s milvus'。

    • 文字列定数が二重引用符で囲まれている場合、定数内の二重引用符は \\" で表す必要がありますが、一重引用符は ' または \\' のいずれかで表すことができます。例："He said \\"Hi\\""。

このページは役に立ちましたか？
Ctrl I