For the complete documentation index, see llms.txt. This page is also available as Markdown.

Roboflow Vision Events

視覚イベントをRoboflow Vision Events APIに送信します。

画像、モデル予測、イベントのメタデータを Roboflow Vision Events API に送信して、監視、品質管理、安全アラート、カスタムイベントの追跡に利用します。

このブロックの仕組み

このブロックはワークフローの画像とモデル予測を Roboflow Vision Events API にアップロードし、Roboflow ダッシュボードで検索、フィルタリング、可視化できる構造化イベントを作成します。

  1. 必要に応じて、入力画像および/または出力画像(可視化)を公開 API 経由で Vision Events の画像ストレージにアップロードします

  2. モデル予測(物体検出、分類、インスタンスセグメンテーション、またはキーポイント検出)を Vision Events のアノテーション形式に変換し、入力画像に付加します

  3. 指定されたイベントタイプ、ユースケース、イベントデータ、カスタムメタデータを持つビジョンイベントを作成します

  4. 組み込みのレート制限(cooldown_seconds、デフォルトは1秒)により、高頻度のビデオワークフローがフレームごとにイベントを送ってAPIをあふれさせないようにします

  5. 非ブロッキング実行のための fire-and-forget モードをサポートします

レート制限

ビデオワークフローは1秒間に何度も実行される可能性があり、デフォルトでは各フレームごとにイベント(およびその画像)が送信されます。これを防ぐため、このブロックは連続するイベント間にクールダウンを強制し、デフォルトでは1秒あたり最大1イベントを送信します。クールダウン期間中にトリガーされたイベントは破棄され、 throttling_status 出力は次のように設定されます True.

調整 cooldown_seconds ニーズに合わせて、または次に設定して 0 レート制限を完全に無効にします(たとえば、意図的にバーストするユースケース向け)。クールダウンタイマーはブロックインスタンス内にあるため、永続的な WebRTC セッションのような長時間実行にもスロットリングが適用されます。HTTP で提供されるワークフロー(例: /workflows/run)では、リクエストごとに新しいブロックインスタンスが作成されるため、クールダウンは別々の HTTP 呼び出しをまたいでスロットリングしません。

デプロイモード

デフォルトでは、このブロックは次へイベントを送信します: Roboflow Vision Events API (クラウド/Serverless API)。画像をアップロードし、公開 API 経由でイベントを送信します。

エッジデプロイの場合は、次を有効にします: ローカルイベントストアに書き込む 代わりにローカルの Event Ingestion Service にイベントを送信します。このモードでは、画像はリクエスト内に直接埋め込まれ(アップロード手順はありません)、イベントは次へ送信されます: <event store URL>/v2/events。イベントストア URL のデフォルトは http://localhost:8001 で、上書きできます。このモードでは Roboflow API キーは不要です。ローカルサービスで認証が必要な場合は、次を設定してください: EVENT_INGESTION_API_KEY 推論サーバー上の環境変数。

イベントタイプ

  • quality_check:製造/検査の QA で、合否結果と任意の信頼度を含みます

  • inventory_count:位置、アイテム数、アイテムタイプを含む在庫追跡

  • safety_alert:アラートタイプ、重大度(低/中/高)、説明を含む安全違反

  • custom:自由形式の値文字列を持つユーザー定義イベント

  • operator_feedback:過去のイベントに対するオペレーターのレビュー/修正(正しい/誤り/判断不能)

要件

デフォルトの(クラウド)モードでは、次の権限を持つ有効な Roboflow API キーが必要です: vision-events:write スコープで、環境またはワークフロー設定に構成されている必要があります。次の場合は Roboflow API キーは不要です: ローカルイベントストアに書き込む が有効な場合(上記のデプロイモードを参照)。

一般的な使用例

  • 品質管理:画像と検出オーバーレイ付きで検査結果を自動記録します

  • 安全監視:ビデオストリームで違反が検出されたときに安全アラートを送信します

  • 生産分析:視覚的証拠とともに在庫数と生産指標を追跡します

  • アクティブ監視:リアルタイム動画処理ワークフローからの fire-and-forget イベントログ記録

型識別子

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

プロパティ

名前

説明

参照

name

str

このステップの一意の識別子を入力してください。

event_type

str

作成するビジョンイベントの種類です。

solution

str

イベントに関連付けるユースケースです。イベントはワークスペース内でユースケースごとに名前空間化されます。

external_id

str

他システムとの照合に使用する外部識別子(最大1000文字)です。

qc_result

str

品質チェック結果:合格または不合格です。

location

str

在庫数の位置識別子です。

item_count

整数

数えられたアイテムの数です。

item_type

str

数えられているアイテムの種類です。

alert_type

str

アラート種別識別子(例:no_hardhat、spill_detected)です。

severity

str

安全アラートの重大度レベルです。

alert_description

str

安全アラートの説明です。

custom_value

str

カスタムイベント用の任意の値です。

related_event_id

str

レビュー対象イベントのイベント ID です。

feedback

str

関連イベントに対するオペレーターのフィードバックです。

custom_metadata

Dict[str, Union[bool, float, int, str]]

イベントに付加するフラットなキー・バリューのメタデータです。キーはパターン [a-zA-Z0-9_ -]+ に一致する必要があります(最大100文字)。文字列値は最大1000文字です。

fire_and_forget

bool

True の場合、イベントは非同期で送信され、ワークフローは待機せずに続行します。False の場合、ブロックは API 応答を待ちます。

disable_sink

bool

True の場合、ブロックは無効化され、イベントは送信されません。

cooldown_seconds

Union[float, int]

このブロックによって送信される連続イベント間の最小秒数です。クールダウン期間中にトリガーされたイベントは破棄され、 throttling_status 出力は True に設定されます。デフォルトは1秒(最大で1秒あたり1イベント)で、高頻度のビデオワークフローがフレームごとにイベントを送って Vision Events API をあふれさせないようにします。意図的にバーストするユースケースでは、0 に設定してレート制限を無効にできます。

write_to_event_store

bool

True の場合、Roboflow Vision Events API(クラウド)の代わりに、ローカルの Event Ingestion Service(エッジデプロイ)にイベントを送信します。画像はリクエストに埋め込まれ、イベントは次へ送信されます: <Event Store URL>/v2/eventsこのモードでは Roboflow API キーは不要です。

event_store_url

str

ローカル Event Ingestion Service のベース URL です。次の場合のみ使用されます: ローカルイベントストアに書き込む が有効な場合。

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

ランタイム互換性

soft - ランタイム hosted_serverless, dedicated_deployment;実行 リモート : クールダウン/レート制限タイマーはプロセスメモリに保存されます。ステートレスまたは複数レプリカのHTTPランタイムでリモートステップ実行を行う場合、各リクエストごとに新しいワーカーが割り当てられるため、クールダウンはスロットリングしません。クールダウンが文書どおりに機能するのは、永続的なWebRTCセッションでのローカルステップ実行のみです。

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

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

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

    • input_image (image):元の入力画像です。Vision Events API にアップロードされ、検出アノテーションのベース画像として使用されます。

    • output_image (image):任意の出力/可視化画像(例:可視化ブロックからの画像)です。Vision Events ダッシュボードで主画像として表示されます。

    • predictions (Union[object_detection_prediction, classification_prediction, instance_segmentation_prediction, keypoint_detection_prediction]):入力画像に検出アノテーションとして含める任意のモデル予測です。物体検出、インスタンスセグメンテーション、キーポイント検出、分類予測をサポートします。

    • event_type (string):作成するビジョンイベントの種類です。

    • solution (Union[roboflow_solution, string]):イベントに関連付けるユースケースです。イベントはワークスペース内でユースケースごとに名前空間化されます。

    • external_id (string):他システムとの照合に使用する外部識別子(最大1000文字)です。

    • qc_result (string):品質チェック結果:合格または不合格です。

    • location (string):在庫数の位置識別子です。

    • item_count (整数):数えられたアイテムの数です。

    • item_type (string):数えられているアイテムの種類です。

    • alert_type (string):アラート種別識別子(例:no_hardhat、spill_detected)です。

    • severity (string):安全アラートの重大度レベルです。

    • alert_description (string):安全アラートの説明です。

    • custom_value (string):カスタムイベント用の任意の値です。

    • related_event_id (string):レビュー対象イベントのイベント ID です。

    • feedback (string):関連イベントに対するオペレーターのフィードバックです。

    • custom_metadata (*):イベントに付加するフラットなキー・バリューのメタデータです。キーはパターン [a-zA-Z0-9_ -]+ に一致する必要があります(最大100文字)。文字列値は最大1000文字です。

    • fire_and_forget (boolean):True の場合、イベントは非同期で送信され、ワークフローは待機せずに続行します。False の場合、ブロックは API 応答を待ちます。

    • disable_sink (boolean):True の場合、ブロックは無効化され、イベントは送信されません。

    • cooldown_seconds (Union[float, 整数]):このブロックによって送信される連続イベント間の最小秒数です。クールダウン期間中にトリガーされたイベントは破棄され、 throttling_status 出力は True に設定されます。デフォルトは1秒(最大で1秒あたり1イベント)で、高頻度のビデオワークフローがフレームごとにイベントを送って Vision Events API をあふれさせないようにします。意図的にバーストするユースケースでは、0 に設定してレート制限を無効にできます。

    • write_to_event_store (boolean):True の場合、Roboflow Vision Events API(クラウド)の代わりに、ローカルの Event Ingestion Service(エッジデプロイ)にイベントを送信します。画像はリクエストに埋め込まれ、イベントは次へ送信されます: <Event Store URL>/v2/eventsこのモードでは Roboflow API キーは不要です。

    • event_store_url (string):ローカル Event Ingestion Service のベース URL です。次の場合のみ使用されます: ローカルイベントストアに書き込む が有効な場合。

  • 出力

    • error_status (boolean) : ブールフラグ。

    • throttling_status (boolean) : ブールフラグ。

    • event_id (string) : 文字列値。

    • message (string) : 文字列値。

JSON 定義の例

最終更新

役に立ちましたか?