EmbeddingLists で検索する: ColBERT と ColPali

このチュートリアルでは、Zilliz Cloud における StructArray vector サブフィールド上の EmbeddingList 検索を使用して、ColBERT スタイルおよび ColPali スタイルの検索システムを構築する方法を紹介します。クエリと保存データの両方が vector のリストとして表現され、MAX_SIM* メトリクスを使用した entity レベルの late-interaction 検索が必要な場合に利用してください。

このチュートリアルの背景となる StructArray の基本については、StructArray フィールドを作成する、StructArray フィールドにインデックスを作成する、および StructArray を使用した基本的なベクトル検索 を参照してください。このチュートリアルでは、一般的な StructArray 構文ではなく、ColBERT と ColPali のワークフローに焦点を当てます。

Overview

テキスト検索システムを構築するには、精度と正確性を確保するために、ドキュメントをチャンクに分割し、各チャンクをその embeddings とともに vector データベース内の entity として保存する必要がある場合があります。特に長いドキュメントでは、全文 embeddings によって意味的な特異性が薄れたり、モデルの入力制限を超えたりする可能性があるためです。

ただし、データをチャンク単位で保存すると、検索結果もチャンク単位になります。つまり、検索は最初にまとまりのある documents ではなく、関連する segments を特定します。これに対処するには、検索後に追加の後処理を行う必要があります。

ColBERT（arXiv: 2004.12832）は、BERT 上での文脈化された late interaction によって、効率的かつ効果的な passage 検索を提供する text-text 検索システムです。クエリと documents を token 単位で独立してエンコードし、それらの類似度を計算できます。

Token-wise encoding

ColBERT におけるデータ取り込み時には、各 document は token に分割され、それらがベクトル化されて embedding list として保存されます。つまり、$d \rightarrow E_d = [e_\{d1\}, e_\{d2\}, \dots, e_\{dn\}] ∈ \R^\{n×d\}$ となります。クエリが到着すると、それも token 化され、ベクトル化され、embedding list として保存されます。つまり、$q \rightarrow E_q = [e_\{q1\}, e_\{q2\}, \dots, e_\{qm\}] ∈ \R^\{m×d\}$ となります。

上記の式では、

• $d$: document

• $q$: クエリ

• $E_d$: document を表す embedding list。

• $E_q$: クエリを表す embedding list。

• $[e_\{d1\}, e_\{d2\}, \dots, e_\{dn\}] ∈ \R^\{n×d\}$: document を表す embedding list 内の vector embeddings の数は $\R^\{n×d\}$ の範囲内です。

• $[e_\{q1\}, e_\{q2\}, \dots, e_\{qm\}] ∈ \R^\{m×d\}$: クエリを表す embedding list 内の vector embeddings の数は $\R^\{m×d\}$ の範囲内です。

Late interaction

ベクトル化が完了すると、最終的な類似度スコアを決定するために、クエリの embedding list が各 document の embedding list と token ごとに比較されます。

上の図に示すように、クエリには machine と learning の 2 つの token が含まれ、ウィンドウ内の document には neural、network、python、tutorial の 4 つの token が含まれています。これらの token がベクトル化されると、各クエリ token の vector embeddings が document 内のそれらと比較され、類似度スコアのリストが取得されます。次に、各スコアリストから最も高いスコアを合計して最終スコアを生成します。document の最終スコアを決定するこのプロセスは、maximum similarity（MAX_SIM）として知られています。maximum similarity の詳細については、Maximum similarity を参照してください。

📘Notes

Milvus で ColBERT ライクなテキスト検索システムを実装する際、documents を token に分割することに限定されません。

代わりに、documents を適切な任意のサイズの segments に分割し、各 segment を埋め込んで embedding list を作成し、その埋め込まれた segments とともに document を entity に保存できます。

ColPali extension

ColBERT をベースに、ColPali（arXiv: 2407.01449）は、Vision-Language Models（VLMs）を活用した、視覚的に情報量の多い document 検索のための新しいアプローチを提案しています。データ取り込み時には、各 document page は token 化される代わりに高解像度画像としてレンダリングされ、その後 patch に分割されます。たとえば、448 x 448 ピクセルの document page 画像からは、14 x 14 ピクセルの patch を 1,024 個生成できます。

この方法では、テキストのみの検索システムでは失われる document レイアウト、画像、テーブル構造などの非テキスト情報を保持できます。

ColPali で使用される VLM は PaliGemma（arXiv: 2407.07726）と呼ばれ、画像エンコーダー（SigLIP-400M）、decoder-only 言語モデル（Gemma2-2B）、および画像エンコーダーの出力を言語モデルの vector space に投影する線形層で構成されます。これは上図のとおりです。

データ取り込み時には、生画像として表現される document page が複数の visual patch に分割され、それぞれが埋め込まれて vector embeddings のリストを生成します。次に、それらが言語モデルの vector space に投影され、最終的な embedding list を取得します。つまり、$d \rightarrow E_d = [e_\{d1\}, e_\{d2\}, \dots, e_\{dn\}] ∈ \R^\{n×d\}$ です。クエリが到着すると、それは token 化され、各 token が埋め込まれて vector embeddings のリストが生成されます。つまり、$q \rightarrow E_q = [e_\{q1\}, e_\{q2\}, \dots, e_\{qm\}] ∈ \R^\{m×d\}$ です。その後、MAX_SIM が適用され、2 つの embedding list を比較して、クエリと document page の最終スコアを取得します。

ColBERT text retrieval system

このセクションでは、StructArray を使用して ColBERT のテキスト検索システムをセットアップします。その前に、Milvus v2.6.x と互換性のある Zilliz Cloud cluster をセットアップし、Cohere access token を取得してください。

Step 1: Install the dependencies

以下のコマンドを実行して dependencies をインストールします。

shell

pip install --upgrade huggingface-hub transformers datasets pymilvus cohere

Step 2: Load the Cohere dataset

この例では、Cohere の Wikipedia dataset を使用し、先頭 10,000 件のレコードを取得します。この dataset に関する情報は このページ で確認できます。

python

from datasets import load_dataset

lang = "simple"
docs = load_dataset(
    "Cohere/wikipedia-2023-11-embed-multilingual-v3", 
    lang, 
    split="train[:10000]"
)

上記のスクリプトを実行すると、dataset がローカルで利用できない場合にダウンロードされます。dataset 内の各レコードは Wikipedia page の 1 つの paragraph です。次の表は、この dataset の構造を示しています。

Column Name	Description
_id	レコード ID
url	現在のレコードの URL。
title	ソース document のタイトル。
text	ソース document の 1 つの paragraph。
emb	ソース document のテキストの embeddings。

Step 3: Group paragraphs by title

paragraph ではなく documents を検索するために、paragraphs を title ごとにグループ化する必要があります。

python

df = docs.to_pandas()
groups = df.groupby('title')

data = []

for title, group in groups:
  data.append({
      "title": title,
      "paragraphs": [{
          "text": row['text'],
          'emb': row['emb']
      } for _, row in group.iterrows()]
  })

このコードでは、グループ化された paragraphs を documents として保存し、それらを data リストに含めています。各 document には paragraphs キーがあり、これは paragraphs のリストです。各 paragraph オブジェクトには text キーと emb キーが含まれます。

Step 4: Create a collection for the Cohere dataset

データの準備ができたら、collection を作成します。この collection では、paragraphs は StructArray フィールドです。StructArray スキーマの一般的な説明については、StructArray フィールドを作成する を参照してください。

python

from pymilvus import MilvusClient, DataType

client = MilvusClient(
    uri="YOUR_CLUSTER_ENDPOINT",
    token="YOUR_CLUSTER_TOKEN"
)

# Create collection schema
schema = client.create_schema()

schema.add_field('id', DataType.INT64, is_primary=True, auto_id=True)
schema.add_field('title', DataType.VARCHAR, max_length=512)

# Create struct schema
struct_schema = client.create_struct_field_schema()
struct_schema.add_field('text', DataType.VARCHAR, max_length=65535)
struct_schema.add_field('emb', DataType.FLOAT_VECTOR, dim=512)

schema.add_field('paragraphs', DataType.ARRAY,
                 element_type=DataType.STRUCT,
                 struct_schema=struct_schema, max_capacity=200)

# Create index parameters
index_params = client.prepare_index_params()
index_params.add_index(
    field_name="paragraphs[emb]",
    index_type="AUTOINDEX",
    metric_type="MAX_SIM_COSINE"
)

# Create a collection
client.create_collection(
    collection_name='wiki_documents', 
    schema=schema, 
    index_params=index_params
)

Step 5: Insert Cohere dataset into the collection

これで、上で作成した collection に準備済みデータを挿入できます。

python

client.insert(
    collection_name='wiki_documents', 
    data=data
)

Step 6: Search within the Cohere dataset

ColBERT の設計によれば、クエリテキストは token 化され、その後 EmbeddingList に埋め込まれる必要があります。このステップでは、Wikipedia dataset 内の paragraphs の embeddings を生成するために Cohere が使用したのと同じモデルを使用します。

python

import cohere

co = cohere.ClientV2("COHERE_API_KEY")

query_inputs = [
    {
        'content': [
            {'type': 'text', 'text': 'Adobe'},
        ]
    },
    {
        'content': [
            {'type': 'text', 'text': 'software'}
        ]
    }
]

embeddings = co.embed(
    inputs=query_inputs,
    model='embed-multilingual-v3.0',
    input_type="classification",
    embedding_types=["float"],
)

このコードでは、クエリテキストは query_inputs 内で token として整理され、float vectors のリストに埋め込まれます。その後、以下のように Milvus の EmbeddingList を使用して類似度検索を実行できます。

python

from pymilvus.client.embedding_list import EmbeddingList

query_emb_list = EmbeddingList()

if (embeddings.embeddings.float):
  query_emb_list.add_batch(embeddings.embeddings.float)

results = client.search(
    collection_name="wiki_documents",
    data=[query_emb_list],
    anns_field="paragraphs[emb]",
    limit=10,
    output_fields=["title"]
)

for hit in results[0]:
  print(f"Document {hit['entity']['title']}: {hit['distance']:.4f}")

上記コードの出力は、次のようになります。

python

# Document Software: 2.3035
# Document Application: 2.1875
# Document Adobe Illustrator: 2.1167
# Document Open source: 2.0542
# Document Computer: 1.9811
# Document Microsoft: 1.9784
# Document Web browser: 1.9655
# Document Program: 1.9627
# Document Website: 1.9594
# Document Computer science: 1.9460

各ペアごとの cosine similarity スコアは -1 から 1 の範囲です。最終的な MAX_SIM_COSINE スコアは、複数の token レベルの maximum similarity スコアを集約するため、1 を超える場合があります。

ColPali document retrieval system

このセクションでは、StructArray を使用して ColPali ベースの document 検索システムをセットアップします。その前に、Milvus v2.6.x と互換性のある Zilliz Cloud cluster をセットアップしてください。

Step 1: Install the dependencies

shell

pip install --upgrade huggingface-hub transformers datasets pymilvus 'colpali-engine>=0.3.0,<0.4.0'

Step 2: Load the Vidore dataset

このセクションでは、vidore_v2_finance_en という Vidore dataset を使用します。この dataset は、長文 document 理解タスクを目的とした、銀行業界の年次報告書のコーパスです。これは ViDoRe v3 Benchmark を構成する 10 個のコーパスの 1 つです。この dataset の詳細は このページ で確認できます。

python

from datasets import load_dataset

ds = load_dataset("vidore/vidore_v3_finance_en", "corpus")
df = ds['test'].to_pandas()

上記のスクリプトを実行すると、dataset がローカルで利用できない場合にダウンロードされます。dataset 内の各レコードは、財務報告書の 1 ページです。次の表は、この dataset の構造を示しています。

Column Name	Description
corpus_id	corpus 内のレコード
image	bytes 形式の page image。
doc_id	説明用の document ID。
page_number_in_doc	doc 内の現在の page のページ番号。

Step 3: Generate embeddings for the page images

Overview セクションで説明したように、ColPali モデルは画像をテキストモデルの vector space に投影する VLM です。このステップでは、最新の ColPali モデル vidore/colpali-v1.3 を使用します。このモデルの詳細は このページ で確認できます。

python

import torch
from typing import cast
from colpali_engine.models import ColPali, ColPaliProcessor

model_name = "vidore/colpali-v1.3"

model = ColPali.from_pretrained(
    model_name,
    torch_dtype=torch.bfloat16,
    device_map="cuda:0",  # or "mps" if on Apple Silicon
).eval()

processor = ColPaliProcessor.from_pretrained(model_name)

モデルの準備ができたら、以下のように特定の画像に対して patch を生成してみることができます。

python

from PIL import Image
from io import BytesIO

# Use the iterrows() generator to get the first row.
row = next(df.iterrows())[1]

# Decode the image bytes and generate patch embeddings.
images = [Image.open(BytesIO(row["image"]["bytes"]))]
batch_images = processor.process_images(images).to(model.device)

with torch.no_grad():
    patches_embeddings = model(**batch_images)[0]

# Check the shape of the embeddings generated for the patches.
print(patches_embeddings.shape)

# [1031, 128]

上記のコードでは、ColPali モデルは画像を 448 x 448 ピクセルにリサイズし、その後、14 x 14 ピクセルの patch に分割します。最後に、これらの patch はそれぞれ 128 次元の 1,031 個の embeddings に埋め込まれます。

以下のようにループを使用して、すべての画像の embeddings を生成できます。

python

data = []

for _, row in df.iterrows():
    corpus_id = row["corpus_id"]
    images = [Image.open(BytesIO(row["image"]["bytes"]))]
    batch_images = processor.process_images(images).to(model.device)

    with torch.no_grad():
        patches = model(**batch_images)[0]

    doc_id = row["doc_id"]
    page_number_in_doc = row["page_number_in_doc"]

    data.append({
        "corpus_id": corpus_id,
        "patches": [
            {"emb": emb.float().cpu().tolist()}
            for emb in patches
        ],
        "doc_id": doc_id,
        "page_number_in_doc": page_number_in_doc,
    })

📘Notes

このステップは、埋め込む必要のあるデータ量が多いため、比較的時間がかかります。

ステップ 4: 財務レポートデータセット用の collection を作成する

データの準備ができたら、collection を作成します。この collection では、patches は StructArray フィールドです。各 Struct 要素には 1 つの patch embedding が格納されます。StructArray の vector サブフィールドに対する index 要件については、StructArray フィールドのインデックス作成 を参照してください。

python

from pymilvus import MilvusClient, DataType

client = MilvusClient(
    uri=YOUR_CLUSTER_ENDPOINT,
    token=YOUR_API_KEY
)

schema = client.create_schema()

schema.add_field(
    field_name="corpus_id",
    datatype=DataType.INT64,
    is_primary=True
)

patch_schema = client.create_struct_field_schema()

patch_schema.add_field(
    field_name="emb",
    datatype=DataType.FLOAT_VECTOR,
    dim=128
)

schema.add_field(
    field_name="patches",
    datatype=DataType.ARRAY,
    element_type=DataType.STRUCT,
    struct_schema=patch_schema,
    max_capacity=1031
)

schema.add_field(
    field_name="doc_id",
    datatype=DataType.VARCHAR,
    max_length=512
)

schema.add_field(
    field_name="page_number_in_doc",
    datatype=DataType.INT64
)

index_params = client.prepare_index_params()

index_params.add_index(
    field_name="patches[emb]",
    index_type="AUTOINDEX",
    metric_type="MAX_SIM_COSINE"
)

client.create_collection(
    collection_name="financial_reports",
    schema=schema,
    index_params=index_params
)

ステップ 5: 財務レポートを collection に挿入する

これで、準備した財務レポートを collection に挿入できます。

python

client.insert(
    collection_name="financial_reports",
    data=data
)

📘注意

財務レポートの挿入には長い時間がかかる場合があります。各ページには 1,000 を超える patch vector が含まれる可能性があり、各 vector は patches StructArray フィールド内に保存されます。より大きなデータセットでは、data をより小さなバッチに分割し、1 回に 1 バッチずつ挿入してください。

出力から、Vidore データセットのすべてのページが挿入されたことを確認できます。

ステップ 6: 財務レポート内を検索する

データの準備ができたら、次のように collection 内のデータに対して検索を実行できます。

python

from pymilvus.client.embedding_list import EmbeddingList

queries = [
    "quarterly revenue growth chart"
]

batch_queries = processor.process_queries(queries).to(model.device)

with torch.no_grad():
    query_embeddings = model(**batch_queries)

query_emb_list = EmbeddingList()
query_emb_list.add_batch(query_embeddings[0].float().cpu().tolist())

results = client.search(
    collection_name="financial_reports",
    data=[query_emb_list],
    anns_field="patches[emb]",
    limit=10,
    output_fields=["doc_id", "page_number_in_doc"]
)