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

フレーズ一致

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

しかし実際のユースケースでは、厳密なフレーズ一致はあまりにも硬直的である場合があります。たとえば、"…machine learning models widely adopted in robotics…" のようなテキストにもマッチさせたい場合があるでしょう。ここでは同じキーワードが含まれていますが、隣接しておらず、元の順序でもありません。このようなケースに対応するため、フレーズ一致では slop パラメータがサポートされています。この slop 値は、フレーズ内の語句間で許容される位置のずれ（positional shifts）の数を定義します。たとえば、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（"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 は standard analyzer を使用します。このアナライザーは、テキストを空白文字や句読点でトークン化し、小文字に変換します。

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

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

Create the collection​

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

# 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 フィールドに対してフレーズ一致を有効化した後、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 with フレーズ一致​

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

Example: slop = 0 (exact match)​

この例では、"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に設定することでさらに柔軟性が高まります。フィルターは**"machine learning"**を検索し、単語間に最大3トークン分の位置のずれを許容します。

# 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\\""。