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

多言語 Analyzer

Zilliz Cloud がテキスト分析を実行する際、通常は collection 内のテキストフィールド全体に対して単一の analyzer を適用します。その analyzer が英語向けに最適化されている場合、中国語、スペイン語、フランス語など他の言語で必要となる大きく異なるトークン化や語幹処理のルールには対応しづらく、結果として再現率が低下します。たとえば、スペイン語の "teléfono"（"phone" を意味する）を検索すると、英語重視の analyzer ではアクセントが落とされ、スペイン語固有の語幹処理も適用されないため、関連する結果が見落とされる可能性があります。

多言語 analyzer は、単一の collection 内のテキストフィールドに対して複数の analyzer を設定できるようにすることで、この問題を解決します。これにより、多言語のドキュメントを 1 つのテキストフィールドに保存でき、Zilliz Cloud は各ドキュメントに対して適切な言語ルールに従ってテキストを分析します。

Limits​

  • この機能は、BM25 ベースのテキスト検索と疎ベクトルでのみ動作します。詳細は、全文検索 を参照してください。

  • 1 つの collection 内の各ドキュメントで使用できる analyzer は 1 つだけであり、これはその言語識別子フィールドの値によって決まります。

  • パフォーマンスは、analyzer の複雑さやテキストデータのサイズによって異なる場合があります。

Overview​

以下の図は、Zilliz Cloud で多言語 analyzer を設定して使用するワークフローを示しています。

ZDYIwC1HwhTrdlbfOgNcOZ4OnWg

  1. 多言語 Analyzer を設定する:

    • <analyzer_name>: <analyzer_config> 形式で複数の言語固有 analyzer を設定します。各 analyzer_config は、Analyzer Overview で説明されている標準の analyzer_params 設定に従います。

    • 各ドキュメントに対する analyzer の選択を決定する特別な識別子フィールドを定義します。

    • 不明な言語を処理するための default analyzer を設定します。

  2. Collection を作成する:

    • 必須フィールドを含む schema を定義します。

      • primary_key: 一意のドキュメント識別子。

      • text_field: 元のテキストコンテンツを保存します。

      • identifier_field: 各ドキュメントに対してどの analyzer を使用するかを示します。

      • vector_field: BM25 function によって生成される疎埋め込みを保存します。

    • BM25 function と indexing パラメータを設定します。

  3. 言語識別子付きでデータを挿入する:

    • さまざまな言語のテキストを含むドキュメントを追加します。各ドキュメントには、どの analyzer を使用するかを指定する識別子値が含まれます。

    • Zilliz Cloud は識別子フィールドに基づいて適切な analyzer を選択し、不明な識別子を持つドキュメントには default analyzer を使用します。

  4. 言語固有 Analyzer で検索する:

    • analyzer 名を指定したクエリテキストを提供すると、Zilliz Cloud は指定された analyzer を使ってクエリを処理します。

    • トークン化は言語固有のルールに従って実行され、検索は類似度に基づいてその言語に適した結果を返します。

Step 1: multi_analyzer_params を設定する​

multi_analyzer_params は、Zilliz Cloud が各 entity に対して適切な analyzer をどのように選択するかを決定する単一の JSON オブジェクトです。

python
multi_analyzer_params = {
  # Define language-specific analyzers
  # Each analyzer follows this format: <analyzer_name>: <analyzer_params>
  "analyzers": {
    "english": {"type": "english"},          # English-optimized analyzer
    "chinese": {"type": "chinese"},          # Chinese-optimized analyzer
    "default": {"tokenizer": "icu"}          # Required fallback analyzer
  },
  "by_field": "language",                    # Field determining analyzer selection
  "alias": {
    "cn": "chinese",                         # Use "cn" as shorthand for Chinese
    "en": "english"                          # Use "en" as shorthand for English
  }
}

パラメータ

必須?

説明

ルール

analyzers

はい

Zilliz Cloud がテキスト処理に使用できる、各言語固有の analyzer をすべて一覧します。

analyzers 内の各 analyzer は、<analyzer_name>: <analyzer_params> 形式に従います。

  • 標準の analyzer_params 構文で各 analyzer を定義します（Analyzer Overview を参照）。

  • キーが default のエントリを追加してください。by_field に保存されている値が他の analyzer 名のいずれにも一致しない場合、Zilliz Cloud はこの analyzer にフォールバックします。

by_field

はい

各ドキュメントについて、Zilliz Cloud が適用すべき言語（つまり analyzer 名）を保存するフィールド名です。

  • collection 内で定義された VARCHAR フィールドである必要があります。

  • 各行の値は、analyzers に記載された analyzer 名（または alias）のいずれかと正確に一致する必要があります。

  • 行の値が欠けているか見つからない場合、Zilliz Cloud は自動的に default analyzer を適用します。

alias

いいえ

analyzer のショートカットや別名を作成し、コード内で参照しやすくします。各 analyzer には 1 つ以上の alias を設定できます。

各 alias は、既存の analyzer キーにマッピングされている必要があります。

Step 2: collection を作成する​

多言語サポート付きの collection を作成するには、特定のフィールドと index を設定する必要があります。

Step 1: フィールドを追加する​

このステップでは、4 つの必須フィールドを含む collection schema を定義します。

  • Primary Key Field (id): collection 内の各 entity の一意な識別子です。auto_id=True を設定すると、Zilliz Cloud がこれらの ID を自動生成します。

  • Language Indicator Field (language): この VARCHAR フィールドは、multi_analyzer_params で指定した by_field に対応します。各 entity の言語識別子を保存し、これにより Zilliz Cloud は使用する analyzer を判断します。

  • Text Content Field (text): 分析および検索したい実際のテキストデータを保存する VARCHAR フィールドです。enable_analyzer=True の設定は重要で、このフィールドのテキスト分析機能を有効にします。multi_analyzer_params 設定はこのフィールドに直接関連付けられ、テキストデータと言語固有 analyzer との接続を確立します。

  • Vector Field (sparse): BM25 function によって生成される疎ベクトルを保存するフィールドです。これらのベクトルはテキストデータの分析可能な形式を表し、Zilliz Cloud が実際に検索する対象です。

python
# Import required modules
from pymilvus import MilvusClient, DataType, Function, FunctionType

# Initialize client
client = MilvusClient(
    uri="YOUR_CLUSTER_ENDPOINT",
)

# Initialize a new schema
schema = client.create_schema()

# Step 2.1: Add a primary key field for unique document identification
schema.add_field(
    field_name="id",                  # Field name
    datatype=DataType.INT64,          # Integer data type
    is_primary=True,                  # Designate as primary key
    auto_id=True                      # Auto-generate IDs (recommended)
)

# Step 2.2: Add language identifier field
# This MUST match the "by_field" value in language_analyzer_config
schema.add_field(
    field_name="language",       # Field name
    datatype=DataType.VARCHAR,   # String data type
    max_length=255               # Maximum length (adjust as needed)
)

# Step 2.3: Add text content field with multi-language analysis capability
schema.add_field(
    field_name="text",                           # Field name
    datatype=DataType.VARCHAR,                   # String data type
    max_length=8192,                             # Maximum length (adjust based on expected text size)
    enable_analyzer=True,                        # Enable text analysis
    multi_analyzer_params=multi_analyzer_params  # Connect with our language analyzers
)

# Step 2.4: Add sparse vector field to store the BM25 output
schema.add_field(
    field_name="sparse",                   # Field name
    datatype=DataType.SPARSE_FLOAT_VECTOR  # Sparse vector data type
)

ステップ 2: BM25 関数を定義する​

生のテキストデータから疎ベクトル表現を生成するために、BM25 関数を定義します。

python
# Create the BM25 function
bm25_function = Function(
    name="text_to_vector",            # Descriptive function name
    function_type=FunctionType.BM25,  # Use BM25 algorithm
    input_field_names=["text"],       # Process text from this field
    output_field_names=["sparse"]     # Store vectors in this field
)

# Add the function to our schema
schema.add_function(bm25_function)

この関数は、各テキストエントリの言語識別子に基づいて適切な Analyzer を自動的に適用します。BM25 ベースのテキスト検索の詳細については、Full Text Search を参照してください。

ステップ 3: インデックスパラメータを設定する​

効率的な検索を可能にするため、疎ベクトルフィールドにインデックスを作成します。

python
# Configure index parameters
index_params = client.prepare_index_params()

# Add index for sparse vector field
index_params.add_index(
    field_name="sparse",        # Field to index (our vector field)
    index_type="AUTOINDEX",     # Let Milvus choose optimal index type
    metric_type="BM25"          # Must be BM25 for this feature
)

このインデックスは、BM25 類似度計算を効率的に行えるように疎ベクトルを整理し、検索パフォーマンスを向上させます。

ステップ 4: コレクションを作成する​

この最後の作成ステップでは、これまでの設定をすべてまとめます。

  • collection_name="multilang_demo" は、後で参照するためにコレクションに名前を付けます。

  • schema=schema は、定義したフィールド構造と関数を適用します。

  • index_params=index_params は、効率的な検索のためのインデックス戦略を実装します。

python
# Create collection
COLLECTION_NAME = "multilingual_documents"

# Check if collection already exists
if client.has_collection(COLLECTION_NAME):
    client.drop_collection(COLLECTION_NAME)  # Remove it for this example
    print(f"Dropped existing collection: {COLLECTION_NAME}")

# Create the collection
client.create_collection(
    collection_name=COLLECTION_NAME,       # Collection name
    schema=schema,                         # Our multilingual schema
    index_params=index_params              # Our search index configuration
)

この時点で、Zilliz Cloud は多言語 Analyzer をサポートする空のコレクションを作成し、データ受け入れの準備を整えます。

ステップ 3: サンプルデータを挿入する​

多言語コレクションにドキュメントを追加する際は、それぞれにテキスト内容と言語識別子の両方を含める必要があります。

python
# Prepare multilingual documents
documents = [
    # English documents
    {
        "text": "Artificial intelligence is transforming technology",
        "language": "english",  # Using full language name
    },
    {
        "text": "Machine learning models require large datasets",
        "language": "en",  # Using our defined alias
    },
    # Chinese documents
    {
        "text": "人工智能正在改变技术领域",
        "language": "chinese",  # Using full language name
    },
    {
        "text": "机器学习模型需要大型数据集",
        "language": "cn",  # Using our defined alias
    },
]

# Insert the documents
result = client.insert(COLLECTION_NAME, documents)

# Print results
inserted = result["insert_count"]            
print(f"Successfully inserted {inserted} documents")
print("Documents by language: 2 English, 2 Chinese")

# Expected output:
# Successfully inserted 4 documents
# Documents by language: 2 English, 2 Chinese

挿入時に、Zilliz Cloud は次の処理を行います。

  1. 各ドキュメントの language フィールドを読み取る

  2. 対応する Analyzer を text フィールドに適用する

  3. BM25 関数を介して疎ベクトル表現を生成する

  4. 元のテキストと生成された疎ベクトルの両方を保存する

📘注意

疎ベクトルを直接指定する必要はありません。BM25 関数が、テキストと指定した Analyzer に基づいて自動的に生成します。

ステップ 4: 検索操作を実行する​

English Analyzer を使用する​

多言語 Analyzer を使って検索する場合、search_params には重要な設定が含まれます。

  • metric_type="BM25" は、インデックス設定と一致している必要があります。

  • analyzer_name="english" は、クエリテキストに適用する Analyzer を指定します。これは保存済みドキュメントに使用された Analyzer とは独立しています。

  • params={"drop_ratio_search": "0"} は、BM25 固有の動作を制御します。ここでは検索内のすべての用語を保持します。詳細は Sparse Vector を参照してください。

python
search_params = {
    "metric_type": "BM25",            # Must match index configuration
    "analyzer_name": "english",  # Analyzer that matches the query language
    "drop_ratio_search": "0",     # Keep all terms in search (tweak as needed)
}

# Execute the search
english_results = client.search(
    collection_name=COLLECTION_NAME,  # Collection to search
    data=["artificial intelligence"],                # Query text
    anns_field="sparse",              # Field to search against
    search_params=search_params,      # Search configuration
    limit=3,                      # Max results to return
    output_fields=["text", "language"],  # Fields to include in the output
    consistency_level="Bounded",       # Data‑consistency guarantee
)

# Display English search results
print("\n=== English Search Results ===")
for i, hit in enumerate(english_results[0]):
    print(f"{i+1}. [{hit.score:.4f}] {hit.entity.get('text')} "
          f"(Language: {hit.entity.get('language')})")

# Expected output (English Search Results):
# 1. [2.7881] Artificial intelligence is transforming technology (Language: english)

中国語 analyzer を使用する​

この例では、異なるクエリテキストに対して中国語 analyzer（エイリアス "cn" を使用）に切り替える方法を示します。その他のすべてのパラメータは同じままですが、クエリテキストは中国語固有のトークン化ルールを使用して処理されます。

python
search_params["analyzer_name"] = "cn"

chinese_results = client.search(
    collection_name=COLLECTION_NAME,  # Collection to search
    data=["人工智能"],                # Query text
    anns_field="sparse",              # Field to search against
    search_params=search_params,      # Search configuration
    limit=3,                      # Max results to return
    output_fields=["text", "language"],  # Fields to include in the output
    consistency_level="Bounded",       # Data‑consistency guarantee
)

# Display Chinese search results
print("\n=== Chinese Search Results ===")
for i, hit in enumerate(chinese_results[0]):
    print(f"{i+1}. [{hit.score:.4f}] {hit.entity.get('text')} "
          f"(Language: {hit.entity.get('language')})")

# Expected output (Chinese Search Results):
# 1. [3.3814] 人工智能正在改变技术领域 (Language: chinese)
Ctrl I