> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/workflows/ja/burokku/blocks/advanced-blocks/roboflow-visual-search.md).

# Roboflowビジュアル検索

入力画像に似ている画像をRoboflowプロジェクトから検索し、最も近い候補とメタデータを返します。

## このブロックの仕組み

このブロックは既存のRoboflowプロジェクト画像検索APIを使用します:

1. ワークフローから入力画像を受け取ります
2. 画像をRoboflowプロジェクト検索に送信します。対象は `image_base64`
3. 画像URL、タグ、ユーザーメタデータなどの有用なフィールドを要求します
4. 最良候補、最良候補の画像、メタデータ、タグ、および上位候補リストを返します

対象プロジェクトには、すでにアップロード済みの画像が含まれている必要があります。Roboflowは、プラットフォーム既存の画像インデックス作成パイプラインを使用して、それらの画像をビジュアル検索用にインデックス化します。このブロックは、画像の作成、メタデータの更新、インデックスの管理は行いません。

### 型識別子

ステップで次の識別子を使用してください `"type"` フィールド： `roboflow_core/visual_search@v1` ワークフローにこのブロックをステップとして追加するには。

### プロパティ

| **名前**     | **型** | **説明**                                     | 参照 |
| ---------- | ----- | ------------------------------------------ | -- |
| `name`     | `str` | このステップの一意の識別子を入力してください。                    | ❌  |
| `ワークスペース`  | `str` | 対象プロジェクトを所有するRoboflowワークスペースのURLスラッグ..     | ✅  |
| `対象プロジェクト` | `str` | 検索するRoboflowプロジェクトのURLスラッグ..               | ✅  |
| `top_k`    | `整数`  | 返す、視覚的に類似した画像候補の数。最も近い候補だけが必要な場合は1を使用します.. | ✅  |

この **参照** 列は、で利用可能な動的値を使ってプロパティをパラメータ化できる可能性を示します `ワークフロー` 実行時。参照 *バインディング* 詳細は。

### ランタイム互換性

`requires_internet` - エアギャップ／オフライン環境: このブロックは、完全にオフライン／エアギャップ環境から到達できないサービスに依存しています。

### 入力と出力のバインディング

利用可能な接続は、そのバインディング種別によって異なります。どのバインディング種別が `Roboflowビジュアル検索` のバージョン `v1` あるか確認してください。

<details>

<summary>入力と出力のバインディング</summary>

* 入力
  * `image` ([*`image`*](/workflows/ja/gaido/developer-guide/kinds/image.md)): ビジュアル検索クエリとして使用する画像..
  * `ワークスペース` ([*`string`*](/workflows/ja/gaido/developer-guide/kinds/string.md)): 対象プロジェクトを所有するRoboflowワークスペースのURLスラッグ..
  * `対象プロジェクト` ([*`roboflow_project`*](/workflows/ja/gaido/developer-guide/kinds/roboflow-project.md)): 検索するRoboflowプロジェクトのURLスラッグ..
  * `top_k` ([*`整数`*](/workflows/ja/gaido/developer-guide/kinds/integer.md)): 返す、視覚的に類似した画像候補の数。最も近い候補だけが必要な場合は1を使用します..
* 出力
  * `候補が見つかったか` ([`boolean`](/workflows/ja/gaido/developer-guide/kinds/boolean.md)) : ブールフラグ。
  * `最良候補` ([`辞書`](/workflows/ja/gaido/developer-guide/kinds/dictionary.md)）：辞書。
  * `候補` ([`list_of_values`](/workflows/ja/gaido/developer-guide/kinds/list-of-values.md))：任意の型の値のリスト。
  * `error_status` ([`boolean`](/workflows/ja/gaido/developer-guide/kinds/boolean.md)) : ブールフラグ。
  * `message` ([`string`](/workflows/ja/gaido/developer-guide/kinds/string.md)) : 文字列値。
  * `最良候補の画像` ([`image`](/workflows/ja/gaido/developer-guide/kinds/image.md)): ワークフロー内の画像。
  * `best_candidate_metadata` ([`辞書`](/workflows/ja/gaido/developer-guide/kinds/dictionary.md)）：辞書。
  * `best_candidate_tags` ([`list_of_values`](/workflows/ja/gaido/developer-guide/kinds/list-of-values.md))：任意の型の値のリスト。

</details>

<details>

<summary>JSON 定義の例</summary>

```json
{
	    "name": "<your_step_name_here>",
	    "type": "roboflow_core/visual_search@v1",
	    "image": "$inputs.image",
	    "workspace": "my-workspace",
	    "target_project": "reference-images",
	    "top_k": 1
	}
```

</details>