# Image Metadata

Metadata を使うと、Roboflow ワークスペース内の画像にカスタムのキー・値ペアを付与できます。Metadata は、撮影条件、デバイス識別子、品質スコア、その他のドメイン固有の属性など、構造化された情報を画像と一緒に保存するために使用し、その属性を基準にデータを検索、フィルタリング、整理できます。

## 概要

各画像には、任意の数の metadata エントリを保持できます。エントリは **キー** （のような名前 `camera_id`）と **値** （文字列、数値、または boolean）を組み合わせたものです。

| 値の型     | 例                                           |
| ------- | ------------------------------------------- |
| 文字列     | `location: "warehouse-3"`, `shift: "night"` |
| 数値      | `temperature: 72.5`, `quality_score: 95`    |
| Boolean | `reviewed: true`, `is_night: false`         |

### ユースケース

* **撮影コンテキストの記録** — カメラ ID、GPS 座標、天候、照明条件を記録する
* **品質追跡** — 信頼度スコア、レビュー状態、アノテーター ID を付与する
* **データのスライシング** — 任意の属性でデータセットをフィルタリングし、対象を絞ったトレーニングセットを作成する
* **外部システム連携** — 画像を社内ツールに戻すための識別子を保存する

## Metadata の追加

Web UI、Python SDK、REST API、または S3 Bucket Mirror を介して自動的に、画像に metadata を追加できます。

### Web Application

{% stepper %}
{% step %}

#### 画像を開く

プロジェクト内の任意の画像を開きます。
{% endstep %}

{% step %}

#### キーと値を入力

metadata セクションで、 **キー** を最初の入力欄に、 **値** を 2 つ目の入力欄に入力します。
{% endstep %}

{% step %}

#### 追加

押す **Enter** で保存するか、Add をクリックします
{% endstep %}
{% endstepper %}

値は型に応じて自動的に解析されます：

| 入力された値           | 保存形式                       |
| ---------------- | -------------------------- |
| `front`          | `"front"` （文字列）            |
| `95`             | `95` （数値）                  |
| `3.14`           | `3.14` （数値）                |
| `true` / `false` | `true` / `false` （boolean） |

<figure><img src="https://3740591140-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M6S9nPJhEX9FYH6clfW%2Fuploads%2Fh7L2L0c22TIzCxjxuiU1%2Fimage.png?alt=media&#x26;token=3f3eba92-e194-43b4-bd98-801a038836ff" alt=""><figcaption><p>Annotation Tool の metadata エディタ</p></figcaption></figure>

### Python SDK

を渡します `metadata` 画像をアップロードする際に dictionary を：

```python
import roboflow

rf = roboflow.Roboflow(api_key="YOUR_API_KEY")
project = rf.workspace("your-workspace").project("your-project")

project.upload(
    image_path="image.jpg",
    metadata={
        "camera_id": "cam001",
        "location": "warehouse-3",
        "temperature": 72.5,
        "is_night": False
    }
)
```

### REST API

#### アップロード時に metadata を追加

を含めます `metadata` 画像をアップロードする際、multipart form data に field（JSON 文字列化済み）を含めます：

```bash
curl -X POST "https://api.roboflow.com/dataset/your-dataset/upload?api_key=YOUR_API_KEY" \
  -F "name=image.jpg" \
  -F "split=train" \
  -F "file=@image.jpg" \
  -F 'metadata={"camera_id":"cam001","temperature":72.5}'
```

### S3 Bucket Mirror

を使用する場合 [Bucket Mirror](https://docs.roboflow.com/roboflow/roboflow-jp/datasets/adding-data/upload-data-from-aws-gcp-and-azure/aws-s3-bucket) S3 バケットから画像を同期するには、同じベース名の `.json` ファイルを各画像の横に配置して metadata を付与できます：

```
my-bucket/
  images/
    photo_001.jpg
    photo_001.json      # photo_001.jpg の metadata
    photo_002.jpg
    photo_002.json      # photo_002.jpg の metadata
```

JSON ファイルには、key-value pair として metadata が含まれます：

```json
{
    "camera_id": "cam001",
    "location": "warehouse-3",
    "capture": { "temperature": 72.5, "humidity": 45 }
}
```

**ネストされたオブジェクトは自動的にフラット化されます** ドット表記を使って。上の例は次の内容になります：

| キー                    | 値               |
| --------------------- | --------------- |
| `camera_id`           | `"cam001"`      |
| `location`            | `"warehouse-3"` |
| `capture.temperature` | `72.5`          |
| `capture.humidity`    | `45`            |

#### Metadata ファイルの制約

* 最大ファイルサイズ： **256 KB**
* 有効な JSON である必要があります
* `null` および `undefined` の値は除外されます

#### 更新戦略

Bucket Mirror は、同期された metadata が UI や API で手動設定した metadata とどのように連携するかについて、さまざまな戦略をサポートします：

| 戦略                            | 動作                                                   |
| ----------------------------- | ---------------------------------------------------- |
| **`mergeBucketWins`** （デフォルト） | 両方のソースをマージします。キーが競合した場合は、bucket の値が優先されます。           |
| **`mergeUserWins`**           | 両方のソースをマージします。キーが競合した場合は、ユーザー設定の値が優先されます。            |
| **`overwrite`**               | Bucket の metadata が既存のすべての metadata を完全に置き換えます。      |
| **`untilFirstChange`**        | ユーザーが metadata を手動で編集するまで bucket から同期し、その後は更新を停止します。 |
| **`append`**                  | Bucket から新しいキーのみを追加します。既存のキーは上書きしません。                |

## Metadata で検索する

Metadata はインデックス化されており、 [Asset Library](https://docs.roboflow.com/roboflow/roboflow-jp/workspaces/asset-library)で検索可能です。検索バーを使って metadata の値で画像をフィルタリングできます：

```
metadata.camera_id:"cam001"
metadata.quality_score>80
metadata.reviewed:true
```

metadata フィルターは他の検索フィルターと組み合わせられます：

```
metadata.location:"warehouse-3" AND class:forklift
```

Asset Library では、ワークスペース内に存在する内容に基づいて metadata のキーと値のオートコンプリートも提供されます。

## キー命名規則

metadata のキーは次の規則に従う必要があります：

| 規則      | 詳細                                               |
| ------- | ------------------------------------------------ |
| 使用可能な文字 | 英字（`a-z`, `A-Z`）、数字（`0-9`）、アンダースコア（`_`）、ドット（`.`) |
| 先頭文字    | 英字、数字、またはアンダースコアでなければなりません                       |
| 禁止文字    | スラッシュ（`/`）は使用できません                               |

有効なキー： `camera_id`, `capture.temperature`, `_internal_ref`, `v2_score`

無効なキー： `camera/id` （を含む） `/`), `.starts_with_dot` （で始まる） `.`), `has spaces` （スペースを含む）

## Metadata と Tags

metadata と [tags](https://docs.roboflow.com/roboflow/roboflow-jp/datasets/manage-datasets/add-tags-to-images) はどちらも画像の整理に役立ちますが、用途は異なります：

|           | Tags                                 | Metadata                                   |
| --------- | ------------------------------------ | ------------------------------------------ |
| **構造**    | シンプルなラベル                             | キー・値ペア                                     |
| **値**     | 値はなく、名前のみ                            | 文字列、数値、または boolean                         |
| **最適な用途** | 分類、ワークフローの状態                         | 構造化された属性、計測値                               |
| **例**     | `reviewed`, `v2`, `needs-annotation` | `temperature: 72.5`, `camera_id: "cam001"` |

同じ画像に両方を使えます。たとえば、画像に `reviewed` というタグを付け、さらに `reviewer: "alice"` および `confidence: 0.95` を metadata として保存します。