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

Use Case 内の Vision Events 全体で使用されているカスタムメタデータのフィールドと型を取得します。

概要

このエンドポイントは、以下全体で使用されているカスタムメタデータフィールドを返します Vision Events 特定の ユースケース。カスタムメタデータは固定スキーマではなくイベントごとに定義されるため、これを使って、作成する前にどのフィールドが存在し、その型が何であるかを確認してください イベントクエリ またはダッシュボードフィルター。

HTTP API

特定のユースケースにおいてイベントで使用されたカスタムメタデータフィールドのスキーマを取得します。これは、フィルタリングに利用できるメタデータフィールドを見つけるのに役立ちます クエリリクエスト.

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

Get Custom Metadata Schema

get

Retrieve the schema of custom metadata fields for a given use case.

認可

bearerAuth

Authorizationstring必須

Roboflow API key passed as a Bearer token.

パスパラメータ

useCaseIdstring必須

The use case ID.

レスポンス

200

Metadata schema.

application/json

solutionstringオプション

403

Insufficient permissions for this resource.

application/json

get/vision-events/custom-metadata-schema/{useCaseId}

HTTPcURLJavaScriptPython

GET /vision-events/custom-metadata-schema/{useCaseId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "solution": "text",
  "fields": {
    "ANY_ADDITIONAL_PROPERTY": {
      "types": [
        "string"
      ]
    }
  }
}

パスパラメータ

• :useCaseId (文字列、必須): ユースケースID。

リクエスト例

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

レスポンス例

200

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

以下の各フィールド フィールド オブジェクトには次が含まれます:

• 型 (文字列の配列): このフィールドで観測されたデータ型。各要素は次のいずれかです 文字列, 数値、または boolean。異なるイベントで同じキーに異なる型が使用されていた場合、1つのフィールドに複数の型が含まれることがあります。

403

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

Python SDK

特定のユースケースにおいてイベントで使用されたカスタムメタデータフィールドを見つけます。これは、クエリを作成する際に役立ちます customMetadataFilters.

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']}")

レスポンスには〜が含まれます フィールド 見つかった各フィールド名をその観測された型に対応付ける辞書（例: ["string"], ["number"]）。この情報を使って、イベントをクエリする際に型付きフィルターを構築できます イベントをクエリする際:

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

詳細は次を参照してください REST APIリファレンス.