# 視覚的ドキュメント検索

ドキュメントには、テキストに加えてチャート、テーブル、ビジュアルが含まれている場合があり、そのような場合はマルチモーダルデータを含むことになります。これらのドキュメントから情報を検索することは困難です。テキスト検索モデルだけでは視覚データを処理できず、画像検索モデルには粒度とドキュメント処理の機能が欠けているためです。

ビジュアルドキュメント検索は、マルチモーダル検索拡張生成（RAG）を含む、あらゆる種類のドキュメントから情報を検索するのに役立ちます。これらのモデルは、ドキュメント（画像として）とテキストを受け取り、それらの間の類似度スコアを計算します。

このガイドでは、[ColPali](../model_doc/colpali)を使用してドキュメントのインデックス作成と検索を行う方法を紹介します。

> [!TIP]
> 大規模なユースケースでは、ベクトルデータベースを使用してドキュメントのインデックス作成と検索を行うことを検討してください。

Transformers と Datasets がインストールされていることを確認してください。

```bash
pip install -q datasets transformers
```

UFO目撃に関する文書のデータセットをインデックス付けします。対象の列が欠落しているサンプルをフィルタリングします。データセットには複数の列が含まれており、文書の短い要約を含む`specific_detail_query`列と、文書本体を含む`image`列が対象です。

```python
from datasets import load_dataset

dataset = load_dataset("davanstrien/ufo-ColPali")
dataset = dataset["train"]
dataset = dataset.filter(lambda example: example["specific_detail_query"] is not None)
print(dataset)
```

```text
Dataset({
    features: ['image', 'raw_queries', 'broad_topical_query', 'broad_topical_explanation', 'specific_detail_query', 'specific_detail_explanation', 'visual_element_query', 'visual_element_explanation', 'parsed_into_json'],
    num_rows: 2172
})
```

モデルとトークナイザーを読み込みましょう。

```python
import torch
from transformers import ColPaliForRetrieval, ColPaliProcessor
from accelerate import Accelerator

device = Accelerator().device

model_name = "vidore/colpali-v1.2-hf"

processor = ColPaliProcessor.from_pretrained(model_name)

model = ColPaliForRetrieval.from_pretrained(
    model_name,
    dtype=torch.bfloat16,
    device_map="auto",
).eval()
```

テキストクエリをプロセッサに渡し、モデルからインデックス付きのテキスト埋め込みを返します。画像からテキストへの検索を行う場合は、[ColPaliProcessor](/docs/transformers/main/ja/model_doc/colpali#transformers.ColPaliProcessor)の`text`パラメータを`images`パラメータに置き換え、画像を渡します。

```python
inputs = processor(text="a document about Mars expedition").to(model.device)
with torch.no_grad():
  text_embeds = model(**inputs, return_tensors="pt").embeddings
```

画像をオフラインでインデックス化し、推論時にはクエリテキストの埋め込みを返して、それに最も近い画像の埋め込みを取得します。

[map](https://huggingface.co/docs/datasets/main/en/package_reference/main_classes#datasets.Dataset.map) を使用して、画像と画像埋め込みをデータセットに書き込み、それらを保存します。以下に示すように、インデックス付きの埋め込みを含む `embeddings` 列を追加します。ColPali の埋め込みはストレージを大量に消費するため、アクセラレーターから削除し、NumPy ベクトルとして CPU に保存します。

```python
ds_with_embeddings = dataset.map(lambda example: {'embeddings': model(**processor(images=example["image"]).to(device), return_tensors="pt").embeddings.to(torch.float32).detach().cpu().numpy()})
```

オンライン推論では、画像埋め込みをバッチで検索し、最も関連性の高い k 個の画像を取得する関数を作成します。以下の関数は、インデックス化されたデータセット、テキスト埋め込み、上位結果の数、およびバッチサイズを受け取り、データセット内のインデックスとスコアを返します。

```python
def find_top_k_indices_batched(dataset, text_embedding, processor, k=10, batch_size=4):
    scores_and_indices = []

    for start_idx in range(0, len(dataset), batch_size):

        end_idx = min(start_idx + batch_size, len(dataset))
        batch = dataset[start_idx:end_idx]        
        batch_embeddings = [torch.tensor(emb[0], dtype=torch.float32) for emb in batch["embeddings"]]
        scores = processor.score_retrieval(text_embedding.to("cpu").to(torch.float32), batch_embeddings)

        if hasattr(scores, "tolist"):
            scores = scores.tolist()[0]

        for i, score in enumerate(scores):
            scores_and_indices.append((score, start_idx + i))

    sorted_results = sorted(scores_and_indices, key=lambda x: -x[0])

    topk = sorted_results[:k]
    indices = [idx for _, idx in topk]
    scores = [score for score, _ in topk]

    return indices, scores
```

テキストの埋め込みを生成し、上記の関数に渡して、データセットのインデックスとスコアを返します。

```python
with torch.no_grad():
  text_embeds = model(**processor(text="a document about Mars expedition").to(model.device), return_tensors="pt").embeddings
indices, scores = find_top_k_indices_batched(ds_with_embeddings, text_embeds, processor, k=3, batch_size=4)
print(indices, scores)
```

```text
([440, 442, 443],
 [14.370786666870117,
  13.675487518310547,
  12.9899320602417])
```

Mars関連のドキュメントを確認するために、画像を表示します。

```python
for i in indices:
  display(dataset[i]["image"])
```

    <img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/doc_1.png"
         alt="Document 1"
         style="height: 200px; object-fit: contain; margin-right: 10px;">
    <img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/doc_2.png"
         alt="Document 2"
         style="height: 200px; object-fit: contain;">
    <img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/doc_3.png"
         alt="Document 3"
         style="height: 200px; object-fit: contain;">

