> 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/deployment/ja/to/vision-events/get-custom-metadata-schema.md).

# カスタムメタデータスキーマを取得

## 概要

このエンドポイントは、 [Vision Events](/deployment/ja/to/vision-events.md) の特定の [ユースケース](/deployment/ja/to/vision-events/use-cases.md)全体で使用されたカスタムメタデータフィールドを返します。カスタムメタデータは固定スキーマではなくイベントごとに定義されるため、イベントクエリ [イベントクエリ](/deployment/ja/to/vision-events/query-events.md) またはダッシュボードフィルターを作成する前に、どのフィールドが存在し、その型が何かを把握するためにこれを使用してください。

## HTTP API

特定のユースケースでイベントに使用されたカスタムメタデータフィールドのスキーマを取得します。これは、クエリリクエスト [クエリリクエスト](/deployment/ja/to/vision-events/query-events.md#http-api).

**必要なスコープ:** `vision-events:read` または `device:read`

{% openapi src="/files/934e54fa9aa57656316a422a76238b867f081de5" path="/vision-events/custom-metadata-schema/{useCaseId}" method="get" %}
[openapi.yaml](https://970637113-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoksNmwps1HmYr8TqHDnX%2Fuploads%2Fgit-blob-2afefc06c784ca78eb7ec96a99bee48f8a2daaa5%2Fopenapi.yaml?alt=media)
{% endopenapi %}

### パスパラメータ

* **`:useCaseId`** (string, 必須): ユースケースID。

### リクエスト例

```bash
curl "https://api.roboflow.com/vision-events/custom-metadata-schema/a1b3c8e1" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### レスポンス例

{% tabs %}
{% tab title="200" %}

```json
{
  "fields": {
    "production_line": {
      "types": ["string"]
    },
    "temperature": {
      "types": ["number"]
    },
    "is_overtime": {
      "types": ["boolean"]
    }
  }
}
```

fields `オブジェクト内の各フィールドには次が含まれます:` types

* **`types`** （文字列の配列）: このフィールドで観測されたデータ型。各要素は次のいずれかです: `string`, `number`、または `boolean`。異なるイベントで同じキーに異なる型が使われていた場合、1つのフィールドに複数の型が含まれることがあります。
  {% endtab %}

{% tab title="403" %}

```json
{
  "error": "このリソースに対する権限が不十分です。"
}
```

{% endtab %}
{% endtabs %}

## Python SDK

特定のユースケースでイベントに使用されたカスタムメタデータフィールドを見つけます。これは、 `customMetadataFilters`.

```python
import roboflow

roboflow.login()

rf = roboflow.Roboflow()
ws = rf.workspace()

schema = ws.get_vision_event_metadata_schema("a1b3c8e1")

for field, info in schema["fields"].items():
    print(f"{field}: {info['types']}")
```

レスポンスには `オブジェクト内の各フィールドには次が含まれます:` 発見された各フィールド名をその観測された型に対応付ける dict が含まれます（例: `["string"]`, `["number"]`）。この情報を使って、 [イベントをクエリする](/deployment/ja/to/vision-events/query-events.md#python-sdk):

```python
page = ws.query_vision_events(
    "a1b3c8e1",
    customMetadataFilters=[
        {"field": "temperature", "operator": "gt", "value": 70, "type": "number"}
    ],
)
```

詳しくは次を参照してください: [REST API リファレンス](#http-api).

## MCPサーバー

AIエージェントを [MCPサーバー](https://docs.roboflow.com/agents/mcp-server) に接続すると、次のツールでカスタムメタデータスキーマを読み取れます:

<table data-search="false"><thead><tr><th width="290">ツール</th><th>説明</th></tr></thead><tbody><tr><td><code>vision_events_custom_metadata_schema_get</code></td><td>ユースケースで検出されたカスタムメタデータスキーマを取得します。</td></tr></tbody></table>
