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

フレーズ一致

フレーズ一致は、クエリ用語を正確なフレーズとして含むドキュメントを検索できます。デフォルトでは、単語は同じ順序で、互いに直接隣接して出現する必要があります。たとえば、「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)]**にトークン化されます。アナライザーの詳細については、アナライザーの概要を参照してください。

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

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

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

      • この例では、doc_1（「machine」がpos=0、「learning」がpos=1）のみが正確に一致します。

    • slop = 2は、一致するトークン間に最大2つの位置の柔軟性または再配置を許可します。

      • これにより、逆順（「learning machine」）や、トークン間のわずかなギャップが許容されます。

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

フレーズ一致を有効にする​

フレーズ一致は、Zilliz Cloudの文字列データ型であるVARCHARフィールドタイプで機能します。

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

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

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

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 は、空白と句読点によってテキストをトークン化し、テキストを小文字に変換する標準アナライザーを使用します。

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

詳細については、アナライザーの概要を参照してください。

コレクションの作成​

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

# 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
)

コレクションが作成された後、フレーズマッチを使用する前に、以下の必要な手順が実行されていることを確認してください。

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

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

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

サンプルコードを表示
# 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フィールドのmatchを有効にすると、PHRASE_MATCH式を使用してフレーズ一致を実行できます。

📘Notes

PHRASE_MATCH式では大文字と小文字は区別されません。PHRASE_MATCHまたはphrase_matchのどちらを使用しても構いません。

PHRASE_MATCH式の構文​

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

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" を含むドキュメントを返します。

# 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」**というフレーズをわずかな柔軟性で含むドキュメントに適用されます。

# 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つの余分なトークン（または逆順の用語）が許容されることを意味します。

# 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" を検索します。

# 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 メソッドを使用してトークン化出力を確認してください。詳細については、アナライザーの概要を参照してください。

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

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

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

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